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.
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@4
     5
* under the terms of "Eclipse Public License v1.0"
williamr@2
     6
* which accompanies this distribution, and is available
williamr@4
     7
* at the URL "http://www.eclipse.org/legal/epl-v10.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 SENSRVACCELEROMETERSENSOR_H
williamr@2
    21
#define SENSRVACCELEROMETERSENSOR_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
// ACCELEROMETER RELATED CHANNELS 
williamr@2
    28
williamr@2
    29
/**
williamr@2
    30
* - Name:          Accelerometer XYZ-axis data channel type
williamr@2
    31
* - Type:          Rawdata
williamr@2
    32
* - Datatype:      TSensrvAccelerometerAxisData
williamr@2
    33
* - Description:   Accelerometer x-, y-, z-axis data  
williamr@2
    34
*/
williamr@2
    35
const TSensrvChannelTypeId KSensrvChannelTypeIdAccelerometerXYZAxisData = 0x1020507E;
williamr@2
    36
williamr@2
    37
// ACCELEROMETER RELATED PROPERTIES
williamr@2
    38
williamr@2
    39
/**
williamr@2
    40
* - Name:         Axis active
williamr@2
    41
* - Type:         TInt 
williamr@2
    42
* - Scope:        Channel item property
williamr@2
    43
* - Mandatory:    No
williamr@2
    44
* - Capability:   None
williamr@2
    45
* - Description:  Indicates is sensor axis activated.
williamr@2
    46
*                 Value is one if the axis is activated, zero otherwise.
williamr@2
    47
*/
williamr@2
    48
const TSensrvPropertyId KSensrvPropIdAxisActive = 0x00001001;
williamr@2
    49
williamr@2
    50
// ACCELEROMETER RELATED DATATYPES
williamr@2
    51
williamr@2
    52
/**
williamr@2
    53
* Accelerometer axis data type
williamr@2
    54
*/
williamr@2
    55
class TSensrvAccelerometerAxisData 
williamr@2
    56
    {
williamr@2
    57
public:
williamr@2
    58
    /**
williamr@2
    59
    * Channel data type Id number
williamr@2
    60
    */      
williamr@2
    61
    static const TSensrvChannelDataTypeId KDataTypeId = 0x1020507E;
williamr@2
    62
williamr@2
    63
    /**
williamr@2
    64
     * Channel data type index numbers
williamr@2
    65
     */
williamr@2
    66
	enum TSensrvAccelerometerAxisDataIndexes
williamr@2
    67
          {
williamr@2
    68
           ETimeStamp = 0,
williamr@2
    69
           EAxisX,
williamr@2
    70
           EAxisY,
williamr@2
    71
           EAxisZ
williamr@2
    72
          }; 
williamr@2
    73
williamr@2
    74
public:
williamr@2
    75
    /**
williamr@2
    76
    * - Item name:   Sampling time.
williamr@2
    77
    * - Item Index:  0
williamr@2
    78
    * - Conditions:  None
williamr@2
    79
    * - Description: Timestamp for a sample.
williamr@2
    80
    */   
williamr@2
    81
    TTime iTimeStamp;    
williamr@2
    82
williamr@2
    83
    /**
williamr@2
    84
    * - Item name:   Accelerometer x-axis 
williamr@2
    85
    * - Item Index:  1
williamr@2
    86
    * - Conditions:  Single limit and range 
williamr@2
    87
    * - Description: Accelerometer values from x-axis 
williamr@2
    88
    */
williamr@2
    89
    TInt iAxisX;  
williamr@2
    90
williamr@2
    91
    /**
williamr@2
    92
    * - Item name:   Accelerometer y-axis 
williamr@2
    93
    * - Item Index:  2
williamr@2
    94
    * - Conditions:  Single limit and range 
williamr@2
    95
    * - Description: Accelerometer values from y-axis 
williamr@2
    96
    */ 
williamr@2
    97
    TInt iAxisY;  
williamr@2
    98
williamr@2
    99
    /**
williamr@2
   100
    * - Item name:   Accelerometer z-axis 
williamr@2
   101
    * - Item Index:  3
williamr@2
   102
    * - Conditions:  Single limit and range 
williamr@2
   103
    * - Description: Accelerometer values from z-axis 
williamr@2
   104
    */
williamr@2
   105
    TInt iAxisZ;  
williamr@2
   106
    };
williamr@2
   107
williamr@2
   108
#endif //SENSRVACCELEROMETERSENSOR_H
williamr@2
   109
williamr@2
   110
// End of File