Class TPositionModuleStatusEvent

class TPositionModuleStatusEvent : public TPositionModuleStatusEventBase;

Description

The normal class for storing position module status events

Derivation

• TPositionClassTypeBase - The base class for classes used to store position information

• TPositionModuleStatusEventBase - The base class for classes storing position module status events

• TPositionModuleStatusEvent - The normal class for storing position module status events

Members

Defined in TPositionModuleStatusEvent:

• DoReset(TInt)Method to reset a TPositionModuleStatusEvent to the 'unknown' state.
• GetModuleStatus(TPositionModuleStatus &)constGets Where the module status will be written
• SetModuleStatus(const TPositionModuleStatus &)Sets the module status
• TPositionModuleStatusEvent()Default constructor for TPositionModuleStatusEvent
• TPositionModuleStatusEvent(TModuleEvent)Constructor for TPositionModuleStatusEvent (with events)
• iModuleStatusThe module status

Inherited from TPositionClassTypeBase:

• PositionClassSize()constPositionClassSize
• PositionClassType()constPositionClassTypeType
• iPosClassSizeThe size of the derived class
• iPosClassTypeThe type of the derived class

Inherited from TPositionModuleStatusEventBase:

• EEventAllAll events
• EEventDataQualityStatusModule Data Quality status Events about the quality of the data a module is able...
• EEventDeviceStatusModule event device status Events about the general status of the device. When t...
• EEventNoneNo module event This is the unassigned value and should not be reported or used
• EEventSystemModuleEventModule System Event System level events about the status of modules. Events of t...
• ESystemErrorSystem Error There are problems using the module. For example, the module may ha...
• ESystemModuleInstalledSystem Module Installed A new positioning module has been dynamically added to t...
• ESystemModuleRemovedSystem Module Removed A positioning module is uninstalled. The Id of the removed...
• ESystemUnknownSystem Unknown This is not a valid state and should never be reported
• ModuleId()constReturns the module ID
• OccurredEvents()constReturns the events which have occurred
• RequestedEvents()constReturns the requested events
• SetModuleId(TPositionModuleId)The module ID to set
• SetOccurredEvents(TModuleEvent)The occurred events to set
• SetRequestedEvents(TModuleEvent)Sets the requested events
• SetSystemModuleEvent(TSystemModuleEvent)Sets the system event
• SystemModuleEvent()constReturns The system event type.
• TModuleEventdefined type for TModuleEvent
• TPositionModuleStatusEventBase(TModuleEvent)Constructor for TPositionModuleStatusEventBase (with events)
• TSystemModuleEventdefined type for TSystemModuleEvent
• _TModuleEventModule events
• _TSystemModuleEventModule events
• iModuleIdThe module ID causing the event
• iOccurredEventsA bitmask of the events which occurred
• iRequestedEventsA bitmask of the requested events
• iSystemModuleEventSystem level module status events

IMPORT_C TPositionModuleStatusEvent();

Description

Default constructor for TPositionModuleStatusEvent

IMPORT_C TPositionModuleStatusEvent(TModuleEvent aRequestedEventMask);

Description

Constructor for TPositionModuleStatusEvent (with events)

Parameters

TPositionModuleStatusEventBase::TModuleEvent aRequestedEventMask The requested events

IMPORT_C void SetModuleStatus(const TPositionModuleStatus &aModuleStatus);

Description

Sets the module status

Parameters

const TPositionModuleStatus &aModuleStatus The module status to set

IMPORT_C void GetModuleStatus(TPositionModuleStatus &aModuleStatus) const;

Description

Gets Where the module status will be written

Parameters

TPositionModuleStatus &aModuleStatus Where the module status will be written to

protected: IMPORT_C virtual void DoReset(TInt aSizeOfClass);

Description

Method to reset a TPositionModuleStatusEvent to the 'unknown' state.

Parameters

TInt aSizeOfClass Function asserts that aSizeOfClass == sizeof(TPositionModuleStatusEvent) to ensure DoReset was overridden in derived class if class has been derived from.

protected: TPositionModuleStatus iModuleStatus;

Description

The module status