summaryrefslogtreecommitdiffstats
path: root/plugins/sensors/symbian/compasssym.h
blob: c0427d0109937b773b292a77d5945f08f33d2ae9 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
/****************************************************************************
**
** Copyright (C) 2012 Digia Plc and/or its subsidiary(-ies).
** Contact: http://www.qt-project.org/legal
**
** This file is part of the Qt Mobility Components.
**
** $QT_BEGIN_LICENSE:LGPL$
** Commercial License Usage
** Licensees holding valid commercial Qt licenses may use this file in
** accordance with the commercial license agreement provided with the
** Software or, alternatively, in accordance with the terms contained in
** a written agreement between you and Digia.  For licensing terms and
** conditions see http://qt.digia.com/licensing.  For further information
** use the contact form at http://qt.digia.com/contact-us.
**
** 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, Digia gives you certain additional
** rights.  These rights are described in the Digia Qt LGPL Exception
** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
**
** GNU General Public License Usage
** Alternatively, this file may be used under the terms of the GNU
** General Public License version 3.0 as published by the Free Software
** Foundation and appearing in the file LICENSE.GPL included in the
** packaging of this file.  Please review the following information to
** ensure the GNU General Public License version 3.0 requirements will be
** met: http://www.gnu.org/copyleft/gpl.html.
**
**
** $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);

    /*
     * DataReceived 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 DataReceived(CSensrvChannel &aChannel, TInt aCount, TInt aDataLost);
    void ProcessReading();

    /**
     * Second phase constructor
     * Initialize the backend resources
     */
    void ConstructL();

public:
    /**
     * Holds the id of the compass
     */
    static char const * const id;

private:
    QCompassReading iReading;
    TSensrvMagneticNorthData iData;
    CMagnetometerSensorSym *iMagnetometer;
    };

#endif //PROXIMITYSENSORSYM_H