javaextensions/sensor/src/sensorfinder.h
branchRCL_3
changeset 19 04becd199f91
equal deleted inserted replaced
16:f5050f1da672 19:04becd199f91
       
     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:  Interface for SensorFinder
       
    15 *
       
    16 */
       
    17 
       
    18 #ifndef SENSORFINDER_H
       
    19 #define SENSORFINDER_H
       
    20 
       
    21 // EXTERNAL INCLUDES
       
    22 
       
    23 // INTERNAL INCLUDES
       
    24 
       
    25 // FORWARD DECLARATIONS
       
    26 class Sensor;
       
    27 
       
    28 // CLASS DESCRIPTION
       
    29 /**
       
    30  * Interface for SensorFinder
       
    31  * Used for finding sensors from underlying OS
       
    32  *
       
    33  * @lib N/A
       
    34  * @since S60 3.2
       
    35  */
       
    36 class SensorFinder
       
    37 {
       
    38 public: // New methods
       
    39     /**
       
    40      * Finds sensors
       
    41      * @param aSensorCount int pointer for size of the returned sensor information array
       
    42      * @return Array of sensor information
       
    43      */
       
    44     virtual unsigned short** FindSensors(int* aSensorCount) = 0;
       
    45 
       
    46     /**
       
    47      * Creates new instance of Sensor
       
    48      * @param aIndex, Index number of sensor,
       
    49      *                   Sensors should be in same order as
       
    50      *                   they are received from FindSensors
       
    51      */
       
    52     virtual Sensor* CreateSensor(int aIndex) = 0;
       
    53 
       
    54     /**
       
    55      * Destructor, to allow deletion through this interface
       
    56      */
       
    57     virtual ~SensorFinder() {};
       
    58 };
       
    59 #endif // SENSORFINDER_H
       
    60 
       
    61 // End of file