TPositionInfoBase Class Reference

API published in: S60 2nd Ed FP 2

Link against: lbs.lib

Capability Information

Required Capabilities

None

Exceptions

The capability Location is required in:

TInt RPositionServer::GetDefaultModuleId(TPositionModuleId& aModuleId) const;

TInt RPositionServer::GetNumModules(TUint& aNumModules) const;

TInt RPositionServer::GetModuleInfoByIndex(TInt aModuleIndex, TPositionModuleInfoBase& aModuleInfo) const;

TInt RPositionServer::GetModuleInfoById(TPositionModuleId aModuleId, TPositionModuleInfoBase& aModuleInfo) const;

TInt RPositionServer::GetModuleStatus(TPositionModuleStatusBase& aPosModuleStatus, TPositionModuleId aModuleId) const;

void RPositionServer::NotifyModuleStatusEvent(TPositionModuleStatusEventBase& aStatusEvent,TRequestStatus& aStatus,const TPositionModuleId aModuleId = KPositionNullModuleId) const;

TInt RPositioner::SetRequestor(CRequestor::TRequestorType aType,CRequestor::TRequestorFormat aFormat,const TDesC& aData);

TInt RPositioner::SetRequestor(const RRequestorStack& aRequestorStack);

TInt RPositioner::SetUpdateOptions(const TPositionUpdateOptionsBase& aPosOption);

TInt RPositioner::GetUpdateOptions(TPositionUpdateOptionsBase& aPosOption) const;

void RPositioner::GetLastKnownPosition(TPositionInfoBase& aPosInfo,TRequestStatus& aStatus) const;

void RPositioner::NotifyPositionUpdate(TPositionInfoBase& aPosInfo,TRequestStatus& aStatus) const;

#include <lbspositioninfo.h>

Inherits TPositionClassTypeBase.

Inherited by TPositionInfo.

Detailed Description

This class provides the interface used by RPositioner to get a location fix, and as such all classes used to get location info from the location server should derive from this class.

Class contains info about the update type and the ID of the module that gave the location fix


Public Member Functions
IMPORT_C TPositionModuleId  ModuleId () const
  Get the unique identifier of the positioning module that provided the fix.
IMPORT_C void  SetModuleId (TPositionModuleId aModuleId)
  Set the unique identifier of the positioning module that provided the fix.
IMPORT_C TPositionUpdateType  UpdateType () const
  Get the type of position update provided to the client.
IMPORT_C void  SetUpdateType (TPositionUpdateType aUpdateType)
  Set the type of position update provided to the client.

Protected Member Functions
IMPORT_C  TPositionInfoBase ()
  Helper method.

Protected Attributes
TPositionModuleId  iModuleId
  The Id of the module that gave the location fix.
TUint32  iUpdateType
  The type of update that this location fix represents.

Constructor & Destructor Documentation

IMPORT_C TPositionInfoBase::TPositionInfoBase (   )  [protected]
 

Helper method.

To be used within the class

Member Function Documentation

IMPORT_C TPositionModuleId TPositionInfoBase::ModuleId (   )  const
 

Get the unique identifier of the positioning module that provided the fix.

Returns:
Returns the module Id of the module that gave the position fix.
IMPORT_C void TPositionInfoBase::SetModuleId (  TPositionModuleId  aModuleId  ) 
 

Set the unique identifier of the positioning module that provided the fix.

This is usually called by the Location framework. Clients need not call this method.

Parameters:
aModuleId  Module Id stored in this class is set to aModuleId.
IMPORT_C void TPositionInfoBase::SetUpdateType (  TPositionUpdateType  aUpdateType  ) 
 

Set the type of position update provided to the client.

This is usually called by the Location framework. Clients need not call this method.

Parameters:
aUpdateType  The update type of the position fix in this class is set to this.
IMPORT_C TPositionUpdateType TPositionInfoBase::UpdateType (   )  const
 

Get the type of position update provided to the client.

Returns:
Returns the update type of the position fix.

Field Documentation

TPositionModuleId TPositionInfoBase::iModuleId [protected]
 

The Id of the module that gave the location fix.

TUint32 TPositionInfoBase::iUpdateType [protected]
 

The type of update that this location fix represents.

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