Symbian
Symbian OS Library

SYMBIAN OS V9.3

[Index] [Spacer] [Previous] [Next]



Location: LbsCommon.h
Link against: lbsselflocate.lib

Class TPositionModuleStatus

class TPositionModuleStatus : public TPositionModuleStatusBase;

Description

The normal class for storing a position module's status

Derivation

Members

Defined in TPositionModuleStatus:
DataQualityStatus(), DeviceStatus(), EDataQualityLoss, EDataQualityNormal, EDataQualityPartial, EDataQualityUnknown, EDeviceActive, EDeviceDisabled, EDeviceError, EDeviceInactive, EDeviceInitialising, EDeviceReady, EDeviceStandBy, EDeviceUnknown, SetDataQualityStatus(), SetDeviceStatus(), TDataQualityStatus, TDeviceStatus, TPositionModuleStatus(), _TDataQualityStatus, _TDeviceStatus, iDataQualityStatus, iDeviceStatus

Inherited from TPositionClassTypeBase:
PositionClassSize(), PositionClassType(), iPosClassSize, iPosClassType


Construction and destruction


TPositionModuleStatus()

IMPORT_C TPositionModuleStatus();

Description

Default constructor for TPositionModuleStatus

[Top]


Member functions


DeviceStatus()

IMPORT_C TDeviceStatus DeviceStatus() const;

Description

Device status

Return value

TDeviceStatus

The module's device status


DataQualityStatus()

IMPORT_C TDataQualityStatus DataQualityStatus() const;

Description

Data quality status

Return value

TDataQualityStatus

The data quality status


SetDeviceStatus()

IMPORT_C void SetDeviceStatus(TDeviceStatus aStatus);

Description

Sets device status

Parameters

TDeviceStatus aStatus

The device status to set


SetDataQualityStatus()

IMPORT_C void SetDataQualityStatus(TDataQualityStatus aStatus);

Description

Sets data quality status

Parameters

TDataQualityStatus aStatus

The data quality status to set

[Top]


Member enumerations


Enum _TDeviceStatus

_TDeviceStatus

Description

The device status

EDeviceUnknown

Device unknown This is not a valid state and should never be reported

EDeviceError

Device error There are problems using the device. For example, there may be hardware errors. It should not be confused with complete loss of data quality which indicates that the device is functioning correctly but is currently unable to obtain position information. The error state will be reported if the device can not be successfully brought on line. For example, the positioning module may have been unable to communicate with the device or it is not responding as expected.

EDeviceDisabled

Device disabled Although the device may be working properly, it has been taken off line and is regarded as being unavailable to obtain position information. This will generally have been done by the user via the control panel. In this state, positioning framework will not use the device.

EDeviceInactive

Device inactive The device is not being used by the positioning framework. This is typically because there are no clients currently obtaining the position from it. This is the normal status that is returned for a module that is not currently loaded by the system

EDeviceInitialising

Device initialising This is a transient state. The device is being brought out of the "inactive" state but has not reached either the "ready" or "stand by" modes. The initialising state will occur when the positioning module is first selected to provide a client application with location information

EDeviceStandBy

Device standby This state indicates the device has entered "sleep" or "power save" mode. This signifies that the device is online, but is not actively retrieving position information. A device will generally enter this mode when the next position update is not required for some time and it is more efficient to partially power down. Note: Not all positioning modules will support this state - particularly when there is external hardware

EDeviceReady

Device ready The positioning device is online and is ready to retrieve position information

EDeviceActive

Device active The positioning device is actively in the process of retrieving position information. Note: Not all positioning modules will support this state - particularly when there is external hardware


Enum _TDataQualityStatus

_TDataQualityStatus

Description

The data quality status

EDataQualityUnknown

Data Quality Unknown This is the unassigned valued. This state should only be reported during an event indicating that a positioning module has been removed

EDataQualityLoss

Data Quality Loss The accuracy and contents of the position information has been completely compromised. It is no longer possible to return any coherent data. This situation will occur if the device has lost track of all the transmitters (for example, satellites or base stations). It should be noted although it is currently not possible to obtain position information, the device may still be functioning correctly. This state should not be confused with a device error.

EDataQualityPartial

Data Quality Partial There has been a partial degradation in the available position information. In particular, it is not possible to provide the required (or expected) quality of information. This situation could occur if the device has lost track of one of the transmitters (for example, satellites or base stations)

EDataQualityNormal

Data Quality Normal The positioning device is functioning as expected

[Top]


Member type definitions


Typedef TDeviceStatus

typedef TInt TPositionModuleStatus::TDeviceStatus;

Description

defined type for TDeviceStatus


Typedef TDataQualityStatus

typedef TInt TPositionModuleStatus::TDataQualityStatus;

Description

defined type for TDataQualityStatus

[Top]


Member data


iDeviceStatus

protected: TDeviceStatus iDeviceStatus;

Description

The device status


iDataQualityStatus

protected: TDataQualityStatus iDataQualityStatus;

Description

The data quality status