Ocean
IOSAccelerationSensor3DOF.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) Meta Platforms, Inc. and affiliates.
3  *
4  * This source code is licensed under the MIT license found in the
5  * LICENSE file in the root directory of this source tree.
6  */
7 
8 #ifndef META_OCEAN_DEVICES_IOS_IOS_ACCELERATION_SENSOR_3_DOF_H
9 #define META_OCEAN_DEVICES_IOS_IOS_ACCELERATION_SENSOR_3_DOF_H
10 
11 #include "ocean/devices/ios/IOS.h"
14 
16 
17 namespace Ocean
18 {
19 
20 namespace Devices
21 {
22 
23 namespace IOS
24 {
25 
26 /**
27  * This class implements all 3DOF acceleration sensors (including the linear acceleration sensors).
28  * @ingroup devicesios
29  */
30 class OCEAN_DEVICES_IOS_EXPORT IOSAccelerationSensor3DOF :
31  virtual public IOSSensor,
32  virtual public AccelerationSensor3DOF
33 {
34  friend class IOSFactory;
35 
36  public:
37 
38  /**
39  * Starts the device.
40  * @see Device::start().
41  */
42  virtual bool start();
43 
44  /**
45  * Pauses the device.
46  * @see Device::pause().
47  */
48  virtual bool pause();
49 
50  /**
51  * Stops the device.
52  * @see Device::stop().
53  */
54  virtual bool stop();
55 
56  /**
57  * Returns the name of this sensor.
58  * @param sensorType The type of the sensor (the subtype of the device), can be SENSOR_ACCELERATION_3DOF or SENSOR_LINEAR_ACCELERATION_3DOF
59  * @return The sensor's name
60  */
61  static inline std::string deviceNameIOSAccelerationSensor3DOF(const SensorType sensorType);
62 
63  /**
64  * Returns the device type of this sensor.
65  * @param sensorType The type of the sensor (the subtype of the device), can be SENSOR_ACCELERATION_3DOF or SENSOR_LINEAR_ACCELERATION_3DOF
66  * @return The sensor's device type
67  */
68  static inline DeviceType deviceTypeIOSAccelerationSensor3DOF(const SensorType sensorType);
69 
70  protected:
71 
72  /**
73  * Creates a new 3DOF acceleration sensor device.
74  * @param sensorType The type of the sensor (the subtype of the device), can be SENSOR_ACCELERATION_3DOF or SENSOR_LINEAR_ACCELERATION_3DOF
75  */
77 
78  /**
79  * Destructs a 3DOF acceleration sensor device.
80  */
82 
83  private:
84 
85  /**
86  * Callback function when using SENSOR_LINEAR_ACCELERATION_3DOF.
87  * @param deviceMotion iOS DeviceMotion readout
88  */
89  void onDeviceMotion(CMDeviceMotion* deviceMotion);
90 
91  private:
92 
93  // Callback id when using SENSOR_LINEAR_ACCELERATION_3DOF.
95 };
96 
98 {
99  ocean_assert(sensorType == SENSOR_ACCELERATION_3DOF || sensorType == SENSOR_LINEAR_ACCELERATION_3DOF);
100 
101  if (sensorType == SENSOR_ACCELERATION_3DOF)
102  {
103  return std::string("IOS 3DOF Acceleration Sensor");
104  }
105 
106  return std::string("IOS 3DOF Linear Acceleration Sensor");
107 }
108 
110 {
111  ocean_assert(sensorType == SENSOR_ACCELERATION_3DOF || sensorType == SENSOR_LINEAR_ACCELERATION_3DOF);
112 
113  return deviceTypeAccelerationSensor3DOF(sensorType);
114 }
115 
116 }
117 
118 }
119 
120 }
121 
122 #endif // META_OCEAN_DEVICES_IOS_IOS_ACCELERATION_SENSOR_3_DOF_H
This class is the base class for all 3DOF acceleration sensors.
Definition: AccelerationSensor3DOF.h:40
static DeviceType deviceTypeAccelerationSensor3DOF(const SensorType sensorType)
Returns this device type.
Definition: AccelerationSensor3DOF.h:118
Definition of a class holding the major and minor device type.
Definition: devices/Device.h:62
This class implements all 3DOF acceleration sensors (including the linear acceleration sensors).
Definition: IOSAccelerationSensor3DOF.h:33
static std::string deviceNameIOSAccelerationSensor3DOF(const SensorType sensorType)
Returns the name of this sensor.
Definition: IOSAccelerationSensor3DOF.h:97
IOSAccelerationSensor3DOF(const SensorType sensorType)
Creates a new 3DOF acceleration sensor device.
virtual bool start()
Starts the device.
static DeviceType deviceTypeIOSAccelerationSensor3DOF(const SensorType sensorType)
Returns the device type of this sensor.
Definition: IOSAccelerationSensor3DOF.h:109
virtual bool stop()
Stops the device.
void onDeviceMotion(CMDeviceMotion *deviceMotion)
Callback function when using SENSOR_LINEAR_ACCELERATION_3DOF.
virtual bool pause()
Pauses the device.
virtual ~IOSAccelerationSensor3DOF()
Destructs a 3DOF acceleration sensor device.
This class implements a device factory for the IOS feature based tracking system.
Definition: IOSFactory.h:29
This class implements a sensor for the IOS library.
Definition: IOSSensor.h:36
static constexpr ListenerId invalidListenerId()
Returns an invalid listener id.
Definition: MotionManager.h:121
unsigned int ListenerId
Definition of a listener id for a registered callbacks.
Definition: MotionManager.h:43
SensorType
Definition of different sensor types.
Definition: Sensor.h:43
@ SENSOR_ACCELERATION_3DOF
3DOF acceleration sensor.
Definition: Sensor.h:47
@ SENSOR_LINEAR_ACCELERATION_3DOF
3DOF linear acceleration sensor (excluding gravity).
Definition: Sensor.h:49
The namespace covering the entire Ocean framework.
Definition: Accessor.h:15