#include <lbscommon.h>
Link against: lbs.lib
| class TPositionModuleStatusEventBase : public TPositionClassTypeBase, public TPositionClassTypeBase |
| Public Member Type Definitions | |
|---|---|
| typedef | TUint32 TModuleEvent |
| typedef | TUint32 TSystemModuleEvent |
| Protected Attributes | |
|---|---|
| TPositionModuleId | iModuleId |
| TModuleEvent | iOccurredEvents |
| TModuleEvent | iRequestedEvents |
| TSystemModuleEvent | iSystemModuleEvent |
| Public Member Enumerations | |
|---|---|
| enum | _TModuleEvent { EEventNone, EEventDeviceStatus, EEventDataQualityStatus, EEventSystemModuleEvent, EEventAll } |
| enum | _TSystemModuleEvent { ESystemUnknown, ESystemError, ESystemModuleInstalled, ESystemModuleRemoved } |
| Public Member Functions | |
|---|---|
| IMPORT_C TPositionModuleId | ModuleId() |
| IMPORT_C TModuleEvent | OccurredEvents() |
| IMPORT_C TModuleEvent | RequestedEvents() |
| IMPORT_C void | SetModuleId(TPositionModuleId) |
| IMPORT_C void | SetOccurredEvents(TModuleEvent) |
| IMPORT_C void | SetRequestedEvents(TModuleEvent) |
| IMPORT_C void | SetSystemModuleEvent(TSystemModuleEvent) |
| IMPORT_C TSystemModuleEvent | SystemModuleEvent() |
| Protected Member Functions | |
|---|---|
| TPositionModuleStatusEventBase() | |
| TPositionModuleStatusEventBase(TModuleEvent) | |
| virtual IMPORT_C void | DoReset(TInt) |
| Inherited Attributes | |
|---|---|
| TPositionClassTypeBase::iPosClassSize | |
| TPositionClassTypeBase::iPosClassType | |
| Inherited Functions | |
|---|---|
| TPositionClassTypeBase::PositionClassSize()const | |
| TPositionClassTypeBase::PositionClassType()const | |
| TPositionClassTypeBase::TPositionClassTypeBase() | |
The base class for classes storing position module status events
| TSystemModuleEvent | iSystemModuleEvent | [protected] |
System level module status events
Module events
| 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 |
Module events
| 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() |
| IMPORT_C | TPositionModuleStatusEventBase | ( | ) | [protected] |
Default constructor for TPositionModuleStatusEventBase
| IMPORT_C | TPositionModuleStatusEventBase | ( | TModuleEvent | aRequestedEventMask | ) | [protected] |
Constructor for TPositionModuleStatusEventBase (with events)
| Parameters | |
|---|---|
| aRequestedEventMask | The requested events |
| IMPORT_C void | DoReset | ( | TInt | aSizeOfClass | ) | [protected, virtual] |
Method to reset a TPositionModuleStatusEventBase to the 'unknown' state.
| Parameters | |
|---|---|
| aSizeOfClass | Function asserts that aSizeOfClass == sizeof(TPositionModuleStatusEventBase) to ensure DoReset was overridden in derived class. |
| IMPORT_C TModuleEvent | OccurredEvents | ( | ) | const |
Returns the events which have occurred
| IMPORT_C TModuleEvent | RequestedEvents | ( | ) | const |
Returns the requested events
| IMPORT_C void | SetModuleId | ( | TPositionModuleId | aModuleId | ) |
The module ID to set
| Parameters | |
|---|---|
| aModuleId | The module ID to set |
| IMPORT_C void | SetOccurredEvents | ( | TModuleEvent | aOccurredEventMask | ) |
The occurred events to set
| Parameters | |
|---|---|
| aOccurredEventMask | The occurred events to set |
| IMPORT_C void | SetRequestedEvents | ( | TModuleEvent | aRequestedEventMask | ) |
Sets the requested events
| Parameters | |
|---|---|
| aRequestedEventMask | The requested events to set |
| IMPORT_C void | SetSystemModuleEvent | ( | TSystemModuleEvent | aSystemModuleEvent | ) |
Sets the system event
| Parameters | |
|---|---|
| aSystemModuleEvent | The system event to set. |
| IMPORT_C TSystemModuleEvent | SystemModuleEvent | ( | ) | const |
Returns The system event type.