Collapse all Symbian^3 Application Developer Library

CPosIntGpsHwStatus Class Reference

class CPosIntGpsHwStatus

The CPosIntGpsHwStatus class is used for updating and checking the current status of integrated GPS HW.

Users who wish to update the HW status and do not wish to receive callbacks should instantiate the interface with the NewL or NewLC methods. Doing so will require WriteDeviceData. Updating HW status is usually performed by the HW integration layer.

Users who wish to be notified of changes to the HW status should use the overloaded NewL or NewLC functions that take MPosIntGpsHwStatusObserver as an argument. Doing so will not require any capabilities. Checking HW status is usually performed by the UI, and applications.

Multiple applications may be notified of HW status updates but only one should change the HW status.

MPosIntGpsHwStatusObserver

Public Member Functions
	~CPosIntGpsHwStatus ()
IMPORT_C void	GetStatusL ( TIntGpsHwStatus &)
IMPORT_C CPosIntGpsHwStatus *	NewL ()
IMPORT_C CPosIntGpsHwStatus *	NewL ( MPosIntGpsHwStatusObserver &)
IMPORT_C CPosIntGpsHwStatus *	NewLC ()
IMPORT_C CPosIntGpsHwStatus *	NewLC ( MPosIntGpsHwStatusObserver &)
IMPORT_C void	SetStatusL ( TIntGpsHwStatus )

Private Member Functions
	CPosIntGpsHwStatus ()
	CPosIntGpsHwStatus (const CPosIntGpsHwStatus &)
void	ConstructL ()
void	ConstructL ( MPosIntGpsHwStatusObserver &)
CPosIntGpsHwStatus &	operator= (const CPosIntGpsHwStatus &)

Public Member Enumerations
enum	TIntGpsHwStatus { EStatusUnknown = 0, EStatusOff , EStatusOn , EStatusActive }

Private Attributes
CPosIntGpsHwStatusImpl *	iImpl

Constructor & Destructor Documentation

CPosIntGpsHwStatus()

CPosIntGpsHwStatus

(

)

[private]

CPosIntGpsHwStatus(const CPosIntGpsHwStatus &)

CPosIntGpsHwStatus

(

const CPosIntGpsHwStatus &

)

[private]

Parameters

const CPosIntGpsHwStatus &

~CPosIntGpsHwStatus()

~CPosIntGpsHwStatus

(

)

[virtual]

Destructor

Member Functions Documentation

ConstructL()

void

ConstructL

(

)

[private]

ConstructL(MPosIntGpsHwStatusObserver &)

void

ConstructL

(

MPosIntGpsHwStatusObserver &

aObserver

)

[private]

Parameters

MPosIntGpsHwStatusObserver & aObserver

GetStatusL(TIntGpsHwStatus &)

IMPORT_C void

GetStatusL

(

TIntGpsHwStatus &

aStatus

)

Get the current status of Integrated GPS HW.

leave: KErrPermissionDenied, if the caller process doesn't pass the Read Policy. KErrNotFound, if the property has not been defined. Or any other error code.

Parameters

TIntGpsHwStatus & aStatus

[Out] return value

NewL()

IMPORT_C CPosIntGpsHwStatus *

NewL

(

)

[static]

Static constructor. This function is usually used by the Hardware Integration Layer.

capability: WriteDeviceData

NewL(MPosIntGpsHwStatusObserver &)

IMPORT_C CPosIntGpsHwStatus *

NewL

(

MPosIntGpsHwStatusObserver &

aObserver

)

[static]

Static constructor. This function is usually used by the UI and applications. It Subscribes to callbacks which fire when the status of Integrated GPS HW changes This is the overload for NewL()

Parameters

MPosIntGpsHwStatusObserver & aObserver

[In] The observer to be used for callbacks

NewLC()

IMPORT_C CPosIntGpsHwStatus *

NewLC

(

)

[static]

Static constructor, leaves class on the cleanup stack. This function is usually used by the Hardware Integration Layer. This is the overload for NewL()

capability: WriteDeviceData

NewLC(MPosIntGpsHwStatusObserver &)

IMPORT_C CPosIntGpsHwStatus *

NewLC

(

MPosIntGpsHwStatusObserver &

aObserver

)

[static]

Static constructor, leaves class on the cleanup stack. This function is usually used by the UI and applications. It subscribes to callbacks which fire when the status of Integrated GPS HW changes This is the overload for NewLC()

Parameters

MPosIntGpsHwStatusObserver & aObserver

[In] The observer to be used for callbacks

SetStatusL(TIntGpsHwStatus)

IMPORT_C void

SetStatusL

(

TIntGpsHwStatus

aStatus

)

Updates information about current status of Integrated GPS HW.

capability: WriteDeviceData

leave: KErrArgument, aStatus is not one of the values defined in TTechnologyStatus

Parameters

TIntGpsHwStatus aStatus

[In] Sets new status for Integrated GPS HW

operator=(const CPosIntGpsHwStatus &)

CPosIntGpsHwStatus &

operator=

(

const CPosIntGpsHwStatus &

)

[private]

Parameters

const CPosIntGpsHwStatus &

Member Enumerations Documentation

Enum TIntGpsHwStatus

Integrated GPS HW states

Enumerators

EStatusUnknown = 0	GPS HW state is unknown.
EStatusOff	GPS HW is off.
EStatusOn	GPS HW is powered.
EStatusActive	GPS HW is used and is receiving location fixes.

Member Data Documentation

CPosIntGpsHwStatusImpl * iImpl

CPosIntGpsHwStatusImpl *

iImpl

[private]