qtmobility/plugins/sensors/symbian/compasssym.h
changeset 4 90517678cc4f
child 11 06b8e2af4411
equal deleted inserted replaced
1:2b40d63a9c3d 4:90517678cc4f
       
     1 /****************************************************************************
       
     2 **
       
     3 ** Copyright (C) 2009 Nokia Corporation and/or its subsidiary(-ies).
       
     4 ** All rights reserved.
       
     5 ** Contact: Nokia Corporation (qt-info@nokia.com)
       
     6 **
       
     7 ** This file is part of the Qt Mobility Components.
       
     8 **
       
     9 ** $QT_BEGIN_LICENSE:LGPL$
       
    10 ** No Commercial Usage
       
    11 ** This file contains pre-release code and may not be distributed.
       
    12 ** You may use this file in accordance with the terms and conditions
       
    13 ** contained in the Technology Preview License Agreement accompanying
       
    14 ** this package.
       
    15 **
       
    16 ** GNU Lesser General Public License Usage
       
    17 ** Alternatively, this file may be used under the terms of the GNU Lesser
       
    18 ** General Public License version 2.1 as published by the Free Software
       
    19 ** Foundation and appearing in the file LICENSE.LGPL included in the
       
    20 ** packaging of this file.  Please review the following information to
       
    21 ** ensure the GNU Lesser General Public License version 2.1 requirements
       
    22 ** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
       
    23 **
       
    24 ** In addition, as a special exception, Nokia gives you certain additional
       
    25 ** rights.  These rights are described in the Nokia Qt LGPL Exception
       
    26 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
       
    27 **
       
    28 ** If you have questions regarding the use of this file, please contact
       
    29 ** Nokia at qt-info@nokia.com.
       
    30 **
       
    31 **
       
    32 **
       
    33 **
       
    34 **
       
    35 **
       
    36 **
       
    37 **
       
    38 ** $QT_END_LICENSE$
       
    39 **
       
    40 ****************************************************************************/
       
    41 
       
    42 #ifndef COMPASSSYM_H
       
    43 #define COMPASSSYM_H
       
    44 
       
    45 // QT Mobility Sensor API headers
       
    46 #include <qsensorbackend.h>
       
    47 #include <qcompass.h>
       
    48 
       
    49 // Internal Headers
       
    50 #include "sensorbackendsym.h"
       
    51 
       
    52 // Sensor client headers
       
    53 // compass and magnetometer specific header
       
    54 #include <sensrvmagneticnorthsensor.h>
       
    55 #include <sensrvmagnetometersensor.h>
       
    56 // Magnetometer sensor specific header
       
    57 #include <magnetometersensorsym.h>
       
    58 
       
    59 QTM_USE_NAMESPACE
       
    60 
       
    61 class CCompassSym: public CSensorBackendSym
       
    62     {
       
    63 public:
       
    64     /**
       
    65      * Factory function, this is used to create the compass object
       
    66      * @return CCompassSym if successful, leaves on failure
       
    67      */
       
    68     static CCompassSym* NewL(QSensor *sensor);
       
    69     
       
    70     /**
       
    71      * Destructor
       
    72      * Closes the backend resources
       
    73      */
       
    74     ~CCompassSym();
       
    75 
       
    76     /**
       
    77      * start() overrides CSensorBackendSym::start()
       
    78      * This is to allow starting magnetometer before stopping the compass 
       
    79      */
       
    80     void start();
       
    81     
       
    82     /**
       
    83      * stop() overrides CSensorBackendSym::stop()
       
    84      * This is to allow stopping magnetometer before stopping the compass 
       
    85      */
       
    86     void stop();
       
    87     
       
    88 private:
       
    89     /**
       
    90      * Default constructor
       
    91      */
       
    92     CCompassSym(QSensor *sensor);
       
    93     
       
    94     /*
       
    95      * RecvData is used to retrieve the sensor reading from sensor server
       
    96      * It is implemented here to handle compass sensor specific
       
    97      * reading data and provides conversion and utility code
       
    98      */  
       
    99     void RecvData(CSensrvChannel &aChannel);
       
   100     
       
   101     /**
       
   102      * Second phase constructor
       
   103      * Initialize the backend resources
       
   104      */
       
   105     void ConstructL();
       
   106     
       
   107 public:
       
   108     /**
       
   109      * Holds the id of the compass
       
   110      */
       
   111     static const char *id;
       
   112     
       
   113 private:     
       
   114     QCompassReading iReading;
       
   115     TSensrvMagneticNorthData iData;
       
   116     CMagnetometerSensorSym *iMagnetometer;
       
   117     };
       
   118 
       
   119 #endif //PROXIMITYSENSORSYM_H