TPositionModuleStatusEventBase Class Reference

class TPositionModuleStatusEventBase : public TPositionClassTypeBase

The base class for classes storing position module status events

Inherits from

Public Member Functions
IMPORT_C TPositionModuleIdModuleId()
IMPORT_C TModuleEventOccurredEvents()
IMPORT_C TModuleEventRequestedEvents()
IMPORT_C voidSetModuleId(TPositionModuleId)
IMPORT_C voidSetOccurredEvents(TModuleEvent)
IMPORT_C voidSetRequestedEvents(TModuleEvent)
IMPORT_C voidSetSystemModuleEvent(TSystemModuleEvent)
IMPORT_C TSystemModuleEventSystemModuleEvent()
Protected Member Functions
TPositionModuleStatusEventBase()
TPositionModuleStatusEventBase(TModuleEvent)
IMPORT_C voidDoReset(TInt)
Private Member Functions
voidReset()
Inherited Functions
TPositionClassTypeBase::PositionClassSize()const
TPositionClassTypeBase::PositionClassType()const
TPositionClassTypeBase::TPositionClassTypeBase()
Public Member Enumerations
enum_TModuleEvent { EEventNone = 0, EEventDeviceStatus = 0x01, EEventDataQualityStatus = 0x02, EEventSystemModuleEvent = 0x04, EEventAll = EEventDeviceStatus | EEventDataQualityStatus | EEventSystemModuleEvent }
enum_TSystemModuleEvent { ESystemUnknown = 0, ESystemError, ESystemModuleInstalled, ESystemModuleRemoved }
Public Member Type Definitions
typedef TUint32 TModuleEvent
typedef TUint32 TSystemModuleEvent
Protected Attributes
TPositionModuleId iModuleId
TModuleEvent iOccurredEvents
TModuleEvent iRequestedEvents
TSystemModuleEvent iSystemModuleEvent
Inherited Attributes
TPositionClassTypeBase::iPosClassSize
TPositionClassTypeBase::iPosClassType

Constructor & Destructor Documentation

TPositionModuleStatusEventBase()

IMPORT_CTPositionModuleStatusEventBase()[protected]

TPositionModuleStatusEventBase(TModuleEvent)

IMPORT_CTPositionModuleStatusEventBase(TModuleEventaRequestedEventMask)[protected]

Parameters

TModuleEvent aRequestedEventMask

Member Functions Documentation

DoReset(TInt)

IMPORT_C voidDoReset(TIntaSizeOfClass)[protected, virtual]

Parameters

TInt aSizeOfClass

ModuleId()

IMPORT_C TPositionModuleIdModuleId()const

OccurredEvents()

IMPORT_C TModuleEventOccurredEvents()const

RequestedEvents()

IMPORT_C TModuleEventRequestedEvents()const

Reset()

voidReset()[private]

SetModuleId(TPositionModuleId)

IMPORT_C voidSetModuleId(TPositionModuleIdaModuleId)

Parameters

TPositionModuleId aModuleId

SetOccurredEvents(TModuleEvent)

IMPORT_C voidSetOccurredEvents(TModuleEventaOccurredEventMask)

Parameters

TModuleEvent aOccurredEventMask

SetRequestedEvents(TModuleEvent)

IMPORT_C voidSetRequestedEvents(TModuleEventaRequestedEventMask)

Parameters

TModuleEvent aRequestedEventMask

SetSystemModuleEvent(TSystemModuleEvent)

IMPORT_C voidSetSystemModuleEvent(TSystemModuleEventaSystemModuleEvent)

Parameters

TSystemModuleEvent aSystemModuleEvent

SystemModuleEvent()

IMPORT_C TSystemModuleEventSystemModuleEvent()const

Member Enumerations Documentation

Enum _TModuleEvent

Module events

Enumerators

EEventNone = 0

No module event This is the unassigned value and should not be reported or used

EEventDeviceStatus = 0x01

Module event device status Events about the general status of the device. When this type of event occurs, client applications should inspect the value returned by the TPositionModuleInfo::DeviceStatus() method for more information

EEventDataQualityStatus = 0x02

Module Data Quality status Events about the quality of the data a module is able to return. When this type of event occurs, client applications should inspect the value returned by the TPositionModuleInfo::DataQualityStatus() method for more information.

EEventSystemModuleEvent = 0x04

Module System Event System level events about the status of modules. Events of this type indicate when modules have been added or removed from the system. When this event type occurs, client applications should inspect the value returned by TPositionModuleInfo::SystemModuleEvent() to determine which particular event was responsible

EEventAll = EEventDeviceStatus | EEventDataQualityStatus | EEventSystemModuleEvent

All events

Enum _TSystemModuleEvent

Module events

Enumerators

ESystemUnknown = 0

System Unknown This is not a valid state and should never be reported

ESystemError

System Error There are problems using the module. For example, the module may have terminated abnormally. It should not be confused with the module reporting the error EDeviceError via TPositionModuleStatus::DeviceStatus(). That signifies the module itself is up and running - but it may be unable to successful communicate with the hardware

ESystemModuleInstalled

System Module Installed A new positioning module has been dynamically added to the system. To receive this event, the client application must have expressed interest in status notifications from any positioning module. The Id of the newly installed module can be found by calling TPositionModuleStatusEvent::ModuleId().

ESystemModuleRemoved

System Module Removed A positioning module is uninstalled. The Id of the removed module can be found by calling TPositionModuleStatusEvent::ModuleId()

Member Type Definitions Documentation

Typedef TModuleEvent

typedef TUint32 TModuleEvent

defined type for TModuleEvent

Typedef TSystemModuleEvent

typedef TUint32 TSystemModuleEvent

defined type for TSystemModuleEvent

Member Data Documentation

TPositionModuleId iModuleId

TPositionModuleId iModuleId[protected]

The module ID causing the event

TModuleEvent iOccurredEvents

TModuleEvent iOccurredEvents[protected]

A bitmask of the events which occurred

TModuleEvent iRequestedEvents

TModuleEvent iRequestedEvents[protected]

A bitmask of the requested events

TSystemModuleEvent iSystemModuleEvent

TSystemModuleEvent iSystemModuleEvent[protected]

System level module status events

© Nokia 2010.