blob: 277afb5da3df9713d60ec480166e9b6123df08d8 (
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
|
/*
* Copyright (C) 2016 The Android Open Source Project
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
#ifndef CHRE_PLATFORM_PLATFORM_SENSOR_H_
#define CHRE_PLATFORM_PLATFORM_SENSOR_H_
#include "chre/core/sensor_request.h"
#include "chre/core/sensor_type.h"
#include "chre/platform/fatal_error.h"
#include "chre/target_platform/platform_sensor_base.h"
#include "chre/util/dynamic_vector.h"
namespace chre {
/**
* Defines the common interface to sensor functionality that is implemented in a
* platform-specific way, and must be supported on every platform.
*
* @see Sensor
*/
class PlatformSensor : public PlatformSensorBase, public NonCopyable {
public:
/**
* Obtains the SensorType of this platform sensor. The implementation of this
* method is supplied by the platform as the mechanism for determining the
* type may vary across platforms.
*
* @return The type of this sensor.
*/
uint8_t getSensorType() const;
/**
* @return This sensor's minimum supported sampling interval, in nanoseconds.
*/
uint64_t getMinInterval() const;
/**
* @return Whether this sensor reports bias events.
*/
bool reportsBiasEvents() const;
/**
* @return Whether this sensor supports passive requests.
*/
bool supportsPassiveMode() const;
/**
* Returns a descriptive name (e.g. type and model) for this sensor.
*
* @return A pointer to a string with storage duration at least as long as the
* lifetime of this object.
*/
const char *getSensorName() const;
/**
* @return The index of the sensor.
*/
uint8_t getSensorIndex() const;
/**
* @return The mask of groups that events this sensor produces should target.
*/
uint16_t getTargetGroupMask() const;
protected:
/**
* Default constructor that puts this instance in an unspecified state.
* Additional platform-specific initialization will likely be necessary to put
* this object in a usable state. Do not construct PlatformSensor directly;
* instead construct via Sensor.
*/
PlatformSensor() = default;
PlatformSensor(PlatformSensor &&other);
PlatformSensor &operator=(PlatformSensor &&other);
~PlatformSensor() = default;
};
} // namespace chre
#endif // CHRE_PLATFORM_PLATFORM_SENSOR_H_
|