1 sensrvmagneticnorthsensor.h

     1 /*

     2 * Copyright (c) 2008 Nokia Corporation and/or its subsidiary(-ies). 

     3 * All rights reserved.

     4 * This component and the accompanying materials are made available

     5 * 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

     6 * which accompanies this distribution, and is available

     7 * at the URL "http://www.symbianfoundation.org/legal/licencesv10.html".

     8 *

     9 * Initial Contributors:

    10 * Nokia Corporation - initial contribution.

    11 *

    12 * Contributors:

    13 *

    14 * Description:  Channel data types definitions

    15 *

    16 */

    17 

    18 

    19 

    20 #ifndef MAGNETICNORTHSENSOR_H

    21 #define MAGNETICNORTHSENSOR_H

    22 

    23 //  INCLUDES

    24 #include <e32base.h>

    25 #include <sensrvtypes.h> 

    26 

    27 // TILT RELATED CHANNELS

    28 

    29 /**

    30 * - Name:          Magnetic north channel data

    31 * - Type:          Event

    32 * - Datatype:      TSensrvMagneticNorthData

    33 * - Description:   The magnetic north data describes the angle between the

    34 *                  device and magnetic north.

    35 */

    36 const TSensrvChannelTypeId KSensrvChannelTypeIdMagneticNorthData = 0x2000BEDF;

    37 

    38 

    39 // TILT RELATED DATATYPES

    40 

    41 /**

    42 * Tilt angel data type

    43 */

    44 class TSensrvMagneticNorthData

    45     {

    46 public:

    47     /**

    48     * Channel data type Id number

    49     */      

    50     static const TSensrvChannelDataTypeId KDataTypeId = 0x2000BEDF;

    51 

    52     /**

    53     * Channel data type index numbers

    54     */

    55     enum TSensrvMagneticNorthDataIndexes

    56         {

    57         ETimeStamp = 0,

    58         EAngleFromMagneticNorth

    59         };

    60 

    61 public:

    62 

    63     /**

    64     * - Item name:   Sampling time.

    65     * - Item Index:  0

    66     * - Conditions:  None

    67     * - Description: Timestamp for a sample.

    68     */   

    69     TTime iTimeStamp;    

    70 

    71     /**

    72     * - Item name:   Tilt angle

    73     * - Item Index:  1

    74     * - Conditions:  Single limit and range 

    75     * - Description: The angle between the magnetic north and the device heading.

    76     */

    77     TInt iAngleFromMagneticNorth;  

    78     };

    79 

    80 #endif //MAGNETICNORTHSENSOR_H

    81 

    82 // End of File