Class RPositioner

class RPositioner : public RPositionerSubSessionBase;

Description

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 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.

Derivation

• RSubSessionBase - Client-side handle to a sub-session
• RPositionerSubSessionBase - Abstract base class for all positioning sub-sessions, including RPositioner
• RPositioner - This class is used to create a sub-session with the server for the purpose of obtaining the current position

Members

Defined in RPositioner:
Close(), ConstructL(), Destruct(), ExtendedInterface(), GetLastKnownPosition(), GetUpdateOptions(), NotifyPositionUpdate(), Open(), Open(), Open(), RPositioner(), SetRequestor(), SetRequestor(), SetUpdateOptions()

Inherited from RPositionerSubSessionBase:
CancelRequest()

Inherited from RSubSessionBase:
CloseSubSession(), CreateAutoCloseSubSession(), CreateSubSession(), Send(), SendReceive(), Session(), SubSessionHandle()

See also:

• RPositionServer

IMPORT_C RPositioner();

Description

Constructor for RPositioner

protected: virtual IMPORT_C void ConstructL();

Description

Leaving constructor for RPositioner. Just creates the ptr-holder.

IMPORT_C TInt Open(RPositionServer &aPosServer);

Description

Creates a sub-session with the positioning server.

Parameters

Return value

IMPORT_C TInt Open(RPositionServer &aPosServer, TPositionModuleId aModuleId);

Description

Creates a sub-session with the positioning server.

Parameters

Return value

IMPORT_C TInt Open(RPositionServer &aPosServer, const TPositionCriteriaBase &aCriteria);

Description

Creates a sub-session with the positioning server.

Parameters

Return value

IMPORT_C void Close();

Description

Closes a sub-session with the positioning server.

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

Description

Sets the requestor of the location information that will be obtained through this sub-session.

Parameters

Return value

IMPORT_C TInt SetRequestor(const RRequestorStack &aRequestorStack);

Description

Sets the many requestors of the location information that will be obtained through this sub-session.

Parameters

Return value

IMPORT_C TInt SetUpdateOptions(const TPositionUpdateOptionsBase &aPosOption);

Description

This method can be used to modify the behaviour of NotifyPositionUpdate() requests. It enables the client to request an interval time for receiving position updates.

Parameters

Return value

IMPORT_C TInt GetUpdateOptions(TPositionUpdateOptionsBase &aPosOption) const;

Description

This method retrieves the current update options being used by this RPositioner sub-session.

Parameters

Return value

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

Description

This method returns cached position information if it is available. This method can be an efficient mechanism - in terms of speed, cost and power consumption - of obtaining the devices' recent position.

Parameters

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

Description

This is an asynchronous method for obtaining position updates. It is possible to pass any class that is derived from TPositionInfoBase. However, the standard data retrieval class is TPositionInfo. The standard means of retrieving extended information is to use HPositionGenericInfo.

Parameters

protected: virtual IMPORT_C void Destruct();

Description

Destruction method for RPositionServer. Just deletes the ptr-holder.

protected: virtual IMPORT_C TAny *ExtendedInterface(TInt aFunctionNumber, TAny *aPtr1, TAny *aPtr2);

Description

This method is used to allow polymorphic extensions to the API without breaking BC. See documentation for explanation.

Parameters

Return value