TPositionQualityBase 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 <lbscommon.h>

Inherits TPositionClassTypeBase.

Inherited by TPositionQuality.

Detailed Description

The base class for classes used to store position quality information.


Public Member Functions
IMPORT_C TInt	Compare (const TPositionQualityBase &aPositionQuality, TInt aElementToCompare, TPositionQualityItem::TResult &aComparison) const
	Compares a specified element of another TPositionQualityBase object to this TPositionQualityBase.
IMPORT_C TBool	IsDefined (TInt aElementId) const
	Find the validity of an element.
IMPORT_C TInt	HighWaterMark () const
Protected Member Functions
IMPORT_C	TPositionQualityBase ()
IMPORT_C void	ResetElement (TInt aElementId)
template<class T>
void	SetElement (TInt aElementId, TPositionQualityItem::TDataType aDataType, TPositionQualityItem::TValuePreference aValuePreference, T aData)
template<class T>
TInt	GetElement (TInt aElementId, TPositionQualityItem::TDataType aDataType, T &aData) const

Constructor & Destructor Documentation

IMPORT_C TPositionQualityBase::TPositionQualityBase ( ) [protected]

Member Function Documentation

IMPORT_C TInt TPositionQualityBase::Compare	(	const TPositionQualityBase &	aPositionQuality,
		TInt	aElementToCompare,
		TPositionQualityItem::TResult &	aComparison
	)	const

Compares a specified element of another TPositionQualityBase object to this TPositionQualityBase.

Parameters:

`[in]`	aPositionQuality	The position quality to compare against this position quality.
	aElementToCompare	The element number that we want to compare.
`[out]`	aComparison	On return contains whether the aPositionQuality is better that this quality object for the specified quality element.

Returns:: KErrNone if comparison was successful.
KErrArgument if there is a mismatch of the datatypes of the value preference.

template<class T>
TInt TPositionQualityBase::GetElement	(	TInt	aElementId,
		TPositionQualityItem::TDataType	aDataType,
		T &	aData
	)	const `[inline, protected]`

IMPORT_C TInt TPositionQualityBase::HighWaterMark

(

)

const

Returns:: The High Water Mark.

IMPORT_C TBool TPositionQualityBase::IsDefined

(

TInt

aElementId

)

const

Find the validity of an element.

Returns:: Whether or not an element has a state of EUndefined.

IMPORT_C void TPositionQualityBase::ResetElement ( TInt aElementId ) [protected]

template<class T>
void TPositionQualityBase::SetElement	(	TInt	aElementId,
		TPositionQualityItem::TDataType	aDataType,
		TPositionQualityItem::TValuePreference	aValuePreference,
		T	aData
	)	`[inline, protected]`

The documentation for this class was generated from the following file:

lbscommon.h

TPositionQualityBase Class Reference

Capability Information

Detailed Description

Public Member Functions

Protected Member Functions

Constructor & Destructor Documentation

Member Function Documentation