S60 3rd Edition API Reference: TPositionModuleStatus Class Reference

TPositionModuleStatus Class Reference

API published in: S60 2nd Ed FP 2

Link against: lbs.lib

Capability Information

Required Capabilities

Location

#include <lbscommon.h>

Inherits TPositionModuleStatusBase.

Detailed Description

The normal class for storing a position module's status.

Public Types

typedef TInt TDeviceStatus
 Defines the status of the positioning device.
typedef TInt TDataQualityStatus
 Defines the quality of the data returned by the positioning device.
enum  _TDeviceStatus {
  EDeviceUnknown, EDeviceError, EDeviceDisabled, EDeviceInactive,
  EDeviceInitialising, EDeviceStandBy, EDeviceReady, EDeviceActive
}
 The device status. More...
enum  _TDataQualityStatus { EDataQualityUnknown, EDataQualityLoss, EDataQualityPartial, EDataQualityNormal }
 The data quality status. More...

Public Member Functions

IMPORT_C TPositionModuleStatus ()
 Default constructor for TPositionModuleStatus.
IMPORT_C TDeviceStatus DeviceStatus () const
 Get the current condition of the device used by the positioning module.
IMPORT_C TDataQualityStatus DataQualityStatus () const
 Get the quality of the position information determined by the positioning module.
IMPORT_C void SetDeviceStatus (TDeviceStatus aStatus)
 This method is not intended for the client's usage.
IMPORT_C void SetDataQualityStatus (TDataQualityStatus aStatus)
 This method is not intended for the client's usage.

Protected Attributes

TDeviceStatus iDeviceStatus
 The device status.
TDataQualityStatus iDataQualityStatus
 The data quality status.

Member Typedef Documentation

typedef TInt TPositionModuleStatus::TDataQualityStatus
 

Defines the quality of the data returned by the positioning device.

The values are defined by the enumerator _TDataQualityStatus.

typedef TInt TPositionModuleStatus::TDeviceStatus
 

Defines the status of the positioning device.

The values are defined by the enumerator _TDeviceStatus.

Member Enumeration Documentation

enum TPositionModuleStatus::_TDataQualityStatus
 

The data quality status.

Enumerator:
EDataQualityUnknown  This is an unassigned valued.

This state should only be reported during an event indicating that a positioning module has been removed

EDataQualityLoss  This state indicates that the accuracy and contents of the position information has been completely compromised.

It is no longer possible to return any coherent data. This situation occurs if the device has lost track of all the transmitters (for example, satellites or base stations). It should be noted that although it is currently not possible to obtain position information, the device may still be functioning correctly.

EDataQualityPartial  This value indicates that 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

EDataQualityNormal  The positioning device is functioning as expected.
enum TPositionModuleStatus::_TDeviceStatus
 

The device status.

Enumerator:
EDeviceUnknown  This is not a valid state and must never be reported.
EDeviceError  to indicate that there are problems when using the device
EDeviceDisabled  Although the device may be working properly, it has been taken offline and is regarded as being unavailable to obtain position information.
EDeviceInactive  indicates that the device is currently not being used by Location Framework
EDeviceInitialising  This is a transient state.

The device is being brought out of the Inactive state but has not reached either the Ready or Standby modes. The initializing state occurs when the positioning module is first selected to provide a client application with location information

EDeviceStandBy  This state indicates that the device has entered the Sleep or Power save mode.

This signifies that the device is online, but it is not actively retrieving position information. A device generally enters this mode when the next position update is not required for some time and it is more efficient to partially power down

EDeviceReady  The positioning device is online and is ready to retrieve position information.
EDeviceActive  The positioning device is actively in the process of retrieving position information.

Constructor & Destructor Documentation

IMPORT_C TPositionModuleStatus::TPositionModuleStatus (   ) 
 

Default constructor for TPositionModuleStatus.

Member Function Documentation

IMPORT_C TDataQualityStatus TPositionModuleStatus::DataQualityStatus (   )  const
 

Get the quality of the position information determined by the positioning module.

Returns:
The data quality status
IMPORT_C TDeviceStatus TPositionModuleStatus::DeviceStatus (   )  const
 

Get the current condition of the device used by the positioning module.

Returns:
The module's device status
IMPORT_C void TPositionModuleStatus::SetDataQualityStatus ( TDataQualityStatus  aStatus  ) 
 

This method is not intended for the client's usage.

The positioning module uses this method to sets the quality of the position information determined by the positioning module.

Parameters:
aStatus The data quality status to set
IMPORT_C void TPositionModuleStatus::SetDeviceStatus ( TDeviceStatus  aStatus  ) 
 

This method is not intended for the client's usage.

The positioning module uses this method to sets the current condition of the positioning device that it uses to obtain position information.

Parameters:
aStatus The device status to set

Field Documentation

TDataQualityStatus TPositionModuleStatus::iDataQualityStatus [protected]
 

The data quality status.

TDeviceStatus TPositionModuleStatus::iDeviceStatus [protected]
 

The device status.

The documentation for this class was generated from the following file:
Copyright © Nokia Corporation 2001-2007
Back to top