#include <LbsCommon.h>
Link against: lbs.lib
Link against: lbsselflocate.lib

Class `TPositionModuleStatusEventBase`

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(TInt)Method to reset a TPositionModuleStatusEventBase to the 'unknown' state.
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()Default constructor for TPositionModuleStatusEventBase
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

Inherited from TPositionClassTypeBase:

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

Construction and destruction

`TPositionModuleStatusEventBase()`

protected: IMPORT_C TPositionModuleStatusEventBase();

Description

Default constructor for TPositionModuleStatusEventBase

`TPositionModuleStatusEventBase(TModuleEvent)`

protected: IMPORT_C TPositionModuleStatusEventBase(TModuleEvent aRequestedEventMask);

Description

Constructor for TPositionModuleStatusEventBase (with events)

Parameters


                                 						TPositionModuleStatusEventBase::TModuleEvent aRequestedEventMask

The requested events

Member functions

`SetRequestedEvents(TModuleEvent)`

IMPORT_C void SetRequestedEvents(TModuleEvent aRequestedEventMask);

Description

Sets the requested events

Parameters


                                 						TPositionModuleStatusEventBase::TModuleEvent aRequestedEventMask

The requested events to set

`RequestedEvents()const`

IMPORT_C TModuleEvent RequestedEvents() const;

Description

Returns the requested events

Return value

TPositionModuleStatusEventBase::TModuleEvent

The requested events

`SetOccurredEvents(TModuleEvent)`

IMPORT_C void SetOccurredEvents(TModuleEvent aOccurredEventMask);

Description

The occurred events to set

Parameters


                                 						TPositionModuleStatusEventBase::TModuleEvent aOccurredEventMask

The occurred events to set

`OccurredEvents()const`

IMPORT_C TModuleEvent OccurredEvents() const;

Description

Returns the events which have occurred

Return value

TPositionModuleStatusEventBase::TModuleEvent

The events which have occurred

`ModuleId()const`

IMPORT_C TPositionModuleId ModuleId() const;

Description

Returns the module ID

Return value

TUid

The module ID

`SetModuleId(TPositionModuleId)`

IMPORT_C void SetModuleId(TPositionModuleId aModuleId);

Description

The module ID to set

Parameters


                                 						TUid aModuleId

The module ID to set

`SetSystemModuleEvent(TSystemModuleEvent)`

IMPORT_C void SetSystemModuleEvent(TSystemModuleEvent aSystemModuleEvent);

Description

Sets the system event

Parameters


                                 						TPositionModuleStatusEventBase::TSystemModuleEvent aSystemModuleEvent

The system event to set.

`SystemModuleEvent()const`

IMPORT_C TSystemModuleEvent SystemModuleEvent() const;

Description

Returns The system event type.

Return value

TPositionModuleStatusEventBase::TSystemModuleEvent

The system event type.

`DoReset(TInt)`

protected: IMPORT_C virtual 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.

Member enumerations

Enum `_TSystemModuleEvent`

_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()const`. 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 `TPositionModuleStatusEventBase::ModuleId()const`.
`ESystemModuleRemoved`	System Module Removed A positioning module is uninstalled. The Id of the removed module can be found by calling `TPositionModuleStatusEventBase::ModuleId()const`

Enum `_TModuleEvent`

_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

Member type definitions

Typedef `TSystemModuleEvent`

typedef TUint32 TPositionModuleStatusEventBase::TSystemModuleEvent;

Description

defined type for TSystemModuleEvent

Typedef `TModuleEvent`

typedef TUint32 TPositionModuleStatusEventBase::TModuleEvent;

Description

defined type for TModuleEvent

Member data

`iRequestedEvents`

protected: TModuleEvent iRequestedEvents;

Description

A bitmask of the requested events

`iOccurredEvents`

protected: TModuleEvent iOccurredEvents;

Description

A bitmask of the events which occurred

`iSystemModuleEvent`

protected: TSystemModuleEvent iSystemModuleEvent;

Description

System level module status events

`iModuleId`

protected: TPositionModuleId iModuleId;

Description

The module ID causing the event

Class TPositionModuleStatusEventBase

Description

Derivation

Members

Construction and destruction

TPositionModuleStatusEventBase()

Description

TPositionModuleStatusEventBase(TModuleEvent)

Description

Parameters

Member functions

SetRequestedEvents(TModuleEvent)

Description

Parameters

RequestedEvents()const

Description

Return value

SetOccurredEvents(TModuleEvent)

Description

Parameters

OccurredEvents()const

Description

Return value

ModuleId()const

Description

Return value

SetModuleId(TPositionModuleId)

Description

Parameters

SetSystemModuleEvent(TSystemModuleEvent)

Description

Parameters

SystemModuleEvent()const

Description

Return value

DoReset(TInt)

Description

Parameters

Member enumerations

Enum _TSystemModuleEvent

Description

Enum _TModuleEvent

Description

Member type definitions

Typedef TSystemModuleEvent

Description

Typedef TModuleEvent

Description

Member data

iRequestedEvents

Description

iOccurredEvents

Description

iSystemModuleEvent

Description

iModuleId

Description

Class `TPositionModuleStatusEventBase`

`TPositionModuleStatusEventBase()`

`TPositionModuleStatusEventBase(TModuleEvent)`

`SetRequestedEvents(TModuleEvent)`

`RequestedEvents()const`

`SetOccurredEvents(TModuleEvent)`

`OccurredEvents()const`

`ModuleId()const`

`SetModuleId(TPositionModuleId)`

`SetSystemModuleEvent(TSystemModuleEvent)`

`SystemModuleEvent()const`

`DoReset(TInt)`

Enum `_TSystemModuleEvent`

Enum `_TModuleEvent`

Typedef `TSystemModuleEvent`

Typedef `TModuleEvent`

`iRequestedEvents`

`iOccurredEvents`

`iSystemModuleEvent`

`iModuleId`