epoc32/include/sensrvmagneticnorthsensor.h
branchSymbian2
changeset 2 2fe1408b6811
parent 0 061f57f2323e
child 4 837f303aceeb
     1.1 --- a/epoc32/include/sensrvmagneticnorthsensor.h	Tue Nov 24 13:55:44 2009 +0000
     1.2 +++ b/epoc32/include/sensrvmagneticnorthsensor.h	Tue Mar 16 16:12:26 2010 +0000
     1.3 @@ -1,1 +1,82 @@
     1.4 -sensrvmagneticnorthsensor.h
     1.5 +/*
     1.6 +* Copyright (c) 2008 Nokia Corporation and/or its subsidiary(-ies). 
     1.7 +* All rights reserved.
     1.8 +* This component and the accompanying materials are made available
     1.9 +* 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
    1.10 +* which accompanies this distribution, and is available
    1.11 +* at the URL "http://www.symbianfoundation.org/legal/licencesv10.html".
    1.12 +*
    1.13 +* Initial Contributors:
    1.14 +* Nokia Corporation - initial contribution.
    1.15 +*
    1.16 +* Contributors:
    1.17 +*
    1.18 +* Description:  Channel data types definitions
    1.19 +*
    1.20 +*/
    1.21 +
    1.22 +
    1.23 +
    1.24 +#ifndef MAGNETICNORTHSENSOR_H
    1.25 +#define MAGNETICNORTHSENSOR_H
    1.26 +
    1.27 +//  INCLUDES
    1.28 +#include <e32base.h>
    1.29 +#include <sensrvtypes.h> 
    1.30 +
    1.31 +// TILT RELATED CHANNELS
    1.32 +
    1.33 +/**
    1.34 +* - Name:          Magnetic north channel data
    1.35 +* - Type:          Event
    1.36 +* - Datatype:      TSensrvMagneticNorthData
    1.37 +* - Description:   The magnetic north data describes the angle between the
    1.38 +*                  device and magnetic north.
    1.39 +*/
    1.40 +const TSensrvChannelTypeId KSensrvChannelTypeIdMagneticNorthData = 0x2000BEDF;
    1.41 +
    1.42 +
    1.43 +// TILT RELATED DATATYPES
    1.44 +
    1.45 +/**
    1.46 +* Tilt angel data type
    1.47 +*/
    1.48 +class TSensrvMagneticNorthData
    1.49 +    {
    1.50 +public:
    1.51 +    /**
    1.52 +    * Channel data type Id number
    1.53 +    */      
    1.54 +    static const TSensrvChannelDataTypeId KDataTypeId = 0x2000BEDF;
    1.55 +
    1.56 +    /**
    1.57 +    * Channel data type index numbers
    1.58 +    */
    1.59 +    enum TSensrvMagneticNorthDataIndexes
    1.60 +        {
    1.61 +        ETimeStamp = 0,
    1.62 +        EAngleFromMagneticNorth
    1.63 +        };
    1.64 +
    1.65 +public:
    1.66 +
    1.67 +    /**
    1.68 +    * - Item name:   Sampling time.
    1.69 +    * - Item Index:  0
    1.70 +    * - Conditions:  None
    1.71 +    * - Description: Timestamp for a sample.
    1.72 +    */   
    1.73 +    TTime iTimeStamp;    
    1.74 +
    1.75 +    /**
    1.76 +    * - Item name:   Tilt angle
    1.77 +    * - Item Index:  1
    1.78 +    * - Conditions:  Single limit and range 
    1.79 +    * - Description: The angle between the magnetic north and the device heading.
    1.80 +    */
    1.81 +    TInt iAngleFromMagneticNorth;  
    1.82 +    };
    1.83 +
    1.84 +#endif //MAGNETICNORTHSENSOR_H
    1.85 +
    1.86 +// End of File