/*

* Copyright (c) 2005-2009 Nokia Corporation and/or its subsidiary(-ies).

* All rights reserved.

* This component and the accompanying materials are made available

* which accompanies this distribution, and is available

*

* Initial Contributors:

* Nokia Corporation - initial contribution.

*

* Contributors:

*

* Description:

* Name        : LbsFields.h

* Part of     : Mobile Location Framework/Location FW

* Interface   : Location Acquisition API

* Position data Fields manager

* Version     :

*

*/

#ifndef __LBSFIELDS_H__

#define __LBSFIELDS_H__

#include <e32std.h>

#include <lbsfieldids.h>

/*

 * This header file defines the helper classes used by HPositionGenericInfo

 * The client should not use this class to access any positioning related information.

 * Instead the cleitn should use the methods provided by HGenericPositionInfo.

 */

/**

 * Standard position field identifiers. It takes one of the enumerated  values of _TPositionFieldId

 * @publishedAll

 * @released

*/

typedef TUint16 TPositionFieldId;

/**

 * Array of standard position field identifiers

 * @publishedAll

 * @released

 */

typedef TPositionFieldId TPositionFieldIdList[];

class HPositionGenericInfo;

/**

 * This is an internal class to provide the interface for the

 * HPositionGenericInfo::GetValue() and HPositionGenericInfo::SetValue()

 * methods. Methods in this class are not intended to be called directly.

 * Clients should use HPositionGenericInfo::GetValue() and

 * HPositionGenericInfo::SetValue() methods.

 * @released

 */

class PositionFieldManager

	{

public:

	/**

	 * Supported data types

	 */

	enum TFieldType

		{

		/// Undefined data type. This value should not be used.

		EUndefined,

		/// TInt8 datatype

		ETInt8,

		/// TInt16 datatype

		ETInt16,

		/// TInt32 datatype

		ETInt32,

		/// TInt64 datatype

		ETInt64,

		/// TUint8 datatype

		ETUint8,

		/// TUint16 datatype

		ETUint16,

		/// TUint32 datatype

		ETUint32,

		/// TReal32 datatype

		ETReal32,

		/// TReal64 datatype

		ETReal64,

		/// TTime datatype

		ETTime,

		/// Time specified in microseconds

		ETTimeIntervalMicroSeconds,

		/// 8-bit descriptor datatype

		ETDesC8,

		/// 16-bit descriptor datatype

		ETDesC16

		};

friend class HPositionGenericInfo;

private:

    /**

     * Set the value for a location field of data type TInt8 in the

     * HPositionGenericInfo.

     * @param aFieldId Id of the field to be copied into the HPositionGenericInfo.

     * @param aValue Value to be copied into the HPositionGenericInfo.

     * @param aInfo The HPositionGenericInfo object where this field needs to

     * be added.

     * @return KErrArgument if aFieldId is EPositionFieldNone.

     * @return KErrPositionBufferOverflow if aValue will not fit in the HPositionGenericInfo

     * object.

     * @return KErrOverflow if there are already KPositionMaxReturnableFields set in the

     * HPositionGenericInfo object.

     * @return KErrNone if the SetValue was successful.

     */

	IMPORT_C static TInt SetValue(TPositionFieldId aFieldId,

	                              TInt8 aValue,

	                              HPositionGenericInfo& aInfo);

    /**

     * Get the value for a location field of data type TInt8 from the

     * HPositionGenericInfo.

     * @param aFieldId Id of the field for which the value should be read from

     * HPositionGenericInfo.

     * HPositionGenericInfo is returned.

     * to be read.

     * @return KErrNone is the operation was successful.

     * @return KErrNotFound if an object with aFieldId cannot be found in aInfo.

     */

	IMPORT_C static TInt GetValue(TPositionFieldId aFieldId,

	                              TInt8& aValue,

	                              const HPositionGenericInfo& aInfo);

    /**

     * Set the value for a location field of data type TInt16 in the

     * HPositionGenericInfo.

     * @param aFieldId Id of the field to be copied into the HPositionGenericInfo.

     * @param aValue Value to be copied into the HPositionGenericInfo.

     * @param aInfo The HPositionGenericInfo object where this field needs to

     * be added.

     * @return KErrArgument if aFieldId is EPositionFieldNone.

     * @return KErrPositionBufferOverflow if aValue will not fit in the HPositionGenericInfo

     * object.

     * @return KErrOverflow if there are already KPositionMaxReturnableFields set in the

     * HPositionGenericInfo object.

     * @return KErrNone if the SetValue was successful.

     */

	IMPORT_C static TInt SetValue(TPositionFieldId aFieldId,

	                              TInt16 aValue,

	                              HPositionGenericInfo& aInfo);

    /**

     * Get the value for a location field of data type TInt16 from the

     * HPositionGenericInfo.

     * @param aFieldId Id of the field for which the value should be read from

     * HPositionGenericInfo.

     * HPositionGenericInfo is returned.

     * @param aInfo The HPositionGenericInfo object from where this field needs

     * to be read.

     * @return KErrNone is the operation was successful.

     * @return KErrNotFound if an object with aFieldId cannot be found in aInfo.

     */

	IMPORT_C static TInt GetValue(TPositionFieldId aFieldId,

	                              TInt16& aValue,

	                              const HPositionGenericInfo& aInfo);

    /**

     * Set the value for a location field of data type TInt32 in the

     * HPositionGenericInfo.

     * @param aFieldId Id of the field to be copied into the HPositionGenericInfo.

     * @param aValue Value to be copied into the HPositionGenericInfo.

     * @param aInfo The HPositionGenericInfo object where this field needs to

     * be added.

     * @return KErrArgument if aFieldId is EPositionFieldNone.

     * @return KErrPositionBufferOverflow if aValue will not fit in the HPositionGenericInfo

     * object.

     * @return KErrOverflow if there are already KPositionMaxReturnableFields set in the

     * HPositionGenericInfo object.

     * @return KErrNone if the SetValue was successful.

     */

	IMPORT_C static TInt SetValue(TPositionFieldId aFieldId,

	                              TInt32 aValue,

	                              HPositionGenericInfo& aInfo);

    /**

     * Get the value for a location field of data type TInt32 from the

     * HPositionGenericInfo.

     * @param aFieldId Id of the field for which the value should be read from

     * HPositionGenericInfo.

     * HPositionGenericInfo is returned.

     * @param aInfo The HPositionGenericInfo object from where this field needs

     * to be read.

     * @return KErrNone is the operation was successful.

     * @return KErrNotFound if an object with aFieldId cannot be found in aInfo.

     */

	IMPORT_C static TInt GetValue(TPositionFieldId aFieldId,

	                              TInt32& aValue,

	                              const HPositionGenericInfo& aInfo);

    /**

     * Set the value for a location field of data type TInt64 in the

     * HPositionGenericInfo.

     * @param aFieldId Id of the field to be copied into the HPositionGenericInfo.

     * @param aValue Value to be copied into the HPositionGenericInfo.

     * @param aInfo The HPositionGenericInfo object where this field needs to

     * be added.

     * @return KErrArgument if aFieldId is EPositionFieldNone.

     * @return KErrPositionBufferOverflow if aValue will not fit in the HPositionGenericInfo

     * object.

     * @return KErrOverflow if there are already KPositionMaxReturnableFields set in the

     * HPositionGenericInfo object.

     * @return KErrNone if the SetValue was successful.

     */

	IMPORT_C static TInt SetValue(TPositionFieldId aFieldId,

	                              const TInt64& aValue,

	                              HPositionGenericInfo& aInfo);

    /**

     * Get the value for a location field of data type TInt64 from the

     * HPositionGenericInfo.

     * @param aFieldId Id of the field for which the value should be read from

     * HPositionGenericInfo.

     * HPositionGenericInfo is returned.

     * @param aInfo The HPositionGenericInfo object from where this field needs

     * to be read.

     * @return KErrNone is the operation was successful.

     * @return KErrNotFound if an object with aFieldId cannot be found in aInfo.

     */

	IMPORT_C static TInt GetValue(TPositionFieldId aFieldId,

	                              TInt64& aValue,

	                              const HPositionGenericInfo& aInfo);

    /**

     * Set the value for a location field of data type TUint8 in the

     * HPositionGenericInfo.

     * @param aFieldId Id of the field to be copied into the HPositionGenericInfo.

     * @param aValue Value to be copied into the HPositionGenericInfo.

     * @param aInfo The HPositionGenericInfo object where this field needs to

     * be added.

     * @return KErrArgument if aFieldId is EPositionFieldNone.

     * @return KErrPositionBufferOverflow if aValue will not fit in the HPositionGenericInfo

     * object.

     * @return KErrOverflow if there are already KPositionMaxReturnableFields set in the

     * HPositionGenericInfo object.

     * @return KErrNone if the SetValue was successful.

     */

	IMPORT_C static TInt SetValue(TPositionFieldId aFieldId,

	                              TUint8 aValue,

	                              HPositionGenericInfo& aInfo);

    /**

     * Get the value for a location field of data type TUint8 from the

     * HPositionGenericInfo.

     * @param aFieldId Id of the field for which the value should be read from

     * HPositionGenericInfo.

     * HPositionGenericInfo is returned.

     * @param aInfo The HPositionGenericInfo object from where this field needs

     * to be read.

     * @return KErrNone is the operation was successful.

     * @return KErrNotFound if an object with aFieldId cannot be found in aInfo.

     */

	IMPORT_C static TInt GetValue(TPositionFieldId aFieldId,

	                              TUint8& aValue,

	                              const HPositionGenericInfo& aInfo);

    /**

     * Set the value for a location field of data type TUint16 in the

     * HPositionGenericInfo.

     * @param aFieldId Id of the field to be copied into the HPositionGenericInfo.

     * @param aValue Value to be copied into the HPositionGenericInfo.

     * @param aInfo The HPositionGenericInfo object where this field needs to

     * be added.

     * @return KErrArgument if aFieldId is EPositionFieldNone.

     * @return KErrPositionBufferOverflow if aValue will not fit in the HPositionGenericInfo

     * object.

     * @return KErrOverflow if there are already KPositionMaxReturnableFields set in the

     * HPositionGenericInfo object.

     * @return KErrNone if the SetValue was successful.

     */

	IMPORT_C static TInt SetValue(TPositionFieldId aFieldId,

	                              TUint16 aValue,

	                              HPositionGenericInfo& aInfo);

    /**

     * Get the value for a location field of data type TUint16 from the

     * HPositionGenericInfo.

     * @param aFieldId Id of the field for which the value should be read from

     * HPositionGenericInfo.

     * HPositionGenericInfo is returned.

     * @param aInfo The HPositionGenericInfo object from where this field needs

     * to be read.

     * @return KErrNone is the operation was successful.

     * @return KErrNotFound if an object with aFieldId cannot be found in aInfo.

     */

	IMPORT_C static TInt GetValue(TPositionFieldId aFieldId,

	                              TUint16& aValue,

	                              const HPositionGenericInfo& aInfo);

    /**

     * Set the value for a location field of data type TUint32 in the

     * HPositionGenericInfo.

     * @param aFieldId Id of the field to be copied into the HPositionGenericInfo.

     * @param aValue Value to be copied into the HPositionGenericInfo.

     * @param aInfo The HPositionGenericInfo object where this field needs to

     * be added.

     * @return KErrArgument if aFieldId is EPositionFieldNone.

     * @return KErrPositionBufferOverflow if aValue will not fit in the HPositionGenericInfo

     * object.

     * @return KErrOverflow if there are already KPositionMaxReturnableFields set in the

     * HPositionGenericInfo object.

     * @return KErrNone if the SetValue was successful.

     */

	IMPORT_C static TInt SetValue(TPositionFieldId aFieldId,

	                              TUint32 aValue,

	                              HPositionGenericInfo& aInfo);

    /**

     * Get the value for a location field of data type TUint32 from the

     * HPositionGenericInfo.

     * @param aFieldId Id of the field for which the value should be read from

     * HPositionGenericInfo.

     * HPositionGenericInfo is returned.

     * @param aInfo The HPositionGenericInfo object from where this field needs

     * to be read.

     * @return KErrNone is the operation was successful.

     * @return KErrNotFound if an object with aFieldId cannot be found in aInfo.

     */

	IMPORT_C static TInt GetValue(TPositionFieldId aFieldId,

	                              TUint32& aValue,

	                              const HPositionGenericInfo& aInfo);

    /**

     * Set the value for a location field of data type TReal32 in the

     * HPositionGenericInfo.

     * @param aFieldId Id of the field to be copied into the HPositionGenericInfo.

     * @param aValue Value to be copied into the HPositionGenericInfo.

     * @param aInfo The HPositionGenericInfo object where this field needs to

     * be added.

     * @return KErrArgument if aFieldId is EPositionFieldNone.

     * @return KErrPositionBufferOverflow if aValue will not fit in the HPositionGenericInfo

     * object.

     * @return KErrOverflow if there are already KPositionMaxReturnableFields set in the

     * HPositionGenericInfo object.

     * @return KErrNone if the SetValue was successful.

     */

	IMPORT_C static TInt SetValue(TPositionFieldId aFieldId,

	                              TReal32 aValue,

	                              HPositionGenericInfo& aInfo);

    /**

     * Get the value for a location field of data type TReal32 from the

     * HPositionGenericInfo.

     * @param aFieldId Id of the field for which the value should be read from

     * HPositionGenericInfo.

     * HPositionGenericInfo is returned.

     * @param aInfo The HPositionGenericInfo object from where this field needs

     * to be read.

     * @return KErrNone is the operation was successful.

     * @return KErrNotFound if an object with aFieldId cannot be found in aInfo.

     */

	IMPORT_C static TInt GetValue(TPositionFieldId aFieldId,

	                              TReal32& aValue,

	                              const HPositionGenericInfo& aInfo);

    /**

     * Set the value for a location field of data type TReal64 in the

     * HPositionGenericInfo.

     * @param aFieldId Id of the field to be copied into the HPositionGenericInfo.

     * @param aValue Value to be copied into the HPositionGenericInfo.

     * @param aInfo The HPositionGenericInfo object where this field needs to

     * be added.

     * @return KErrArgument if aFieldId is EPositionFieldNone.

     * @return KErrPositionBufferOverflow if aValue will not fit in the HPositionGenericInfo

     * object.

     * @return KErrOverflow if there are already KPositionMaxReturnableFields set in the

     * HPositionGenericInfo object.

     * @return KErrNone if the SetValue was successful.

     */

	IMPORT_C static TInt SetValue(TPositionFieldId aFieldId,

	                              const TReal64& aValue,

	                              HPositionGenericInfo& aInfo);

    /**

     * Get the value for a location field of data type TReal64 from the

     * HPositionGenericInfo.

     * @param aFieldId Id of the field for which the value should be read from

     * HPositionGenericInfo.

     * HPositionGenericInfo is returned.

     * @param aInfo The HPositionGenericInfo object from where this field needs

     * to be read.

     * @return KErrNone is the operation was successful.

     * @return KErrNotFound if an object with aFieldId cannot be found in aInfo.

     */

	IMPORT_C static TInt GetValue(TPositionFieldId aFieldId,

	                              TReal64& aValue,

	                              const HPositionGenericInfo& aInfo);

    /**

     * Set the value for a location field of data type TDesC8 & TDes8 in the

     * HPositionGenericInfo.

     * @param aFieldId Id of the field to be copied into the HPositionGenericInfo.

     * @param aValue Value to be copied into the HPositionGenericInfo.

     * @param aInfo The HPositionGenericInfo object where this field needs to

     * be added.

     * @return KErrArgument if aFieldId is EPositionFieldNone.

     * @return KErrPositionBufferOverflow if aValue will not fit in the HPositionGenericInfo

     * object.

     * @return KErrOverflow if there are already KPositionMaxReturnableFields set in the

     * HPositionGenericInfo object.

     * @return KErrNone if the SetValue was successful.

     */

	IMPORT_C static TInt SetValue(TPositionFieldId aFieldId,

	                              const TDesC8& aValue,

	                              HPositionGenericInfo& aInfo);

    /**

     * Get the value for a location field of data type TDes8 from the

     * HPositionGenericInfo.

     * @param aFieldId Id of the field for which the value should be read from

     * HPositionGenericInfo.

     * HPositionGenericInfo is returned.

     * @param aInfo The HPositionGenericInfo object from where this field needs

     * to be read.

     * @return KErrNone is the operation was successful.

     * @return KErrNotFound if an object with aFieldId cannot be found in aInfo.

     */

	IMPORT_C static TInt GetValue(TPositionFieldId aFieldId,

	                              TDes8& aValue,

	                              const HPositionGenericInfo& aInfo);

    /**

     * Set the value for a location field of data type TDesC16 & TDes16 in the

     * HPositionGenericInfo.

     * @param aFieldId Id of the field to be copied into the HPositionGenericInfo.

     * @param aValue Value to be copied into the HPositionGenericInfo.

     * @param aInfo The HPositionGenericInfo object where this field needs to

     * be added.

     * @return KErrArgument if aFieldId is EPositionFieldNone.

     * @return KErrPositionBufferOverflow if aValue will not fit in the HPositionGenericInfo

     * object.

     * @return KErrOverflow if there are already KPositionMaxReturnableFields set in the

     * HPositionGenericInfo object.

     * @return KErrNone if the SetValue was successful.

     */

	IMPORT_C static TInt SetValue(TPositionFieldId aFieldId,

	                              const TDesC16& aValue,

	                              HPositionGenericInfo& aInfo);

    /**

     * Get the value for a location field of data type TDes16 from the

     * HPositionGenericInfo.

     * @param aFieldId Id of the field for which the value should be read from

     * HPositionGenericInfo.

     * HPositionGenericInfo is returned.

     * @param aInfo The HPositionGenericInfo object from where this field needs

     * to be read.

     * @return KErrNone is the operation was successful.

     * @return KErrNotFound if an object with aFieldId cannot be found in aInfo.

     */

	IMPORT_C static TInt GetValue(TPositionFieldId aFieldId,

	                              TDes16& aValue,

	                              const HPositionGenericInfo& aInfo);

    /**

     * Get the value for a location field of data type TPtrC8 from the

     * HPositionGenericInfo.

     * @param aFieldId Id of the field for which the value should be read from

     * HPositionGenericInfo.

     * HPositionGenericInfo is returned.

     * @param aInfo The HPositionGenericInfo object from where this field needs

     * to be read.

     * @return KErrNone is the operation was successful.

     * @return KErrNotFound if an object with aFieldId cannot be found in aInfo.

     */

	IMPORT_C static TInt GetValue(TPositionFieldId aFieldId,

	                              TPtrC8& aValue,

	                              const HPositionGenericInfo& aInfo);

    /**

     * Get the value for a location field of data type TPtrC16 from the

     * HPositionGenericInfo.

     * @param aFieldId Id of the field for which the value should be read from

     * HPositionGenericInfo.

     * HPositionGenericInfo is returned.

     * @param aInfo The HPositionGenericInfo object from where this field needs

     * to be read.

     * @return KErrNone is the operation was successful.

     * @return KErrNotFound if an object with aFieldId cannot be found in aInfo.

     */

	IMPORT_C static TInt GetValue(TPositionFieldId aFieldId,

	                              TPtrC16& aValue,

	                              const HPositionGenericInfo& aInfo);

    /**

     * Set the value for a location field of data type TTime in the

     * HPositionGenericInfo.

     * @param aFieldId Id of the field to be copied into the HPositionGenericInfo.

     * @param aValue Value to be copied into the HPositionGenericInfo.

     * @param aInfo The HPositionGenericInfo object where this field needs to

     * be added.

     * @return KErrArgument if aFieldId is EPositionFieldNone.

     * @return KErrPositionBufferOverflow if aValue will not fit in the HPositionGenericInfo

     * object.

     * @return KErrOverflow if there are already KPositionMaxReturnableFields set in the

     * HPositionGenericInfo object.

     * @return KErrNone if the SetValue was successful.

     */

	IMPORT_C static TInt SetValue(TPositionFieldId aFieldId,

	                              const TTime& aValue,

	                              HPositionGenericInfo& aInfo);