epoc32/include/sensrvproximitysensor.h
author William Roberts <williamr@symbian.org>
Tue, 16 Mar 2010 16:12:26 +0000
branchSymbian2
changeset 2 2fe1408b6811
parent 0 061f57f2323e
child 4 837f303aceeb
permissions -rw-r--r--
Final list of Symbian^2 public API header files

/*
* Copyright (c) 2008 Nokia Corporation and/or its subsidiary(-ies). 
* All rights reserved.
* This component and the accompanying materials are made available
* 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
* which accompanies this distribution, and is available
* at the URL "http://www.symbianfoundation.org/legal/licencesv10.html".
*
* Initial Contributors:
* Nokia Corporation - initial contribution.
*
* Contributors:
*
* Description:  Channel data types definitions
*
*/



#ifndef SENSRVPROXIMITYSENSOR_H
#define SENSRVPROXIMITYSENSOR_H

//  INCLUDES
#include <e32base.h>
#include <sensrvtypes.h> 

// PROXIMITY RELATED CHANNELS

/**
* - Name: Proximity data channel
* - Type: Event
* - Datatype: TSensrvProximityMonitorData
* - Description: Proximity status 
*/
const TSensrvChannelTypeId KSensrvChannelTypeIdProximityMonitor = 0x2000E585;

// PROXIMITY RELATED DATATYPES

/**
* Proximity monitoring data type
*/
class TSensrvProximityData
	{
public:
	/**
	* Channel data type Id number
	*/ 
	static const TSensrvChannelDataTypeId KDataTypeId = 0x2000E585;

    /**
    * Channel data type index numbers
    */ 
    enum TSensrvProximityDataIndexes
        {
        ETimeStamp = 0,
        EState
        };

    /**
    * Possible values for proximito state
    */ 
    enum TProximityState
        {
        EProximityUndefined = 0,
        EProximityIndiscernible,
        EProximityDiscernible
        };

public:

    /**
    * - Item name:   Sampling time.
    * - Item Index:  0
    * - Conditions:  None
    * - Description: Timestamp for a sample.
    */   
    TTime iTimeStamp; 

	/**
    * - Item name: Proximity state
    * - Item Index: 0
    * - Conditions: None
    * - Description: -
    */ 
    TProximityState iProximityState;

};

#endif //SENSRVPROXIMITYSENSOR_H

// End of File