| class HPositionGenericInfo : public TPositionInfo |
Class for getting arbitrary positioning related information back from the location server. The client can set upto KPositionMaxRequestedFields as the number of requested fields. The definitions of the fields are given in the enum _TPositionFieldId. The client must know what data type will be returned for each of the fields. The server will make a best attempt to fill in the requested fields.
The client needs to allocate a big enough buffer to store the information it is requesting. In order to be sure of getting back all the information the client must know and allocate memory considering the return value for each requested field.
| Public Member Functions | |
|---|---|
| IMPORT_C TInt | BufferSize() |
| IMPORT_C void | ClearPositionData() |
| IMPORT_C void | ClearRequestedFields() |
| IMPORT_C TPositionFieldId | FirstRequestedFieldId() |
| TInt | GetValue(TPositionFieldId, TType &) |
| IMPORT_C TBool | IsFieldAvailable(TPositionFieldId) |
| IMPORT_C TInt | IsRequestedField(TPositionFieldId) |
| IMPORT_C TInt | MaxFields() |
| IMPORT_C HPositionGenericInfo * | New(TInt, TInt) |
| IMPORT_C HPositionGenericInfo * | NewL(TInt, TInt) |
| IMPORT_C HPositionGenericInfo * | NewLC(TInt, TInt) |
| IMPORT_C TPositionFieldId | NextRequestedFieldId(TPositionFieldId) |
| IMPORT_C TInt | SetRequestedField(TPositionFieldId) |
| IMPORT_C TInt | SetRequestedFields(const TPositionFieldIdList) |
| TInt | SetValue(TPositionFieldId, const TType &) |
| Private Member Functions | |
|---|---|
| HPositionGenericInfo(TInt, TInt, TUint, TUint, TBool) | |
| HPositionGenericInfo(const HPositionGenericInfo &) | |
| TPositionFieldIndex * | FieldIndexPtr() |
| const TPositionFieldIndex * | FieldIndexPtr() |
| TInt | FindEmptyRequestedFieldOffset(TInt &) |
| TPositionFieldId * | RequestedFieldPtr() |
| const TPositionFieldId * | RequestedFieldPtr() |
| HPositionGenericInfo & | operator=(const HPositionGenericInfo &) |
| Private Attributes | |
|---|---|
| TUint8 | iBuffer |
| const TUint | iDataStartPoint |
| const TUint | iFieldIndexStartPoint |
| const TInt | iMaxFields |
| const TInt | iTotalBufferSize |
| HPositionGenericInfo | ( | TInt | aDataBufferSize, |
| TInt | aMaxFields, | ||
| TUint | aFieldIndexStartPoint, | ||
| TUint | aDataStartPoint, | ||
| TBool | aResetRequestedFields | ||
| ) | [private] | ||
| HPositionGenericInfo | ( | const HPositionGenericInfo & | ) | [private] |
internal private method
| const HPositionGenericInfo & |
| TPositionFieldIndex * | FieldIndexPtr | ( | ) | [private, inline] |
Helper method. For internal usage only
| const TPositionFieldIndex * | FieldIndexPtr | ( | ) | const [private, inline] |
Helper method. For internal usage only
| TInt | FindEmptyRequestedFieldOffset | ( | TInt & | aEmptyFieldOffset | ) | const [private] |
| TInt & aEmptyFieldOffset |
| TInt | GetValue | ( | TPositionFieldId | aFieldId, |
| TType & | aValue | |||
| ) | const [inline] | |||
Used to retrieve position information. a symbian OS error code.
KErrNone on successful operation.
KErrOverflow if the supplied descriptor is too short to contain the requested field. This method must use the same data type as that assigned by SetValue() .
| TPositionFieldId aFieldId | Standard position field identifier. See _TPositionFieldId |
| TType & aValue | The parameter aValue can be of the type TInt8, TInt16, TInt32, TInt64, TUint8, TUint16, TUint32, TReal32, TReal64, TTime, TTimeIntervalMicroSeconds, Des8, or Des16. Panics with EPositionGenericInfoMismatchDataType if there is a mismatch in the data type of a field. |
| IMPORT_C TBool | IsFieldAvailable | ( | TPositionFieldId | aFieldId | ) | const |
| TPositionFieldId aFieldId |
| IMPORT_C TInt | IsRequestedField | ( | TPositionFieldId | aFieldId | ) | const |
| TPositionFieldId aFieldId |
| IMPORT_C HPositionGenericInfo * | New | ( | TInt | aBufferSize = KPositionGenericInfoDefaultBufferSize , |
| TInt | aMaxFields = KPositionGenericInfoDefaultMaxFields | |||
| ) | [static] | |||
| TInt aBufferSize = KPositionGenericInfoDefaultBufferSize | |
| TInt aMaxFields = KPositionGenericInfoDefaultMaxFields |
| IMPORT_C HPositionGenericInfo * | NewL | ( | TInt | aBufferSize = KPositionGenericInfoDefaultBufferSize , |
| TInt | aMaxFields = KPositionGenericInfoDefaultMaxFields | |||
| ) | [static] | |||
| TInt aBufferSize = KPositionGenericInfoDefaultBufferSize | |
| TInt aMaxFields = KPositionGenericInfoDefaultMaxFields |
| IMPORT_C HPositionGenericInfo * | NewLC | ( | TInt | aBufferSize = KPositionGenericInfoDefaultBufferSize , |
| TInt | aMaxFields = KPositionGenericInfoDefaultMaxFields | |||
| ) | [static] | |||
| TInt aBufferSize = KPositionGenericInfoDefaultBufferSize | |
| TInt aMaxFields = KPositionGenericInfoDefaultMaxFields |
| IMPORT_C TPositionFieldId | NextRequestedFieldId | ( | TPositionFieldId | aFieldId | ) | const |
| TPositionFieldId aFieldId |
| TPositionFieldId * | RequestedFieldPtr | ( | ) | [private, inline] |
Helper method. For internal usage only
| const TPositionFieldId * | RequestedFieldPtr | ( | ) | const [private, inline] |
Helper method. For internal usage only
| IMPORT_C TInt | SetRequestedField | ( | TPositionFieldId | aFieldId | ) |
| TPositionFieldId aFieldId |
| IMPORT_C TInt | SetRequestedFields | ( | const TPositionFieldIdList | aFieldIdList | ) |
| const TPositionFieldIdList aFieldIdList |
| TInt | SetValue | ( | TPositionFieldId | aFieldId, |
| const TType & | aValue | |||
| ) | [inline] | |||
Used to store position information. a symbian OS error code.
KErrNone on successful operation.
KErrPositionBufferOverflow if the data contained in the parameter aValue cannot be added to the class due to the buffer being too small.
| TPositionFieldId aFieldId | Standard position field identifier. See _TPositionFieldId |
| const TType & aValue | The parameter aValue can be of the type TInt8, TInt16, TInt32, TInt64, TUint8, TUint16, TUint32, TReal32, TReal64, TTime, TTimeIntervalMicroSeconds, Des8, or Des16. |
| HPositionGenericInfo & | operator= | ( | const HPositionGenericInfo & | ) | [private] |
internal private method
| const HPositionGenericInfo & |
| TUint8 | iBuffer | [private] |
Start of the buffer. The heap cell allocated for an instance of this class has space for information up to iBuffer[iTotalBufferSize-1]
| const TUint | iDataStartPoint | [private] |
Offset into iBuffer of the actual location data.
| const TUint | iFieldIndexStartPoint | [private] |
Offset into iBuffer of the field index.