epoc32/include/sensrvmagneticnorthsensor.h
author William Roberts <williamr@symbian.org>
Tue, 16 Mar 2010 16:12:26 +0000
branchSymbian2
changeset 2 2fe1408b6811
parent 0 061f57f2323e
child 4 837f303aceeb
permissions -rw-r--r--
Final list of Symbian^2 public API header files
williamr@2
     1
/*
williamr@2
     2
* Copyright (c) 2008 Nokia Corporation and/or its subsidiary(-ies). 
williamr@2
     3
* All rights reserved.
williamr@2
     4
* This component and the accompanying materials are made available
williamr@2
     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
williamr@2
     6
* which accompanies this distribution, and is available
williamr@2
     7
* at the URL "http://www.symbianfoundation.org/legal/licencesv10.html".
williamr@2
     8
*
williamr@2
     9
* Initial Contributors:
williamr@2
    10
* Nokia Corporation - initial contribution.
williamr@2
    11
*
williamr@2
    12
* Contributors:
williamr@2
    13
*
williamr@2
    14
* Description:  Channel data types definitions
williamr@2
    15
*
williamr@2
    16
*/
williamr@2
    17
williamr@2
    18
williamr@2
    19
williamr@2
    20
#ifndef MAGNETICNORTHSENSOR_H
williamr@2
    21
#define MAGNETICNORTHSENSOR_H
williamr@2
    22
williamr@2
    23
//  INCLUDES
williamr@2
    24
#include <e32base.h>
williamr@2
    25
#include <sensrvtypes.h> 
williamr@2
    26
williamr@2
    27
// TILT RELATED CHANNELS
williamr@2
    28
williamr@2
    29
/**
williamr@2
    30
* - Name:          Magnetic north channel data
williamr@2
    31
* - Type:          Event
williamr@2
    32
* - Datatype:      TSensrvMagneticNorthData
williamr@2
    33
* - Description:   The magnetic north data describes the angle between the
williamr@2
    34
*                  device and magnetic north.
williamr@2
    35
*/
williamr@2
    36
const TSensrvChannelTypeId KSensrvChannelTypeIdMagneticNorthData = 0x2000BEDF;
williamr@2
    37
williamr@2
    38
williamr@2
    39
// TILT RELATED DATATYPES
williamr@2
    40
williamr@2
    41
/**
williamr@2
    42
* Tilt angel data type
williamr@2
    43
*/
williamr@2
    44
class TSensrvMagneticNorthData
williamr@2
    45
    {
williamr@2
    46
public:
williamr@2
    47
    /**
williamr@2
    48
    * Channel data type Id number
williamr@2
    49
    */      
williamr@2
    50
    static const TSensrvChannelDataTypeId KDataTypeId = 0x2000BEDF;
williamr@2
    51
williamr@2
    52
    /**
williamr@2
    53
    * Channel data type index numbers
williamr@2
    54
    */
williamr@2
    55
    enum TSensrvMagneticNorthDataIndexes
williamr@2
    56
        {
williamr@2
    57
        ETimeStamp = 0,
williamr@2
    58
        EAngleFromMagneticNorth
williamr@2
    59
        };
williamr@2
    60
williamr@2
    61
public:
williamr@2
    62
williamr@2
    63
    /**
williamr@2
    64
    * - Item name:   Sampling time.
williamr@2
    65
    * - Item Index:  0
williamr@2
    66
    * - Conditions:  None
williamr@2
    67
    * - Description: Timestamp for a sample.
williamr@2
    68
    */   
williamr@2
    69
    TTime iTimeStamp;    
williamr@2
    70
williamr@2
    71
    /**
williamr@2
    72
    * - Item name:   Tilt angle
williamr@2
    73
    * - Item Index:  1
williamr@2
    74
    * - Conditions:  Single limit and range 
williamr@2
    75
    * - Description: The angle between the magnetic north and the device heading.
williamr@2
    76
    */
williamr@2
    77
    TInt iAngleFromMagneticNorth;  
williamr@2
    78
    };
williamr@2
    79
williamr@2
    80
#endif //MAGNETICNORTHSENSOR_H
williamr@2
    81
williamr@2
    82
// End of File