Collapse all Symbian^3 Product Developer Library

TPositionModuleStatusEventBase Class Reference

class TPositionModuleStatusEventBase : public TPositionClassTypeBase

The base class for classes storing position module status events

Inherits from

TPositionModuleStatusEventBase
- TPositionClassTypeBase

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)
IMPORT_C void	DoReset(TInt)

Private Member Functions
void	Reset()

Inherited Functions
	TPositionClassTypeBase::PositionClassSize()const
	TPositionClassTypeBase::PositionClassType()const
	TPositionClassTypeBase::TPositionClassTypeBase()

Public Member Enumerations
enum	_TModuleEvent { EEventNone = 0, EEventDeviceStatus = 0x01, EEventDataQualityStatus = 0x02, EEventSystemModuleEvent = 0x04, EEventAll = EEventDeviceStatus \| EEventDataQualityStatus \| EEventSystemModuleEvent }
enum	_TSystemModuleEvent { ESystemUnknown = 0, ESystemError, ESystemModuleInstalled, ESystemModuleRemoved }

Public Member Type Definitions
typedef	TUint32 TModuleEvent
typedef	TUint32 TSystemModuleEvent

Protected Attributes
TPositionModuleId	iModuleId
TModuleEvent	iOccurredEvents
TModuleEvent	iRequestedEvents
TSystemModuleEvent	iSystemModuleEvent

Inherited Attributes
	TPositionClassTypeBase::iPosClassSize
	TPositionClassTypeBase::iPosClassType

Constructor & Destructor Documentation

TPositionModuleStatusEventBase()

IMPORT_C

TPositionModuleStatusEventBase

(

)

[protected]

Default constructor for TPositionModuleStatusEventBase

TPositionModuleStatusEventBase(TModuleEvent)

IMPORT_C

TPositionModuleStatusEventBase

(

TModuleEvent

aRequestedEventMask

)

[protected]

Constructor for TPositionModuleStatusEventBase (with events)

Parameters

TModuleEvent aRequestedEventMask

The requested events

Member Functions Documentation

DoReset(TInt)

IMPORT_C void

DoReset

(

TInt

aSizeOfClass

)

[protected, virtual]

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.

ModuleId()

IMPORT_C TPositionModuleId

ModuleId

(

)

const

Returns the module ID

OccurredEvents()

IMPORT_C TModuleEvent

OccurredEvents

(

)

const

Returns the events which have occurred

RequestedEvents()

IMPORT_C TModuleEvent

RequestedEvents

(

)

const

Returns the requested events

Reset()

void

Reset

(

)

[private]

Method that's called by RPositionServer to reset the TPositionModuleStatusEventBase derived object to it's unknown state.

SetModuleId(TPositionModuleId)

IMPORT_C void

SetModuleId

(

TPositionModuleId

aModuleId

)

The module ID to set

Parameters

TPositionModuleId aModuleId

The module ID to set

SetOccurredEvents(TModuleEvent)

IMPORT_C void

SetOccurredEvents

(

TModuleEvent

aOccurredEventMask

)

The occurred events to set

Parameters

TModuleEvent aOccurredEventMask

The occurred events to set

SetRequestedEvents(TModuleEvent)

IMPORT_C void

SetRequestedEvents

(

TModuleEvent

aRequestedEventMask

)

Sets the requested events

Parameters

TModuleEvent aRequestedEventMask

The requested events to set

SetSystemModuleEvent(TSystemModuleEvent)

IMPORT_C void

SetSystemModuleEvent

(

TSystemModuleEvent

aSystemModuleEvent

)

Sets the system event

Parameters

TSystemModuleEvent aSystemModuleEvent

The system event to set.

SystemModuleEvent()

IMPORT_C TSystemModuleEvent

SystemModuleEvent

(

)

const

Returns The system event type.

Member Enumerations Documentation

Enum _TModuleEvent

Module events

Enumerators

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

Module events

Enumerators

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

Member Type Definitions Documentation

Typedef TModuleEvent

typedef TUint32

TModuleEvent

defined type for TModuleEvent

Typedef TSystemModuleEvent

typedef TUint32

TSystemModuleEvent

defined type for TSystemModuleEvent

Member Data Documentation

TPositionModuleId iModuleId

TPositionModuleId

iModuleId

[protected]

The module ID causing the event

TModuleEvent iOccurredEvents

TModuleEvent

iOccurredEvents

[protected]

A bitmask of the events which occurred

TModuleEvent iRequestedEvents

TModuleEvent

iRequestedEvents

[protected]

A bitmask of the requested events

TSystemModuleEvent iSystemModuleEvent

TSystemModuleEvent

iSystemModuleEvent

[protected]

System level module status events