TPositionModuleStatusEventBase in Location Based Services LOCATIONFRAMEWORK

class TPositionModuleStatusEventBase : public TPositionClassTypeBase;

Description

The base class for classes 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

Members

Defined in TPositionModuleStatusEventBase:
DoReset(), EEventAll, EEventDataQualityStatus, EEventDeviceStatus, EEventNone, EEventSystemModuleEvent, ESystemError, ESystemModuleInstalled, ESystemModuleRemoved, ESystemUnknown, ModuleId(), OccurredEvents(), RequestedEvents(), SetModuleId(), SetOccurredEvents(), SetRequestedEvents(), SetSystemModuleEvent(), SystemModuleEvent(), TModuleEvent, TPositionModuleStatusEventBase(), TPositionModuleStatusEventBase(), TSystemModuleEvent, _TModuleEvent, _TSystemModuleEvent, iModuleId, iOccurredEvents, iRequestedEvents, iSystemModuleEvent

Inherited from TPositionClassTypeBase:
PositionClassSize(), PositionClassType(), iPosClassSize, iPosClassType

protected: IMPORT_C TPositionModuleStatusEventBase();

Description

Default constructor for TPositionModuleStatusEventBase

protected: IMPORT_C TPositionModuleStatusEventBase(TModuleEvent aRequestedEventMask);

Description

Constructor for TPositionModuleStatusEventBase (with events)

Parameters


                              TModuleEvent aRequestedEventMask

The requested events

IMPORT_C void SetRequestedEvents(TModuleEvent aRequestedEventMask);

Description

Sets the requested events

Parameters


                              TModuleEvent aRequestedEventMask

The requested events to set

IMPORT_C TModuleEvent RequestedEvents() const;

Description

Returns the requested events

Return value

TModuleEvent

The requested events

IMPORT_C void SetOccurredEvents(TModuleEvent aOccurredEventMask);

Description

The occurred events to set

Parameters


                              TModuleEvent aOccurredEventMask

The occurred events to set

IMPORT_C TModuleEvent OccurredEvents() const;

Description

Returns the events which have occurred

Return value

TModuleEvent

The events which have occurred

IMPORT_C TPositionModuleId ModuleId() const;

Description

Returns the module ID

Return value

TPositionModuleId

The module ID

IMPORT_C void SetModuleId(TPositionModuleId aModuleId);

Description

The module ID to set

Parameters


                              TPositionModuleId aModuleId

The module ID to set

IMPORT_C void SetSystemModuleEvent(TSystemModuleEvent aSystemModuleEvent);

Description

Sets the system event

Parameters


                              TSystemModuleEvent aSystemModuleEvent

The system event to set.

IMPORT_C TSystemModuleEvent SystemModuleEvent() const;

Description

Returns The system event type.

Return value

TSystemModuleEvent

The system event type.

protected: virtual IMPORT_C void DoReset(TInt aSizeOfClass);

Description

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

Parameters


                              TInt aSizeOfClass

Function asserts that aSizeOfClass == sizeof(TPositionModuleStatusEventBase) to ensure DoReset was overridden in derived class.

_TSystemModuleEvent

Description

Module events

`ESystemUnknown`	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()`

_TModuleEvent

Description

Module events

`EEventNone`	No module event This is the unassigned value and should not be reported or used
`EEventDeviceStatus`	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`	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`	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`	All events

typedef TUint32 TPositionModuleStatusEventBase::TSystemModuleEvent;

Description

defined type for TSystemModuleEvent

typedef TUint32 TPositionModuleStatusEventBase::TModuleEvent;

Description

defined type for TModuleEvent

protected: TModuleEvent iRequestedEvents;

Description

A bitmask of the requested events

protected: TModuleEvent iOccurredEvents;

Description

A bitmask of the events which occurred

protected: TSystemModuleEvent iSystemModuleEvent;

Description

System level module status events

protected: TPositionModuleId iModuleId;

Description

The module ID causing the event

Class TPositionModuleStatusEventBase

Description

Derivation

Members

Construction and destruction