TPositionModuleStatusEventBase Class Reference
| class TPositionModuleStatusEventBase : public TPositionClassTypeBase |
Inherits from
- TPositionModuleStatusEventBase
Detailed Description
The base class for classes storing position module status events
Member Type Definition Documentation
Typedef TModuleEvent
defined type for TModuleEvent
Typedef TSystemModuleEvent
defined type for TSystemModuleEvent
Member Attribute Documentation
iModuleId
The module ID causing the event
iOccurredEvents
A bitmask of the events which occurred
iRequestedEvents
A bitmask of the requested events
iSystemModuleEvent
System level module status events
Member Enumeration Documentation
Enum _TModuleEvent
| Enumerator | Value | Description |
|---|
| 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
| Enumerator | Value | Description |
|---|
| 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()
|
Constructor & Destructor Documentation
TPositionModuleStatusEventBase ( )
| IMPORT_C | TPositionModuleStatusEventBase | ( | ) | [protected] |
TPositionModuleStatusEventBase ( TModuleEvent )
| IMPORT_C | TPositionModuleStatusEventBase | ( | TModuleEvent | aRequestedEventMask | ) | [protected] |
| Parameter | Description | | aRequestedEventMask | The requested events |
Member Function Documentation
DoReset ( TInt )
| IMPORT_C void | DoReset | ( | TInt | aSizeOfClass | ) | [protected, virtual] |
| Parameter | Description | | aSizeOfClass | Function asserts that aSizeOfClass == sizeof(TPositionModuleStatusEventBase) to ensure DoReset was overridden in derived class. |
OccurredEvents ( )
Returns the events which have occurred
Returns: The events which have occurred
RequestedEvents ( )
Returns the requested events
Returns: The requested events
SetModuleId ( TPositionModuleId )
| Parameter | Description | | aModuleId | The module ID to set |
SetOccurredEvents ( TModuleEvent )
| IMPORT_C void | SetOccurredEvents | ( | TModuleEvent | aOccurredEventMask | ) | |
The occurred events to set
| Parameter | Description | | aOccurredEventMask | The occurred events to set |
SetRequestedEvents ( TModuleEvent )
| IMPORT_C void | SetRequestedEvents | ( | TModuleEvent | aRequestedEventMask | ) | |
Sets the requested events
| Parameter | Description | | aRequestedEventMask | The requested events to set |
SetSystemModuleEvent ( TSystemModuleEvent )
| Parameter | Description | | aSystemModuleEvent | The system event to set. |
SystemModuleEvent ( )
Returns The system event type.
Returns: The system event type.