Collapse all Symbian^3 Product Developer Library

TPositionQualityBase Class Reference

class TPositionQualityBase : public TPositionClassTypeBase

The base class for classes used to store position quality information

Inherits from

TPositionQualityBase
- 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)

Private Member Functions
IMPORT_C TInt	DoGetElement(TInt, TPositionQualityItem::TDataType, TAny *, TUint)
IMPORT_C void	DoSetElement(TInt, TPositionQualityItem::TDataType, TPositionQualityItem::TValuePreference, const TAny *, TUint)

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

Private Attributes
TInt	iHighwaterMark
TFixedArray< TPositionQualityItem, KPositionMaxSectionFields >	iPositionQualityData

Inherited Attributes
	TPositionClassTypeBase::iPosClassSize
	TPositionClassTypeBase::iPosClassType

Constructor & Destructor Documentation

TPositionQualityBase()

IMPORT_C

TPositionQualityBase

(

)

[protected]

Default constructor for TPositionQualityBase

Member Functions 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

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

DoGetElement(TInt, TPositionQualityItem::TDataType, TAny *, TUint)

IMPORT_C TInt	DoGetElement	(	TInt	aElementId,
			TPositionQualityItem::TDataType	aDataType,
			TAny *	aData,
			TUint	aSizeOfData
		)	const [private]

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

Parameters

TInt aElementId	The element Id of that we're interested in.
TPositionQualityItem::TDataType aDataType	The datatype of the data to be fetched.
TAny * aData	A pointer to the data to be written into.
TUint aSizeOfData	The size of the data object to be copied.

DoSetElement(TInt, TPositionQualityItem::TDataType, TPositionQualityItem::TValuePreference, const TAny *, TUint)

IMPORT_C void	DoSetElement	(	TInt	aElementId,
			TPositionQualityItem::TDataType	aDataType,
			TPositionQualityItem::TValuePreference	aValuePreference,
			const TAny *	aData,
			TUint	aSizeOfData
		)	[private]

Sets the data for an element in the element array.

Parameters

TInt aElementId	The element Id of that we're interested in.
TPositionQualityItem::TDataType aDataType	The datatype of the data to be set in the array.
TPositionQualityItem::TValuePreference aValuePreference	Whether greater or lower values indicate 'better'.
const TAny * aData	A pointer to the data to be read from.
TUint aSizeOfData	The size of the data object to be copied.

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

TInt aElementId	The element Id of that we're interested in.
TPositionQualityItem::TDataType aDataType	The datatype of the data to be fetched.
T & aData	A pointer to the data to be written into.

HighWaterMark()

IMPORT_C TInt

HighWaterMark

(

)

const

Returns 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

TInt aElementId

The element Id of that we're interested in.

ResetElement(TInt)

IMPORT_C void

ResetElement

(

TInt

aElementId

)

[protected]

Resets element

Parameters

TInt 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

TInt aElementId	The element Id of that we're interested in.
TPositionQualityItem::TDataType aDataType	The datatype of the data to be fetched.
TPositionQualityItem::TValuePreference aValuePreference	Quality preferences
T aData	A pointer to the data to be written into.

Member Data Documentation

TInt iHighwaterMark

TInt

iHighwaterMark

[private]

Internal highwater mark

TFixedArray< TPositionQualityItem, KPositionMaxSectionFields > iPositionQualityData

TFixedArray< TPositionQualityItem, KPositionMaxSectionFields >

iPositionQualityData

[private]

Internal array