RPositioner Class Reference

class RPositioner : public RPositionerSubSessionBase

This class is used to create a sub-session with the server for the purpose of obtaining the current position. In addition to actually obtaining position information, this class also provides mechanisms for obtaining the last known position, the last known position with area information, the general status of the positioning module, changing how often it wishes to receive position updates, as well as identifying itself to the location framework.

Before using the class, a primary connection must have already been established with the server.

RPositionServer

Public Member Functions
RPositioner()
IMPORT_C voidClose()
IMPORT_C voidGetLastKnownPosition(TPositionInfoBase &, TRequestStatus &)
IMPORT_C voidGetLastKnownPositionArea(TPositionInfoBase &, TPositionAreaInfoBase &, TRequestStatus &)
IMPORT_C TIntGetUpdateOptions(TPositionUpdateOptionsBase &)
IMPORT_C voidNotifyPositionUpdate(TPositionInfoBase &, TRequestStatus &)
IMPORT_C TIntOpen(RPositionServer &)
IMPORT_C TIntOpen(RPositionServer &, TPositionModuleId)
IMPORT_C TIntOpen(RPositionServer &, const TPositionCriteriaBase &)
TInt OpenImpl(RPositionServer &, TPositionModuleId, const TPositionCriteriaBase &, TBool)
IMPORT_C TIntSetRequestor(CRequestor::TRequestorType, CRequestor::TRequestorFormat, const TDesC &)
IMPORT_C TIntSetRequestor(const RRequestorStack &)
IMPORT_C TIntSetUpdateOptions(const TPositionUpdateOptionsBase &)
Protected Member Functions
IMPORT_C voidConstructL()
IMPORT_C voidDestruct()
IMPORT_C TAny *ExtendedInterface(TInt, TAny *, TAny *)
Inherited Functions
RPositionerSubSessionBase::CancelRequest(TRequestId)
RPositionerSubSessionBase::CompleteRequest(TInt)
RPositionerSubSessionBase::RPositionerSubSessionBase()
RSubSessionBase::CloseSubSession(TInt)
RSubSessionBase::CreateAutoCloseSubSession(RSessionBase &,TInt,const TIpcArgs &)
RSubSessionBase::CreateSubSession(const RSessionBase &,TInt)
RSubSessionBase::CreateSubSession(const RSessionBase &,TInt,const TIpcArgs &)
RSubSessionBase::RSubSessionBase()
RSubSessionBase::Send(TInt)const
RSubSessionBase::Send(TInt,const TIpcArgs &)const
RSubSessionBase::SendReceive(TInt)const
RSubSessionBase::SendReceive(TInt,TRequestStatus &)const
RSubSessionBase::SendReceive(TInt,const TIpcArgs &)const
RSubSessionBase::SendReceive(TInt,const TIpcArgs &,TRequestStatus &)const
RSubSessionBase::Session()const
RSubSessionBase::SubSessionHandle()const
Inherited Enumerations
RPositionerSubSessionBase:_TRequestId
Private Attributes
CPositioningPtrHolder *iPtrHolder
TAny *iReserved

Constructor & Destructor Documentation

RPositioner()

IMPORT_CRPositioner()

Member Functions Documentation

Close()

IMPORT_C voidClose()

ConstructL()

IMPORT_C voidConstructL()[protected, virtual]

Destruct()

IMPORT_C voidDestruct()[protected, virtual]

ExtendedInterface(TInt, TAny *, TAny *)

IMPORT_C TAny *ExtendedInterface(TIntaFunctionNumber,
TAny *aPtr1,
TAny *aPtr2
)[protected, virtual]

Parameters

TInt aFunctionNumber
TAny * aPtr1
TAny * aPtr2

GetLastKnownPosition(TPositionInfoBase &, TRequestStatus &)

IMPORT_C voidGetLastKnownPosition(TPositionInfoBase &aPosInfo,
TRequestStatus &aStatus
)const

Parameters

TPositionInfoBase & aPosInfo
TRequestStatus & aStatus

GetLastKnownPositionArea(TPositionInfoBase &, TPositionAreaInfoBase &, TRequestStatus &)

IMPORT_C voidGetLastKnownPositionArea(TPositionInfoBase &aPosInfo,
TPositionAreaInfoBase &aAreaInfo,
TRequestStatus &aStatus
)const

Parameters

TPositionInfoBase & aPosInfo
TPositionAreaInfoBase & aAreaInfo
TRequestStatus & aStatus

GetUpdateOptions(TPositionUpdateOptionsBase &)

IMPORT_C TIntGetUpdateOptions(TPositionUpdateOptionsBase &aPosOption)const

Parameters

TPositionUpdateOptionsBase & aPosOption

NotifyPositionUpdate(TPositionInfoBase &, TRequestStatus &)

IMPORT_C voidNotifyPositionUpdate(TPositionInfoBase &aPosInfo,
TRequestStatus &aStatus
)const

Parameters

TPositionInfoBase & aPosInfo
TRequestStatus & aStatus

Open(RPositionServer &)

IMPORT_C TIntOpen(RPositionServer &aPosServer)

Parameters

RPositionServer & aPosServer

Open(RPositionServer &, TPositionModuleId)

IMPORT_C TIntOpen(RPositionServer &aPosServer,
TPositionModuleIdaModuleId
)

Parameters

RPositionServer & aPosServer
TPositionModuleId aModuleId

Open(RPositionServer &, const TPositionCriteriaBase &)

IMPORT_C TIntOpen(RPositionServer &aPosServer,
const TPositionCriteriaBase &aCriteria
)

Parameters

RPositionServer & aPosServer
const TPositionCriteriaBase & aCriteria

OpenImpl(RPositionServer &, TPositionModuleId, const TPositionCriteriaBase &, TBool)

TInt OpenImpl(RPositionServer &aPosServer,
TPositionModuleIdaModuleId,
const TPositionCriteriaBase &aCriteria,
TBoolaOpenedUsingModuleId
)

Parameters

RPositionServer & aPosServer
TPositionModuleId aModuleId
const TPositionCriteriaBase & aCriteria
TBool aOpenedUsingModuleId

SetRequestor(CRequestor::TRequestorType, CRequestor::TRequestorFormat, const TDesC &)

IMPORT_C TIntSetRequestor(CRequestor::TRequestorTypeaType,
CRequestor::TRequestorFormataFormat,
const TDesC &aData
)

Parameters

CRequestor::TRequestorType aType
CRequestor::TRequestorFormat aFormat
const TDesC & aData

SetRequestor(const RRequestorStack &)

IMPORT_C TIntSetRequestor(const RRequestorStack &aRequestorStack)

Parameters

const RRequestorStack & aRequestorStack

SetUpdateOptions(const TPositionUpdateOptionsBase &)

IMPORT_C TIntSetUpdateOptions(const TPositionUpdateOptionsBase &aPosOption)

Parameters

const TPositionUpdateOptionsBase & aPosOption

Member Data Documentation

CPositioningPtrHolder * iPtrHolder

CPositioningPtrHolder *iPtrHolder[private]

A pointer to a container that holds pointer descriptors, needed to point to the clients request data during asynchronous requests

TAny * iReserved

TAny *iReserved[private]

Unused variable for future expansion.