TPositionQualityBase Class Reference

#include <lbscommon.h>

Link against: lbs.lib

class TPositionQualityBase : public TPositionClassTypeBase, public TPositionClassTypeBase

Inherits from

TPositionQualityBase
- TPositionClassTypeBase
- TPositionClassTypeBase

Public Member Functions
IMPORT_C TInt	Compare(const TPositionQualityBase &, TInt, TPositionQualityItem::TResult &)
IMPORT_C TInt	HighWaterMark()
IMPORT_C TBool	IsDefined(TInt)

Protected Member Functions
	TPositionQualityBase()
TInt	GetElement(TInt, TPositionQualityItem::TDataType, T &)
IMPORT_C void	ResetElement(TInt)
void	SetElement(TInt, TPositionQualityItem::TDataType, TPositionQualityItem::TValuePreference, T)

Inherited Attributes
	TPositionClassTypeBase::iPosClassSize
	TPositionClassTypeBase::iPosClassType

Inherited Functions
	TPositionClassTypeBase::PositionClassSize()const
	TPositionClassTypeBase::PositionClassType()const
	TPositionClassTypeBase::TPositionClassTypeBase()

Detailed Description

The base class for classes used to store position quality information

Constructor & Destructor Documentation

TPositionQualityBase ( )

IMPORT_C

TPositionQualityBase

(

)

[protected]

Default constructor for TPositionQualityBase

Member Function Documentation

Compare ( const TPositionQualityBase &, TInt, TPositionQualityItem::TResult & )

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

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

Parameters
aPositionQuality	The position quality to compare against this position quality.
aElementToCompare	The element number that we want to compare.
aComparison	Set by this function to whether or not the TPositionQualityBase provided is better or worse than this TPositionQualityBase.

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

GetElement ( TInt, TPositionQualityItem::TDataType, T & )

TInt	GetElement	(	TInt	aElementId,
			TPositionQualityItem::TDataType	aDataType,
			T &	aData
		)	const [protected, inline]

Gets the data of an element from the array of elements.

Parameters
aElementId	The element Id of that we're interested in.
aDataType	The datatype of the data to be fetched.
aData	A pointer to the data to be written into.

Return Value: Standard Symbian OS Error code

HighWaterMark ( )

IMPORT_C TInt

HighWaterMark

(

)

const

Returns The High Water Mark

Return Value: The High Water Mark.

IsDefined ( TInt )

IMPORT_C TBool

IsDefined

(

TInt

aElementId

)

const

Returns whether an element is defined Whether or not this element has a defined state

Parameters
aElementId	The element Id of that we're interested in.

Return Value: TBool if definedWhether or not an element has a state of EUndefined.

ResetElement ( TInt )

IMPORT_C void

ResetElement

(

TInt

aElementId

)

[protected]

Resets element

Parameters
aElementId	The id of the element to be reset to a state of EUndefined. Maintains the iHighWaterMark.

SetElement ( TInt, TPositionQualityItem::TDataType, TPositionQualityItem::TValuePreference, T )

void	SetElement	(	TInt	aElementId,
			TPositionQualityItem::TDataType	aDataType,
			TPositionQualityItem::TValuePreference	aValuePreference,
			T	aData
		)	[protected, inline]

Sets the data of an element from the array of elements.

Parameters
aElementId	The element Id of that we're interested in.
aDataType	The datatype of the data to be fetched.
aValuePreference	Quality preferences
aData	A pointer to the data to be written into.