epoc32/include/sensrvtappingsensor.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 SENSRVTAPPINGSENSOR_H
williamr@2
    21
#define SENSRVTAPPINGSENSOR_H
williamr@2
    22
williamr@2
    23
//  INCLUDES
williamr@2
    24
#include <e32base.h>
williamr@2
    25
#include <sensrvtypes.h> 
williamr@2
    26
#include <sensrvaccelerometersensor.h>
williamr@2
    27
williamr@2
    28
// TAPPING RELATED CHANNELS 
williamr@2
    29
williamr@2
    30
/**
williamr@2
    31
* - Name:          Double tapping event channel type
williamr@2
    32
* - Type:          Event
williamr@2
    33
* - Datatype:      TSensrvTappingData
williamr@2
    34
* - Description:   Double tapping events 
williamr@2
    35
*/
williamr@2
    36
const TSensrvChannelTypeId KSensrvChannelTypeIdAccelerometerDoubleTappingData = 0x10205081;
williamr@2
    37
williamr@2
    38
// TAPPING RELATED PROPERTIES
williamr@2
    39
williamr@2
    40
/**
williamr@2
    41
* - Name:         Double tapping axis active
williamr@2
    42
* - Type:         TInt 
williamr@2
    43
* - Scope:        Channel item property
williamr@2
    44
* - Mandatory:    No
williamr@2
    45
* - Capability:   None
williamr@2
    46
* - Description:  Indicates is sensor axis activated.
williamr@2
    47
*                 Value is one if the axis is activated, zero otherwise.
williamr@2
    48
*/
williamr@2
    49
const TSensrvPropertyId KSensrvPropIdDblTapAxisActive = KSensrvPropIdAxisActive;
williamr@2
    50
williamr@2
    51
/**
williamr@2
    52
* - Name:         Double tap duration threshold
williamr@2
    53
* - Type:         TInt
williamr@2
    54
* - Scope:        Channel property
williamr@2
    55
* - Mandatory:    No
williamr@2
    56
* - Capability:   ReadDeviceData, WriteDeviceData
williamr@2
    57
* - Description:  Threshold as an offset of the selected range.
williamr@2
    58
*/
williamr@2
    59
const TSensrvPropertyId KSensrvPropIdDblTapThreshold = 0x00001002;
williamr@2
    60
williamr@2
    61
/**
williamr@2
    62
* - Name:         Double tap duration in milliseconds
williamr@2
    63
* - Type:         TInt
williamr@2
    64
* - Scope:        Channel property
williamr@2
    65
* - Mandatory:    No
williamr@2
    66
* - Capability:   None
williamr@2
    67
* - Description:  Scalar Integer representing the duration of the tap value.
williamr@2
    68
*                 Not dependent upon ODR.
williamr@2
    69
*/
williamr@2
    70
const TSensrvPropertyId KSensrvPropIdDblTapDuration = 0x00001003;
williamr@2
    71
williamr@2
    72
/**
williamr@2
    73
* - Name:         Double tap latency 
williamr@2
    74
* - Type:         TInt
williamr@2
    75
* - Scope:        Channel property
williamr@2
    76
* - Mandatory:    No
williamr@2
    77
* - Capability:   None
williamr@2
    78
* - Description:  Double tap latency in milliseconds
williamr@2
    79
*/
williamr@2
    80
const TSensrvPropertyId KSensrvPropIdDblTapLatency = 0x00001004;
williamr@2
    81
williamr@2
    82
/**
williamr@2
    83
* - Name:         Double tap interval
williamr@2
    84
* - Type:         TInt
williamr@2
    85
* - Scope:        Channel property
williamr@2
    86
* - Mandatory:    No
williamr@2
    87
* - Capability:   None
williamr@2
    88
* - Description:  Double tap interval in milliseconds
williamr@2
    89
*/
williamr@2
    90
const TSensrvPropertyId KSensrvPropIdDblTapInterval = 0x00001005;
williamr@2
    91
williamr@2
    92
// TAPPING RELATED DATATYPES
williamr@2
    93
williamr@2
    94
/**
williamr@2
    95
* Direction of the tapping data. If direction (plus or minus) is not known, 
williamr@2
    96
* direction is, for example in x-axis case 
williamr@2
    97
* KSensrvAccelerometerDirectionXplus | KSensrvAccelerometerDirectionXminus
williamr@2
    98
*/
williamr@2
    99
const TUint8 KSensrvAccelerometerDirectionXplus 	= 0x01;
williamr@2
   100
const TUint8 KSensrvAccelerometerDirectionXminus 	= 0x02;
williamr@2
   101
const TUint8 KSensrvAccelerometerDirectionYplus 	= 0x04;
williamr@2
   102
const TUint8 KSensrvAccelerometerDirectionYminus 	= 0x08;
williamr@2
   103
const TUint8 KSensrvAccelerometerDirectionZplus 	= 0x10;
williamr@2
   104
const TUint8 KSensrvAccelerometerDirectionZminus 	= 0x20;
williamr@2
   105
williamr@2
   106
/**
williamr@2
   107
* Tapping data type
williamr@2
   108
*/
williamr@2
   109
class TSensrvTappingData 
williamr@2
   110
    {
williamr@2
   111
public:
williamr@2
   112
    /**
williamr@2
   113
    * Channel data type Id number
williamr@2
   114
    */      
williamr@2
   115
    static const TSensrvChannelDataTypeId KDataTypeId = 0x1020507F;
williamr@2
   116
williamr@2
   117
	/**
williamr@2
   118
    * Channel data type index numbers
williamr@2
   119
    */
williamr@2
   120
	enum TSensrvAccelerometerAxisDataIndexes
williamr@2
   121
          {
williamr@2
   122
          ETimeStamp = 0,
williamr@2
   123
          EDirection
williamr@2
   124
          };
williamr@2
   125
williamr@2
   126
public:
williamr@2
   127
    /**
williamr@2
   128
    * - Item name:   Sampling time.
williamr@2
   129
    * - Item Index:  0
williamr@2
   130
    * - Conditions:  None
williamr@2
   131
    * - Description: Timestamp for a sample.
williamr@2
   132
    */   
williamr@2
   133
    TTime iTimeStamp;    
williamr@2
   134
    
williamr@2
   135
    /**
williamr@2
   136
    * - Item name:   Tapping direction bitmask
williamr@2
   137
    * - Item Index:  1
williamr@2
   138
    * - Conditions:  Binary
williamr@2
   139
    * - Description: Direction bitmask of the tapping event. 
williamr@2
   140
    *                See constant definitions above.
williamr@2
   141
    */
williamr@2
   142
    TUint32 iDirection;  
williamr@2
   143
    };
williamr@2
   144
williamr@2
   145
#endif //SENSRVTAPPINGSENSOR_H
williamr@2
   146
williamr@2
   147
// End of File