TPositionFieldIndex Class Reference

#include <lbsfields.h>

class TPositionFieldIndex

Detailed Description

This is an internal class used for indexing entries in HPositionGenericInfo. Methods in this class are not intended to be called directly. Clients should use HPositionGenericInfo::GetValue() and HPositionGenericInfo::SetValue() methods.

Constructor & Destructor Documentation

TPositionFieldIndex ( )

TPositionFieldIndex()[inline]

Constructor

Default constructor. Sets the Id and start position to zero and the field type to PositionFieldManager::EUndefined.

Member Function Documentation

FieldId ( )

TPositionFieldId FieldId()const [inline]

Get the field ID referred to by this object.

Return Value
The Field Id. The Id is one of the enumerated values of _TPositionFieldId.Returns the field Id of the field that this index refers to.

FieldStartPos ( )

TUint16 FieldStartPos()const [inline]

Get the offset in buffer where this field is contained.

Return Value
The offset in the buffer.Returns the offset into HPositionGenericInfo::iBuffer of the start of the field that this index refers to.

FieldType ( )

PositionFieldManager::TFieldType FieldType()const [inline]

Get the data type of this field.

Return Value
The data type of this field. The data type is one of the enumerated values of PositionFieldManager::TFieldType.Returns the data type of the field that this index refers to.

SetFieldId ( TPositionFieldId )

voidSetFieldId(TPositionFieldIdaFieldId)[inline]

Set the field ID referred to by this object.

Parameters
aFieldIdSets the field Id of the entry this index refers to.

SetFieldStartPos ( TUint16 )

voidSetFieldStartPos(TUint16aFieldStartPos)[inline]

Set the offset in buffer where this field is contained.

Parameters
aFieldStartPosSets the start position of the entry this index refers to.

SetFieldType ( PositionFieldManager::TFieldType )

voidSetFieldType(PositionFieldManager::TFieldTypeaFieldType)[inline]

Set the data type of this field.

Parameters
aFieldTypeSets the field data type of the entry this index refers to.