S60 3rd Edition API Reference: TPositionModuleStatusEvent Class Reference

TPositionModuleStatusEvent Class Reference

API published in: S60 2nd Ed FP 2

Link against: lbs.lib

Capability Information

Required Capabilities

Location

#include <lbscommon.h>

Inherits TPositionModuleStatusEventBase.

Detailed Description

The normal class for storing position module status events.

Public Member Functions

IMPORT_C TPositionModuleStatusEvent ()
 Default constructor for TPositionModuleStatusEvent.
IMPORT_C TPositionModuleStatusEvent (TModuleEvent aRequestedEventMask)
 Constructor for TPositionModuleStatusEvent (with events).
IMPORT_C void SetModuleStatus (const TPositionModuleStatus &aModuleStatus)
 This method is not intended for the client's usage.
IMPORT_C void GetModuleStatus (TPositionModuleStatus &aModuleStatus) const
 Obtain the status of the positioning module.

Protected Member Functions

virtual IMPORT_C void DoReset (TInt aSizeOfClass)

Protected Attributes

TPositionModuleStatus iModuleStatus
 The module status.

Constructor & Destructor Documentation

IMPORT_C TPositionModuleStatusEvent::TPositionModuleStatusEvent (   ) 
 

Default constructor for TPositionModuleStatusEvent.

IMPORT_C TPositionModuleStatusEvent::TPositionModuleStatusEvent ( TModuleEvent  aRequestedEventMask  ) 
 

Constructor for TPositionModuleStatusEvent (with events).

Parameters:
aRequestedEventMask a bit mask value that indicates the type of events for which notification is requested

Member Function Documentation

virtual IMPORT_C void TPositionModuleStatusEvent::DoReset ( TInt  aSizeOfClass  )  [protected, virtual]
 

Reimplemented from TPositionModuleStatusEventBase.

IMPORT_C void TPositionModuleStatusEvent::GetModuleStatus ( TPositionModuleStatus &  aModuleStatus  )  const
 

Obtain the status of the positioning module.

Parameters:
[out] aModuleStatus Where the module status will be returned.
IMPORT_C void TPositionModuleStatusEvent::SetModuleStatus ( const TPositionModuleStatus &  aModuleStatus  ) 
 

This method is not intended for the client's usage.

The positioning module uses this method to set the status of the positioning device and the data quality status of the position information returned by this positioning module.

Parameters:
[in] aModuleStatus The module status to set

Field Documentation

TPositionModuleStatus TPositionModuleStatusEvent::iModuleStatus [protected]
 

The module status.

The documentation for this class was generated from the following file:
Copyright © Nokia Corporation 2001-2007
Back to top