qtmobility/plugins/sensors/symbian/compasssym.h
changeset 4 90517678cc4f
child 11 06b8e2af4411
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/qtmobility/plugins/sensors/symbian/compasssym.h	Mon May 03 13:18:40 2010 +0300
@@ -0,0 +1,119 @@
+/****************************************************************************
+**
+** Copyright (C) 2009 Nokia Corporation and/or its subsidiary(-ies).
+** All rights reserved.
+** Contact: Nokia Corporation (qt-info@nokia.com)
+**
+** This file is part of the Qt Mobility Components.
+**
+** $QT_BEGIN_LICENSE:LGPL$
+** No Commercial Usage
+** This file contains pre-release code and may not be distributed.
+** You may use this file in accordance with the terms and conditions
+** contained in the Technology Preview License Agreement accompanying
+** this package.
+**
+** GNU Lesser General Public License Usage
+** Alternatively, this file may be used under the terms of the GNU Lesser
+** General Public License version 2.1 as published by the Free Software
+** Foundation and appearing in the file LICENSE.LGPL included in the
+** packaging of this file.  Please review the following information to
+** ensure the GNU Lesser General Public License version 2.1 requirements
+** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
+**
+** In addition, as a special exception, Nokia gives you certain additional
+** rights.  These rights are described in the Nokia Qt LGPL Exception
+** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
+**
+** If you have questions regarding the use of this file, please contact
+** Nokia at qt-info@nokia.com.
+**
+**
+**
+**
+**
+**
+**
+**
+** $QT_END_LICENSE$
+**
+****************************************************************************/
+
+#ifndef COMPASSSYM_H
+#define COMPASSSYM_H
+
+// QT Mobility Sensor API headers
+#include <qsensorbackend.h>
+#include <qcompass.h>
+
+// Internal Headers
+#include "sensorbackendsym.h"
+
+// Sensor client headers
+// compass and magnetometer specific header
+#include <sensrvmagneticnorthsensor.h>
+#include <sensrvmagnetometersensor.h>
+// Magnetometer sensor specific header
+#include <magnetometersensorsym.h>
+
+QTM_USE_NAMESPACE
+
+class CCompassSym: public CSensorBackendSym
+    {
+public:
+    /**
+     * Factory function, this is used to create the compass object
+     * @return CCompassSym if successful, leaves on failure
+     */
+    static CCompassSym* NewL(QSensor *sensor);
+    
+    /**
+     * Destructor
+     * Closes the backend resources
+     */
+    ~CCompassSym();
+
+    /**
+     * start() overrides CSensorBackendSym::start()
+     * This is to allow starting magnetometer before stopping the compass 
+     */
+    void start();
+    
+    /**
+     * stop() overrides CSensorBackendSym::stop()
+     * This is to allow stopping magnetometer before stopping the compass 
+     */
+    void stop();
+    
+private:
+    /**
+     * Default constructor
+     */
+    CCompassSym(QSensor *sensor);
+    
+    /*
+     * RecvData is used to retrieve the sensor reading from sensor server
+     * It is implemented here to handle compass sensor specific
+     * reading data and provides conversion and utility code
+     */  
+    void RecvData(CSensrvChannel &aChannel);
+    
+    /**
+     * Second phase constructor
+     * Initialize the backend resources
+     */
+    void ConstructL();
+    
+public:
+    /**
+     * Holds the id of the compass
+     */
+    static const char *id;
+    
+private:     
+    QCompassReading iReading;
+    TSensrvMagneticNorthData iData;
+    CMagnetometerSensorSym *iMagnetometer;
+    };
+
+#endif //PROXIMITYSENSORSYM_H