Symbian
Symbian OS Library

SYMBIAN OS V9.3

[Index] [Spacer] [Previous] [Next]



Location: LbsCommon.h
Link against: lbsselflocate.lib

Class TPositionQualityBase

class TPositionQualityBase : public TPositionClassTypeBase;

Description

The base class for classes used to store position quality information

Derivation

Members

Defined in TPositionQualityBase:
Compare(), GetElement(), HighWaterMark(), IsDefined(), ResetElement(), SetElement(), TPositionQualityBase()

Inherited from TPositionClassTypeBase:
PositionClassSize(), PositionClassType(), iPosClassSize, iPosClassType


Construction and destruction


TPositionQualityBase()

protected: IMPORT_C TPositionQualityBase();

Description

Default constructor for TPositionQualityBase

[Top]


Member functions


Compare()

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

Description

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.

Return value

TInt

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


IsDefined()

IMPORT_C TBool IsDefined(TInt aElementId) const;

Description

Returns whether an element is defined

Parameters

TInt aElementId

The element Id of that we're interested in.

Return value

TBool

TBool if defined


HighWaterMark()

IMPORT_C TInt HighWaterMark() const;

Description

Returns The High Water Mark

Return value

TInt

The High Water Mark.


ResetElement()

protected: IMPORT_C void ResetElement(TInt aElementId);

Description

Resets element

Parameters

TInt aElementId

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


SetElement()

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

Description

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.


GetElement()

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

Description

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.

Return value

TInt

Standard Symbian OS Error code