S60 3rd Edition SDK for Symbian OS Example Applications Guide

CLbsPositionRequestor Class Reference

#include <LBSPositionRequestor.h>

List of all members.

Public Member Functions
virtual	~CLbsPositionRequestor ()
Static Public Member Functions
static CLbsPositionRequestor *	NewL (MLbsPositionListener &aPositionListener)
Protected Member Functions
void	DoCancel ()
void	RunL ()
Private Member Functions
void	ConstructL ()
	CLbsPositionRequestor (MLbsPositionListener &aPositionListener)
void	DoInitialiseL ()
void	GetModuleName (const TPositionModuleId &aModuleId)
void	PositionUpdatedL ()
Private Attributes
TPositionModuleId	iUsedPsy
RPositionServer	iPosServer
RPositioner	iPositioner
TPositionInfo	iPositionInfo
TPositionSatelliteInfo	iSatelliteInfo
MLbsPositionListener &	iPositionListener
TBuf< KPositionMaxModuleName >	iModuleName
TPositionUpdateOptions	iUpdateops
TPositionInfoBase *	iPosInfoBase
TBool	iGettingLastknownPosition

---

Detailed Description

Position requestor. Request the position from the Location FW and handles the position requesting process

Definition at line 33 of file LBSPositionRequestor.h.

---

Constructor & Destructor Documentation

CLbsPositionRequestor::~CLbsPositionRequestor (   )  [virtual]

Destructor. Definition at line 127 of file LBSPositionRequestor.cpp. References iPositioner, and iPosServer. { // Cancel active object Cancel(); // Close the positioner iPositioner.Close(); // Close the session to the position server iPosServer.Close(); }

CLbsPositionRequestor::CLbsPositionRequestor (  MLbsPositionListener &  aPositionListener  )  [private]

C++ default constructor. Parameters: aPositionListener  Position listener to be registered Definition at line 63 of file LBSPositionRequestor.cpp. References iUpdateops. : CActive(CActive::EPriorityStandard), iPositionListener( aPositionListener ), iPosInfoBase( &iPositionInfo ), iGettingLastknownPosition( ETrue ) { // Set update interval to one second to receive one position data per second iUpdateops.SetUpdateInterval(TTimeIntervalMicroSeconds(KUpdateInterval)); // If position server could not get position // In two minutes it will terminate the position request iUpdateops.SetUpdateTimeOut(TTimeIntervalMicroSeconds(KUpdateTimeOut)); // Positions which have time stamp below KMaxAge can be reused iUpdateops.SetMaxUpdateAge(TTimeIntervalMicroSeconds(KMaxAge)); // Enables location framework to send partial position data iUpdateops.SetAcceptPartialUpdates(ETrue); // Add this position requestor to the active scheduler CActiveScheduler::Add( this ); }

---

Member Function Documentation

CLbsPositionRequestor * CLbsPositionRequestor::NewL (  MLbsPositionListener &  aPositionListener  )  [static]

Creates a new instance of a CLbsPositionRequestor Parameters: aPositionListener  Position listener to be registered Returns: The newly created CLbsPositionRequestor object Definition at line 102 of file LBSPositionRequestor.cpp. References CLbsPositionRequestor(). { //Create the object CLbsPositionRequestor* self = new( ELeave ) CLbsPositionRequestor( aPositionListener); //Push to the cleanup stack CleanupStack::PushL( self ); //Construct the object self->ConstructL(); //Remove from cleanup stack CleanupStack::Pop( self ); //Return pointer to the created object return self; }

void CLbsPositionRequestor::ConstructL (   )  [private]

By default Symbian 2nd phase constructor is private. Definition at line 91 of file LBSPositionRequestor.cpp. References DoInitialiseL(). { // Initialise the position request sequence DoInitialiseL(); }

void CLbsPositionRequestor::DoInitialiseL (   )  [private]

Starts a position requesting sequence Definition at line 299 of file LBSPositionRequestor.cpp. References iPosInfoBase, iPositioner, iPositionListener, iPosServer, iUpdateops, and MLbsPositionListener::ShowErrorL(). { // Connect to the position server TInt error = iPosServer.Connect( ); TBuf<100> buffer; // The connection failed if ( KErrNone != error ) { // Show error to the user and leave buffer.Format(KLbsErrPosServConn, error); iPositionListener.ShowErrorL( buffer ); return; } // Open subsession to the position server error = iPositioner.Open(iPosServer); // The opening of a subsession failed if ( KErrNone != error ) { // Show error to the user and leave buffer.Format(KLbsErrOpenPos, error); iPositionListener.ShowErrorL( buffer ); iPosServer.Close(); return; } // Set position requestor error = iPositioner.SetRequestor( CRequestor::ERequestorService , CRequestor::EFormatApplication , KRequestor ); // The requestor could not be set if ( KErrNone != error ) { // Show error to the user and leave buffer.Format(KLbsErrSetRequestor, error); iPositionListener.ShowErrorL( buffer ); iPositioner.Close(); iPosServer.Close(); return; } // Set update options error = iPositioner.SetUpdateOptions( iUpdateops ); // The options could not be updated if ( KErrNone != error ) { // Show error to the user and leave buffer.Format(KLbsErrSetUpOpt, error); iPositionListener.ShowErrorL( buffer ); iPositioner.Close(); iPosServer.Close(); return; } // Get last known position. The processing of the result // is done in RunL method iPositioner.GetLastKnownPosition(*iPosInfoBase,iStatus); // Set this active object active SetActive(); }

void CLbsPositionRequestor::GetModuleName (  const TPositionModuleId &  aModuleId  )  [private]

Gets the name of the positioning module. If the name is not available the name will be an empty string Parameters: aModuleId  The id of the module Definition at line 370 of file LBSPositionRequestor.cpp. References iModuleName, and iPosServer. { // Module information of the position module TPositionModuleInfo modInfo; // Get module info by module id TInt error = iPosServer.GetModuleInfoById( *&aModuleId, modInfo ); // If error occured if ( KErrNone != error ) { // Set the name of the module to 'Unknown' iModuleName = KUnknown; } else { // Get the name of the position module modInfo.GetModuleName(iModuleName); } }

void CLbsPositionRequestor::PositionUpdatedL (   )  [private]

Preprocess the position information Definition at line 397 of file LBSPositionRequestor.cpp. References GetModuleName(), iGettingLastknownPosition, iModuleName, iPosInfoBase, iPositioner, iPositionInfo, iPositionListener, iPosServer, iSatelliteInfo, iUsedPsy, and MLbsPositionListener::PositionInfoUpdatedL(). { //If we are getting the last known position if ( iGettingLastknownPosition ) { // Set the module name to 'Unknown' because last // known position has no module name iModuleName = KUnknown; // Send position information to registered listener iPositionListener.PositionInfoUpdatedL(*iPosInfoBase,iModuleName); //Change the data class type iPosInfoBase = &iSatelliteInfo; // Request next position iPositioner.NotifyPositionUpdate( *iPosInfoBase, iStatus ); // Set this object active SetActive(); } else { // Check if the id of the used PSY is 0 if ( 0 == iUsedPsy.iUid) { // Set the id of the currently used PSY iUsedPsy = iPosInfoBase->ModuleId(); } // Check if the position module has changed else if ( iPosInfoBase->ModuleId() != iUsedPsy ) { // Set the id of the currently used PSY iUsedPsy = iPosInfoBase->ModuleId(); //Position module info of new module TPositionModuleInfo moduleInfo; // Get module info iPosServer.GetModuleInfoById(iUsedPsy,moduleInfo); // Get classes supported TInt32 moduleInfoFamily = moduleInfo.ClassesSupported(EPositionInfoFamily); iPosInfoBase = &iSatelliteInfo; // Check if the new module supports // TPositionSatelliteInfo class if ( EPositionSatelliteInfoClass & moduleInfoFamily ) { // Set info base to satellite info iPosInfoBase = &iSatelliteInfo; } // The position module must support atleast // TPositionInfo class else { // Set info base to position info iPosInfoBase = &iPositionInfo; } } // Process the position information // and request next position // Get module name GetModuleName(iUsedPsy); // Send position information to registered listener iPositionListener.PositionInfoUpdatedL(*iPosInfoBase,iModuleName); // Request next position iPositioner.NotifyPositionUpdate( *iPosInfoBase, iStatus ); // Set this object active SetActive(); } }

---

© Nokia 2006