2 * Copyright (c) 2016 Samsung Electronics Co., Ltd All Rights Reserved
4 * Licensed under the Apache License, Version 2.0 (the License);
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
8 * http://www.apache.org/licenses/LICENSE-2.0
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an AS IS BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
19 namespace Tizen.Sensor
22 /// The MagnetometerRotationVectorSensor class is used for registering callbacks for the magnetometer rotation vector sensor and getting the magnetometer rotation vector data.
24 /// <since_tizen> 3 </since_tizen>
25 public sealed class MagnetometerRotationVectorSensor : Sensor
27 private static string MagnetometerRVKey = "http://tizen.org/feature/sensor.geomagnetic_rotation_vector";
29 private event EventHandler<SensorAccuracyChangedEventArgs> _accuracyChanged;
31 /// Gets the X component of the magnetometer rotation vector.
33 /// <since_tizen> 3 </since_tizen>
34 /// <value> X </value>
35 public float X { get; private set; } = float.MinValue;
38 /// Gets the Y component of the magnetometer rotation vector.
40 /// <since_tizen> 3 </since_tizen>
41 /// <value> Y </value>
42 public float Y { get; private set; } = float.MinValue;
45 /// Gets the Z component of the magnetometer rotation vector.
47 /// <since_tizen> 3 </since_tizen>
48 /// <value> Z </value>
49 public float Z { get; private set; } = float.MinValue;
52 /// Gets the W component of the magnetometer rotation vector.
54 /// <since_tizen> 3 </since_tizen>
55 /// <value> W </value>
56 public float W { get; private set; } = float.MinValue;
59 /// Gets the accuracy of the magnetometer rotation vector data.
61 /// <since_tizen> 3 </since_tizen>
62 /// <value> Accuracy </value>
63 public SensorDataAccuracy Accuracy { get; private set; }
66 /// Returns true or false based on whether the magnetometer rotation vector sensor is supported by the device.
68 /// <since_tizen> 3 </since_tizen>
69 /// <value><c>true</c> if supported; otherwise <c>false</c>.</value>
70 public static bool IsSupported
74 Log.Info(Globals.LogTag, "Checking if the MagnetometerRotationVectorSensor is supported");
75 return CheckIfSupported(SensorType.MagnetometerRotationVectorSensor, MagnetometerRVKey);
80 /// Returns the number of magnetometer rotation vector sensors available on the device.
82 /// <since_tizen> 3 </since_tizen>
83 /// <value> The count of magnetometer rotation vector sensors. </value>
84 public static int Count
88 Log.Info(Globals.LogTag, "Getting the count of magnetometer rotation vector sensors");
94 /// Initializes a new instance of the <see cref="Tizen.Sensor.MagnetometerRotationVectorSensor"/> class.
96 /// <since_tizen> 3 </since_tizen>
97 /// <feature>http://tizen.org/feature/sensor.geomagnetic_rotation_vector</feature>
98 /// <exception cref="ArgumentException">Thrown when an invalid argument is used.</exception>
99 /// <exception cref="NotSupportedException">Thrown when the sensor is not supported.</exception>
100 /// <exception cref="InvalidOperationException">Thrown when the operation is invalid for the current state.</exception>
101 /// <param name='index'>
102 /// Index. Default value for this is 0. Index refers to a particular magnetometer rotation vector sensor in case of multiple sensors.
104 public MagnetometerRotationVectorSensor(uint index = 0) : base(index)
106 Log.Info(Globals.LogTag, "Creating MagnetometerRotationVectorSensor object");
109 internal override SensorType GetSensorType()
111 return SensorType.MagnetometerRotationVectorSensor;
115 /// An event handler for storing the callback functions for the event corresponding to the change in the magnetometer rotation vector sensor data.
117 /// <since_tizen> 3 </since_tizen>
119 public event EventHandler<MagnetometerRotationVectorSensorDataUpdatedEventArgs> DataUpdated;
122 /// An event handler for accuracy changed events.
124 /// <since_tizen> 3 </since_tizen>
125 public event EventHandler<SensorAccuracyChangedEventArgs> AccuracyChanged
129 if (_accuracyChanged == null)
131 AccuracyListenStart();
133 _accuracyChanged += value;
137 _accuracyChanged -= value;
138 if (_accuracyChanged == null)
140 AccuracyListenStop();
145 private static bool CheckIfSupported()
148 int error = Interop.SensorManager.SensorIsSupported(SensorType.MagnetometerRotationVectorSensor, out isSupported);
149 if (error != (int)SensorError.None)
151 Log.Error(Globals.LogTag, "Error checking if magnetometer rotation vector sensor is supported");
157 private static int GetCount()
161 int error = Interop.SensorManager.GetSensorList(SensorType.MagnetometerRotationVectorSensor, out list, out count);
162 if (error != (int)SensorError.None)
164 Log.Error(Globals.LogTag, "Error getting sensor list for magnetometer rotation vector");
168 Interop.Libc.Free(list);
173 /// Read magnetometer rotation vector sensor data synchronously.
175 internal override void ReadData()
177 Interop.SensorEventStruct sensorData;
178 int error = Interop.SensorListener.ReadData(ListenerHandle, out sensorData);
179 if (error != (int)SensorError.None)
181 Log.Error(Globals.LogTag, "Error reading magnetometer rotation vector sensor data");
182 throw SensorErrorFactory.CheckAndThrowException(error, "Reading magnetometer rotation vector sensor data failed");
185 TimeSpan = new TimeSpan((Int64)sensorData.timestamp);
186 X = sensorData.values[0];
187 Y = sensorData.values[1];
188 Z = sensorData.values[2];
189 W = sensorData.values[3];
190 Accuracy = sensorData.accuracy;
193 private static Interop.SensorListener.SensorEventCallback _callback;
195 internal override void EventListenStart()
197 _callback = (IntPtr sensorHandle, IntPtr eventPtr, IntPtr data) => {
198 Interop.SensorEventStruct sensorData = Interop.IntPtrToEventStruct(eventPtr);
200 TimeSpan = new TimeSpan((Int64)sensorData.timestamp);
201 X = sensorData.values[0];
202 Y = sensorData.values[1];
203 Z = sensorData.values[2];
204 W = sensorData.values[3];
205 Accuracy = sensorData.accuracy;
207 DataUpdated?.Invoke(this, new MagnetometerRotationVectorSensorDataUpdatedEventArgs(sensorData.values, sensorData.accuracy));
210 int error = Interop.SensorListener.SetEventCallback(ListenerHandle, Interval, _callback, IntPtr.Zero);
211 if (error != (int)SensorError.None)
213 Log.Error(Globals.LogTag, "Error setting event callback for magnetometer rotation vector sensor");
214 throw SensorErrorFactory.CheckAndThrowException(error, "Unable to set event callback for magnetometer rotation vector");
218 internal override void EventListenStop()
220 int error = Interop.SensorListener.UnsetEventCallback(ListenerHandle);
221 if (error != (int)SensorError.None)
223 Log.Error(Globals.LogTag, "Error unsetting event callback for magnetometer rotation vector sensor");
224 throw SensorErrorFactory.CheckAndThrowException(error, "Unable to unset event callback for magnetometer rotation vector");
228 private static Interop.SensorListener.SensorAccuracyCallback _accuracyCallback;
230 private void AccuracyListenStart()
232 _accuracyCallback = (IntPtr sensorHandle, UInt64 timestamp, SensorDataAccuracy accuracy, IntPtr data) => {
233 TimeSpan = new TimeSpan((Int64)timestamp);
235 _accuracyChanged?.Invoke(this, new SensorAccuracyChangedEventArgs(new TimeSpan((Int64)timestamp), accuracy));
238 int error = Interop.SensorListener.SetAccuracyCallback(ListenerHandle, _accuracyCallback, IntPtr.Zero);
239 if (error != (int)SensorError.None)
241 Log.Error(Globals.LogTag, "Error setting accuracy event callback for magnetometer rotation vector sensor");
242 throw SensorErrorFactory.CheckAndThrowException(error, "Unable to set accuracy event callback for magnetometer rotation vector");
246 private void AccuracyListenStop()
248 int error = Interop.SensorListener.UnsetAccuracyCallback(ListenerHandle);
249 if (error != (int)SensorError.None)
251 Log.Error(Globals.LogTag, "Error unsetting accuracy event callback for magnetometer rotation vector sensor");
252 throw SensorErrorFactory.CheckAndThrowException(error, "Unable to unset accuracy event callback for magnetometer rotation vector");