Symbian^3 Product Developer Library >

RLocationTrail Class Reference

class RLocationTrail : public RLocationManager

RLocationManager class is used for creating a Location Manager session. Location Manager is used to start and stop the location trail, retrieve location information and write the location information to images.

LocationManager.lib
Since
S60 3.1

Inherits from

Public Member Functions
RLocationTrail()
~RLocationTrail()
IMPORT_C voidCancelLocationRequest()
IMPORT_C voidCancelNotificationRequest()
IMPORT_C voidCurrentLocation(TRequestStatus &, TLocationData &)
IMPORT_C TIntGetLocationTrailState(TTrailState &)
IMPORT_C TIntGetTrailCaptureSetting(TTrailCaptureSetting &)
IMPORT_C voidNotifyLocationTrailStateChange(TRequestStatus &)
IMPORT_C TIntRetrieveLocation(const TTime &, TLocationData &, TTrailState &)
IMPORT_C TIntStartLocationTrail(TTrailCaptureSetting)
IMPORT_C TIntStopLocationTrail()
Inherited Functions
RHandleBase::Attributes()const
RHandleBase::BTraceId()const
RHandleBase::DoExtendedClose()
RHandleBase::Duplicate(const RThread &,TOwnerType)
RHandleBase::FullName()const
RHandleBase::FullName(TDes &)const
RHandleBase::Handle()const
RHandleBase::HandleInfo(THandleInfo *)
RHandleBase::Name()const
RHandleBase::NotifyDestruction(TRequestStatus &)
RHandleBase::Open(const TFindHandleBase &,TOwnerType)
RHandleBase::OpenByName(const TDesC &,TOwnerType,TInt)
RHandleBase::RHandleBase()
RHandleBase::RHandleBase(TInt)
RHandleBase::SetHandle(TInt)
RHandleBase::SetHandleNC(TInt)
RLocationManager::Close()
RLocationManager::CompleteRequest(TRequestStatus &,TInt)
RLocationManager::Connect()
RLocationManager::RLocationManager()
RSessionBase::CreateSession(RServer2,const TVersion &)
RSessionBase::CreateSession(RServer2,const TVersion &,TInt)
RSessionBase::CreateSession(RServer2,const TVersion &,TInt,TIpcSessionType,const TSecurityPolicy *,TRequestStatus *)
RSessionBase::CreateSession(const TDesC &,const TVersion &)
RSessionBase::CreateSession(const TDesC &,const TVersion &,TInt)
RSessionBase::CreateSession(const TDesC &,const TVersion &,TInt,TIpcSessionType,const TSecurityPolicy *,TRequestStatus *)
RSessionBase::CreateSession(const TDesC &,const TVersion &,TInt,TRequestStatus *)
RSessionBase::Open(RMessagePtr2,TInt,TOwnerType)
RSessionBase::Open(RMessagePtr2,TInt,const TSecurityPolicy &,TOwnerType)
RSessionBase::Open(TInt,TOwnerType)
RSessionBase::Open(TInt,const TSecurityPolicy &,TOwnerType)
RSessionBase::Send(TInt)const
RSessionBase::Send(TInt,const TIpcArgs &)const
RSessionBase::SendReceive(TInt)const
RSessionBase::SendReceive(TInt,TRequestStatus &)const
RSessionBase::SendReceive(TInt,const TIpcArgs &)const
RSessionBase::SendReceive(TInt,const TIpcArgs &,TRequestStatus &)const
RSessionBase::SetReturnedHandle(TInt)
RSessionBase::SetReturnedHandle(TInt,RHandleBase &)
RSessionBase::SetReturnedHandle(TInt,const TSecurityPolicy &)
RSessionBase::ShareAuto()
RSessionBase::ShareProtected()
Public Member Enumerations
enumTTrailCaptureSetting { EOff, ECaptureNetworkInfo, ECaptureAll }
enumTTrailState {
ETrailStopped, EWaitingGPSData, ESearchingGPS, ETrailStarted, ETrailStopping, ETrailStarting
}
Inherited Enumerations
RHandleBase:TAttributes
RSessionBase:TAttachMode
Private Attributes
TPckg< TLocationData > *iCurrentLocData
Inherited Attributes
RHandleBase::iHandle

Constructor & Destructor Documentation

RLocationTrail()

IMPORT_CRLocationTrail()

~RLocationTrail()

IMPORT_C~RLocationTrail()

Member Functions Documentation

CancelLocationRequest()

IMPORT_C voidCancelLocationRequest()
Cancel asynchronous location request.
Since
S60 3.1

CancelNotificationRequest()

IMPORT_C voidCancelNotificationRequest()
Cancel notification request for the location trail state change.
Since
S60 3.1

CurrentLocation(TRequestStatus &, TLocationData &)

IMPORT_C voidCurrentLocation(TRequestStatus &aStatus,
TLocationData &aLocationData
)
Retrieve current location. If request is completed successfully, the result is returned via the aLocationInfo and aNetworkInfo arguments. The function is asynchronous, because it may take several minutes to get location information.
Since
S60 3.2

Parameters

TRequestStatus & aStatus
TLocationData & aLocationData

GetLocationTrailState(TTrailState &)

IMPORT_C TIntGetLocationTrailState(TTrailState &aState)
Retuns the current state of the location trail.
Since
S60 3.1

Parameters

TTrailState & aState

GetTrailCaptureSetting(TTrailCaptureSetting &)

IMPORT_C TIntGetTrailCaptureSetting(TTrailCaptureSetting &aCaptureSetting)

Get current trail capture setting.

Parameters

TTrailCaptureSetting & aCaptureSetting

NotifyLocationTrailStateChange(TRequestStatus &)

IMPORT_C voidNotifyLocationTrailStateChange(TRequestStatus &aStatus)
Get notification when the location trail state changes.
Since
S60 3.1

Parameters

TRequestStatus & aStatus

RetrieveLocation(const TTime &, TLocationData &, TTrailState &)

IMPORT_C TIntRetrieveLocation(const TTime &aTimeStamp,
TLocationData &aLocationData,
TTrailState &aState
)
Get location by time stamp. If the TLocality for given time stamp is found from the trail, it is returned even if the data in it wouldn't be valid.
Since
S60 3.1

Parameters

const TTime & aTimeStamp
TLocationData & aLocationData
TTrailState & aState

StartLocationTrail(TTrailCaptureSetting)

IMPORT_C TIntStartLocationTrail(TTrailCaptureSettingaState)
Starts recording location information to location trail.
Since
S60 3.2

Parameters

TTrailCaptureSetting aState

StopLocationTrail()

IMPORT_C TIntStopLocationTrail()
Stops recording location information to location trail.
Since
S60 3.1

Member Enumerations Documentation

Enum TTrailCaptureSetting

Enumerators

EOff
ECaptureNetworkInfo
ECaptureAll

Enum TTrailState

Location trail states.

Enumerators

ETrailStopped
EWaitingGPSData
ESearchingGPS
ETrailStarted
ETrailStopping
ETrailStarting

Member Data Documentation

TPckg< TLocationData > * iCurrentLocData

TPckg< TLocationData > *iCurrentLocData[private]

Copyright ©2010 Nokia Corporation and/or its subsidiary(-ies).
All rights reserved. Unless otherwise stated, these materials are provided under the terms of the Eclipse Public License v1.0.