/
orientationsensor_i.h
135 lines (112 loc) · 3.75 KB
/
orientationsensor_i.h
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
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
/**
@file orientationsensor_i.h
@brief Interface for OrientationSensor
<p>
Copyright (C) 2009-2010 Nokia Corporation
@author Timo Rongas <ext-timo.2.rongas@nokia.com>
@author Antti Virtanen <antti.i.virtanen@nokia.com>
This file is part of Sensord.
Sensord is free software; you can redistribute it and/or modify
it under the terms of the GNU Lesser General Public License
version 2.1 as published by the Free Software Foundation.
Sensord is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
Lesser General Public License for more details.
You should have received a copy of the GNU Lesser General Public
License along with Sensord. If not, see <http://www.gnu.org/licenses/>.
</p>
*/
#ifndef ORIENTATIONSENSOR_I_H
#define ORIENTATIONSENSOR_I_H
#include <QtDBus/QtDBus>
#include <datatypes/unsigned.h>
#include "abstractsensor_i.h"
/**
* Client interface for listening device orientation changes.
*/
class OrientationSensorChannelInterface : public AbstractSensorChannelInterface
{
Q_OBJECT
Q_DISABLE_COPY(OrientationSensorChannelInterface)
Q_PROPERTY(Unsigned orientation READ orientation)
Q_PROPERTY(int threshold READ threshold WRITE setThreshold)
public:
/**
* Name of the D-Bus interface for this class.
*/
static const char* staticInterfaceName;
/**
* Create new instance of the class.
*
* @param id Sensor ID.
* @param sessionId Session ID.
* @return Pointer to new instance of the class.
*/
static AbstractSensorChannelInterface* factoryMethod(const QString& id, int sessionId);
/**
* Get latest orientation reading from sensor daemon.
*
* @return Current device orientation. The given integer
* value is enumeration from #PoseData::Orientation.
*/
Unsigned orientation();
/**
* Gets the currently used threshold value. Value is in mG.
*
* @return Current threshold value.
* @deprecated Not used.
*/
int threshold();
/**
* Sets the currently used threshold value. Value is in mG.
*
* @param value threshold value.
* @deprecated Not used.
*/
void setThreshold(int value);
/**
* Constructor.
*
* @param path path.
* @param sessionId session ID.
*/
OrientationSensorChannelInterface(const QString& path, int sessionId);
/**
* Request a listening interface to the sensor.
*
* @param id sensor ID.
* @return Pointer to interface, or NULL on failure.
* @deprecated use #interface(const QString&) instead.
*/
static const OrientationSensorChannelInterface* listenInterface(const QString& id);
/**
* Request a control interface to the sensor.
*
* @param id sensor ID.
* @return Pointer to interface, or NULL on failure.
* @deprecated use #interface(const QString&) instead.
*/
static OrientationSensorChannelInterface* controlInterface(const QString& id);
/**
* Request an interface to the sensor.
*
* @param id sensor ID.
* @return Pointer to interface, or NULL on failure.
*/
static OrientationSensorChannelInterface* interface(const QString& id);
protected:
virtual bool dataReceivedImpl();
Q_SIGNALS:
/**
* Sent when device orientation has changed.
*
* @param orientation Current device orientation. The given integer
* value is enumeration from #PoseData::Orientation.
*/
void orientationChanged(const Unsigned& orientation);
};
namespace local {
typedef ::OrientationSensorChannelInterface OrientationSensor;
}
#endif /* ORIENTATIONSENSOR_I_H */