epoc32/include/sensrvmagneticnorthsensor.h
branchSymbian2
changeset 2 2fe1408b6811
parent 0 061f57f2323e
child 4 837f303aceeb
--- a/epoc32/include/sensrvmagneticnorthsensor.h	Tue Nov 24 13:55:44 2009 +0000
+++ b/epoc32/include/sensrvmagneticnorthsensor.h	Tue Mar 16 16:12:26 2010 +0000
@@ -1,1 +1,82 @@
-sensrvmagneticnorthsensor.h
+/*
+* Copyright (c) 2008 Nokia Corporation and/or its subsidiary(-ies). 
+* All rights reserved.
+* This component and the accompanying materials are made available
+* under the terms of the License "Symbian Foundation License v1.0" to Symbian Foundation members and "Symbian Foundation End User License Agreement v1.0" to non-members
+* which accompanies this distribution, and is available
+* at the URL "http://www.symbianfoundation.org/legal/licencesv10.html".
+*
+* Initial Contributors:
+* Nokia Corporation - initial contribution.
+*
+* Contributors:
+*
+* Description:  Channel data types definitions
+*
+*/
+
+
+
+#ifndef MAGNETICNORTHSENSOR_H
+#define MAGNETICNORTHSENSOR_H
+
+//  INCLUDES
+#include <e32base.h>
+#include <sensrvtypes.h> 
+
+// TILT RELATED CHANNELS
+
+/**
+* - Name:          Magnetic north channel data
+* - Type:          Event
+* - Datatype:      TSensrvMagneticNorthData
+* - Description:   The magnetic north data describes the angle between the
+*                  device and magnetic north.
+*/
+const TSensrvChannelTypeId KSensrvChannelTypeIdMagneticNorthData = 0x2000BEDF;
+
+
+// TILT RELATED DATATYPES
+
+/**
+* Tilt angel data type
+*/
+class TSensrvMagneticNorthData
+    {
+public:
+    /**
+    * Channel data type Id number
+    */      
+    static const TSensrvChannelDataTypeId KDataTypeId = 0x2000BEDF;
+
+    /**
+    * Channel data type index numbers
+    */
+    enum TSensrvMagneticNorthDataIndexes
+        {
+        ETimeStamp = 0,
+        EAngleFromMagneticNorth
+        };
+
+public:
+
+    /**
+    * - Item name:   Sampling time.
+    * - Item Index:  0
+    * - Conditions:  None
+    * - Description: Timestamp for a sample.
+    */   
+    TTime iTimeStamp;    
+
+    /**
+    * - Item name:   Tilt angle
+    * - Item Index:  1
+    * - Conditions:  Single limit and range 
+    * - Description: The angle between the magnetic north and the device heading.
+    */
+    TInt iAngleFromMagneticNorth;  
+    };
+
+#endif //MAGNETICNORTHSENSOR_H
+
+// End of File