sensrvproperty.h

00001 /*
00002 * ==============================================================================
00003 *  Name        : sensrvproperty.h
00004 *  Interface   : Sensor Channel API
00005 *  Description : Sensor and channel property container
00006 *  Version     : %version: 2.1.1 %
00007 *
00008 *  Copyright © 2008 Nokia.  All rights reserved.
00009 *  This material, including documentation and any related computer
00010 *  programs, is protected by copyright controlled by Nokia.  All
00011 *  rights are reserved.  Copying, including reproducing, storing,
00012 *  adapting or translating, any or all of this material requires the
00013 *  prior written consent of Nokia.  This material also contains
00014 *  confidential information which may not be disclosed to others
00015 *  without the prior written consent of Nokia.
00016 * ============================================================================
00017 * Template version: 4.1
00018 */
00021 #ifndef SENSRVPROPERTY_H
00022 #define SENSRVPROPERTY_H
00023 
00024 //  INCLUDES
00025 #include <e32base.h>
00026 #include <babitflags.h>
00028 // CONSTANTS
00034 const TInt KSensrvPropertyTextBufferSize = 20;
00037 // DATA TYPES
00043 enum TSensrvPropertyType
00044     {
ESensrvUninitializedProperty = 0,
ESensrvIntProperty,
ESensrvRealProperty,
ESensrvBufferProperty
00056     };
00063 enum TSensrvArrayIndex
00064     {
ESensrvSingleProperty    = -1,
ESensrvArrayPropertyInfo = -2
00072     };
00084 enum TSensrvPropertyRangeUsage
00085     {
00086     // General properties
ESensrvPropertyRangeNotDefined = 0, // 0x0000
ESensrvGeneralPropertyRangeBase = 1, // 0x0001
ESensrvGeneralPropertyRangeEnd = 4095, // 0x0FFF
00091     // Channel properties
ESensrvChannelPropertyRangeBase = 4096, // 0x1000
ESensrvChannelPropertyRangeEnd = 8191, // 0x1FFF
00095     // A range for licensees to define their own properties. Usage is defined by the licensee. 
ESensrvLicenseePropertyRangeBase = 8192, // 0x2000
ESensrvLicenseePropertyRangeEnd = 12287 // 0x2FFF
00098     };
00104 typedef TUint32 TSensrvPropertyId;
00106 // CLASS DECLARATION
00279 NONSHARABLE_CLASS( TSensrvProperty )
00280     {
00281 public:
00286     IMPORT_C TSensrvProperty();
00300     IMPORT_C TSensrvProperty( const TSensrvPropertyId aPropertyId,
00301                               const TInt aItemIndex,
00302                               const TInt aValue,
00303                               const TInt aMaxValue,
00304                               const TInt aMinValue,
00305                               const TBool aReadOnly,
00306                               const TSensrvPropertyType aPropertyType );
00316     IMPORT_C TSensrvProperty( const TSensrvPropertyId aPropertyId,
00317                               const TInt aItemIndex,
00318                               const TInt aValue );
00332     IMPORT_C TSensrvProperty( const TSensrvPropertyId aPropertyId,
00333                               const TInt aItemIndex,
00334                               const TReal aValue,
00335                               const TReal aMaxValue,
00336                               const TReal aMinValue,
00337                               const TBool aReadOnly,
00338                               const TSensrvPropertyType aPropertyType );
00348     IMPORT_C TSensrvProperty( const TSensrvPropertyId aPropertyId,
00349                               const TInt aItemIndex,
00350                               const TReal aValue );
00362     IMPORT_C TSensrvProperty( const TSensrvPropertyId aPropertyId,
00363                               const TInt aItemIndex,
00364                               const TDesC8& aValue,
00365                               const TBool aReadOnly,
00366                               const TSensrvPropertyType aPropertyType );
00376     IMPORT_C TSensrvProperty( const TSensrvPropertyId aPropertyId,
00377                               const TInt aItemIndex,
00378                               const TDesC8& aValue );
00386     IMPORT_C void SetPropertyId( TSensrvPropertyId aPropertyId );
00394     IMPORT_C TSensrvPropertyId GetPropertyId() const;
00402     IMPORT_C void SetItemIndex( TInt aItemIndex );
00410     IMPORT_C TInt PropertyItemIndex() const;
00418     IMPORT_C TSensrvPropertyType PropertyType() const;
00426     IMPORT_C TBool ReadOnly() const;
00434     IMPORT_C void SetReadOnly( TBool aReadOnly );
00444     IMPORT_C void SetValue( const TInt aValue );
00454     IMPORT_C void SetValue( const TReal aValue );
00464     IMPORT_C void SetValue( const TDesC8& aValue );
00474     IMPORT_C void GetValue( TInt& aValue ) const;
00484     IMPORT_C void GetValue( TReal& aValue ) const;
00494     IMPORT_C void GetValue( TDes8& aValue ) const;
00504     IMPORT_C TDes8& GetValueRef();
00514     IMPORT_C void GetMaxValue( TInt& aMaxValue ) const;
00524     IMPORT_C void GetMinValue( TInt& aMinValue ) const;
00534     IMPORT_C void SetMaxValue( TInt aMaxValue );
00544     IMPORT_C void SetMinValue( TInt aMinValue );
00554     IMPORT_C void GetMaxValue( TReal& aMaxValue ) const;
00564     IMPORT_C void GetMinValue( TReal& aMinValue ) const;
00574     IMPORT_C void SetMaxValue( const TReal& aMaxValue );
00584     IMPORT_C void SetMinValue( const TReal& aMinValue );
00592     IMPORT_C void SetSecurityInfo( const TSecurityInfo& aSecurityInfo );
00600     IMPORT_C TSecurityInfo GetSecurityInfo() const;
00610     IMPORT_C void SetArrayIndex( const TInt aArrayIndex );
00620     IMPORT_C TInt GetArrayIndex() const;
00622 private:
00623     // property identifier
TSensrvPropertyId iPropertyId;
00626     // property item index
00627     TInt iItemIndex;
00629     //Array index
00630     TInt16 iArrayIndex;
00633     // property value
00634     union
00635         {
00636         TInt iIntValue;
00637         TReal iRealValue;
00638         };
00639     TBuf8<KSensrvPropertyTextBufferSize> iBufValue;
00641     // read only flag
00642     TBitFlags32 iReadOnly;
00644     // maximum value
00645     union
00646         {
00647         TInt iIntValueMax;
00648         TReal iRealValueMax;
00649         };
00651     // minimum value
00652     union
00653         {
00654         TInt iIntValueMin;
00655         TReal iRealValueMin;
00656         };
00658     // property type
TSensrvPropertyType iPropertyType;
00661     // property security infomation
00662     TSecurityInfo iSecurityInfo;
00664     // not used
00665     TInt iReserved;
00666     };
00668 #endif //SENSRVPROPERTY_H
00669 
00670 // End of File