epoc32/include/sensrvaccelerometersensor.h
author William Roberts <williamr@symbian.org>
Wed, 31 Mar 2010 12:33:34 +0100
branchSymbian3
changeset 4 837f303aceeb
parent 2 2fe1408b6811
permissions -rw-r--r--
Current Symbian^3 public API header files (from PDK 3.0.h)
This is the epoc32/include tree with the "platform" subtrees removed, and
all but a selected few mbg and rsg files removed.
     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 "Eclipse Public License v1.0"
     6 * which accompanies this distribution, and is available
     7 * at the URL "http://www.eclipse.org/legal/epl-v10.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 SENSRVACCELEROMETERSENSOR_H
    21 #define SENSRVACCELEROMETERSENSOR_H
    22 
    23 //  INCLUDES
    24 #include <e32base.h>
    25 #include <sensrvtypes.h> 
    26 
    27 // ACCELEROMETER RELATED CHANNELS 
    28 
    29 /**
    30 * - Name:          Accelerometer XYZ-axis data channel type
    31 * - Type:          Rawdata
    32 * - Datatype:      TSensrvAccelerometerAxisData
    33 * - Description:   Accelerometer x-, y-, z-axis data  
    34 */
    35 const TSensrvChannelTypeId KSensrvChannelTypeIdAccelerometerXYZAxisData = 0x1020507E;
    36 
    37 // ACCELEROMETER RELATED PROPERTIES
    38 
    39 /**
    40 * - Name:         Axis active
    41 * - Type:         TInt 
    42 * - Scope:        Channel item property
    43 * - Mandatory:    No
    44 * - Capability:   None
    45 * - Description:  Indicates is sensor axis activated.
    46 *                 Value is one if the axis is activated, zero otherwise.
    47 */
    48 const TSensrvPropertyId KSensrvPropIdAxisActive = 0x00001001;
    49 
    50 // ACCELEROMETER RELATED DATATYPES
    51 
    52 /**
    53 * Accelerometer axis data type
    54 */
    55 class TSensrvAccelerometerAxisData 
    56     {
    57 public:
    58     /**
    59     * Channel data type Id number
    60     */      
    61     static const TSensrvChannelDataTypeId KDataTypeId = 0x1020507E;
    62 
    63     /**
    64      * Channel data type index numbers
    65      */
    66 	enum TSensrvAccelerometerAxisDataIndexes
    67           {
    68            ETimeStamp = 0,
    69            EAxisX,
    70            EAxisY,
    71            EAxisZ
    72           }; 
    73 
    74 public:
    75     /**
    76     * - Item name:   Sampling time.
    77     * - Item Index:  0
    78     * - Conditions:  None
    79     * - Description: Timestamp for a sample.
    80     */   
    81     TTime iTimeStamp;    
    82 
    83     /**
    84     * - Item name:   Accelerometer x-axis 
    85     * - Item Index:  1
    86     * - Conditions:  Single limit and range 
    87     * - Description: Accelerometer values from x-axis 
    88     */
    89     TInt iAxisX;  
    90 
    91     /**
    92     * - Item name:   Accelerometer y-axis 
    93     * - Item Index:  2
    94     * - Conditions:  Single limit and range 
    95     * - Description: Accelerometer values from y-axis 
    96     */ 
    97     TInt iAxisY;  
    98 
    99     /**
   100     * - Item name:   Accelerometer z-axis 
   101     * - Item Index:  3
   102     * - Conditions:  Single limit and range 
   103     * - Description: Accelerometer values from z-axis 
   104     */
   105     TInt iAxisZ;  
   106     };
   107 
   108 #endif //SENSRVACCELEROMETERSENSOR_H
   109 
   110 // End of File