1 sensrvproximitysensor.h

     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 the License "Symbian Foundation License v1.0" to Symbian Foundation members and "Symbian Foundation End User License Agreement v1.0" to non-members

     6 * which accompanies this distribution, and is available

     7 * at the URL "http://www.symbianfoundation.org/legal/licencesv10.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 SENSRVPROXIMITYSENSOR_H

    21 #define SENSRVPROXIMITYSENSOR_H

    22 

    23 //  INCLUDES

    24 #include <e32base.h>

    25 #include <sensrvtypes.h> 

    26 

    27 // PROXIMITY RELATED CHANNELS

    28 

    29 /**

    30 * - Name: Proximity data channel

    31 * - Type: Event

    32 * - Datatype: TSensrvProximityMonitorData

    33 * - Description: Proximity status 

    34 */

    35 const TSensrvChannelTypeId KSensrvChannelTypeIdProximityMonitor = 0x2000E585;

    36 

    37 // PROXIMITY RELATED DATATYPES

    38 

    39 /**

    40 * Proximity monitoring data type

    41 */

    42 class TSensrvProximityData

    43 	{

    44 public:

    45 	/**

    46 	* Channel data type Id number

    47 	*/ 

    48 	static const TSensrvChannelDataTypeId KDataTypeId = 0x2000E585;

    49 

    50     /**

    51     * Channel data type index numbers

    52     */ 

    53     enum TSensrvProximityDataIndexes

    54         {

    55         ETimeStamp = 0,

    56         EState

    57         };

    58 

    59     /**

    60     * Possible values for proximito state

    61     */ 

    62     enum TProximityState

    63         {

    64         EProximityUndefined = 0,

    65         EProximityIndiscernible,

    66         EProximityDiscernible

    67         };

    68 

    69 public:

    70 

    71     /**

    72     * - Item name:   Sampling time.

    73     * - Item Index:  0

    74     * - Conditions:  None

    75     * - Description: Timestamp for a sample.

    76     */   

    77     TTime iTimeStamp; 

    78 

    79 	/**

    80     * - Item name: Proximity state

    81     * - Item Index: 0

    82     * - Conditions: None

    83     * - Description: -

    84     */ 

    85     TProximityState iProximityState;

    86 

    87 };

    88 

    89 #endif //SENSRVPROXIMITYSENSOR_H

    90 

    91 // End of File