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 public sealed class MagnetometerRotationVectorSensor : Sensor
26 private static string MagnetometerRVKey = "http://tizen.org/feature/sensor.geomagnetic_rotation_vector";
28 private event EventHandler<SensorAccuracyChangedEventArgs> _accuracyChanged;
30 /// Gets the X component of the magnetometer rotation vector.
32 /// <since_tizen> 3 </since_tizen>
33 /// <value> X </value>
34 public float X { get; private set; } = float.MinValue;
37 /// Gets the Y component of the magnetometer rotation vector.
39 /// <since_tizen> 3 </since_tizen>
40 /// <value> Y </value>
41 public float Y { get; private set; } = float.MinValue;
44 /// Gets the Z component of the magnetometer rotation vector.
46 /// <since_tizen> 3 </since_tizen>
47 /// <value> Z </value>
48 public float Z { get; private set; } = float.MinValue;
51 /// Gets the W component of the magnetometer rotation vector.
53 /// <since_tizen> 3 </since_tizen>
54 /// <value> W </value>
55 public float W { get; private set; } = float.MinValue;
58 /// Gets the accuracy of the magnetometer rotation vector data.
60 /// <since_tizen> 3 </since_tizen>
61 /// <value> Accuracy </value>
62 public SensorDataAccuracy Accuracy { get; private set; }
65 /// Returns true or false based on whether the magnetometer rotation vector sensor is supported by the device.
67 /// <since_tizen> 3 </since_tizen>
68 /// <value><c>true</c> if supported; otherwise <c>false</c>.</value>
69 public static bool IsSupported
73 Log.Info(Globals.LogTag, "Checking if the MagnetometerRotationVectorSensor is supported");
74 return CheckIfSupported(SensorType.MagnetometerRotationVectorSensor, MagnetometerRVKey);
79 /// Returns the number of magnetometer rotation vector sensors available on the device.
81 /// <since_tizen> 3 </since_tizen>
82 /// <value> The count of magnetometer rotation vector sensors. </value>
83 public static int Count
87 Log.Info(Globals.LogTag, "Getting the count of magnetometer rotation vector sensors");
93 /// Initializes a new instance of the <see cref="Tizen.Sensor.MagnetometerRotationVectorSensor"/> class.
95 /// <since_tizen> 3 </since_tizen>
96 /// <feature>http://tizen.org/feature/sensor.geomagnetic_rotation_vector</feature>
97 /// <exception cref="ArgumentException">Thrown when an invalid argument is used.</exception>
98 /// <exception cref="NotSupportedException">Thrown when the sensor is not supported.</exception>
99 /// <exception cref="InvalidOperationException">Thrown when the operation is invalid for the current state.</exception>
100 /// <param name='index'>
101 /// Index. Default value for this is 0. Index refers to a particular magnetometer rotation vector sensor in case of multiple sensors.
103 public MagnetometerRotationVectorSensor(uint index = 0) : base(index)
105 Log.Info(Globals.LogTag, "Creating MagnetometerRotationVectorSensor object");
108 internal override SensorType GetSensorType()
110 return SensorType.MagnetometerRotationVectorSensor;
114 /// An event handler for storing the callback functions for the event corresponding to the change in the magnetometer rotation vector sensor data.
116 /// <since_tizen> 3 </since_tizen>
118 public event EventHandler<MagnetometerRotationVectorSensorDataUpdatedEventArgs> DataUpdated;
121 /// An event handler for accuracy changed events.
123 /// <since_tizen> 3 </since_tizen>
124 public event EventHandler<SensorAccuracyChangedEventArgs> AccuracyChanged
128 if (_accuracyChanged == null)
130 AccuracyListenStart();
132 _accuracyChanged += value;
136 _accuracyChanged -= value;
137 if (_accuracyChanged == null)
139 AccuracyListenStop();
144 private static bool CheckIfSupported()
147 int error = Interop.SensorManager.SensorIsSupported(SensorType.MagnetometerRotationVectorSensor, out isSupported);
148 if (error != (int)SensorError.None)
150 Log.Error(Globals.LogTag, "Error checking if magnetometer rotation vector sensor is supported");
156 private static int GetCount()
160 int error = Interop.SensorManager.GetSensorList(SensorType.MagnetometerRotationVectorSensor, out list, out count);
161 if (error != (int)SensorError.None)
163 Log.Error(Globals.LogTag, "Error getting sensor list for magnetometer rotation vector");
167 Interop.Libc.Free(list);
171 private static Interop.SensorListener.SensorEventCallback _callback;
173 internal override void EventListenStart()
175 _callback = (IntPtr sensorHandle, IntPtr eventPtr, IntPtr data) => {
176 Interop.SensorEventStruct sensorData = Interop.IntPtrToEventStruct(eventPtr);
178 TimeSpan = new TimeSpan((Int64)sensorData.timestamp);
179 X = sensorData.values[0];
180 Y = sensorData.values[1];
181 Z = sensorData.values[2];
182 W = sensorData.values[3];
183 Accuracy = sensorData.accuracy;
185 DataUpdated?.Invoke(this, new MagnetometerRotationVectorSensorDataUpdatedEventArgs(sensorData.values, sensorData.accuracy));
188 int error = Interop.SensorListener.SetEventCallback(ListenerHandle, Interval, _callback, IntPtr.Zero);
189 if (error != (int)SensorError.None)
191 Log.Error(Globals.LogTag, "Error setting event callback for magnetometer rotation vector sensor");
192 throw SensorErrorFactory.CheckAndThrowException(error, "Unable to set event callback for magnetometer rotation vector");
196 internal override void EventListenStop()
198 int error = Interop.SensorListener.UnsetEventCallback(ListenerHandle);
199 if (error != (int)SensorError.None)
201 Log.Error(Globals.LogTag, "Error unsetting event callback for magnetometer rotation vector sensor");
202 throw SensorErrorFactory.CheckAndThrowException(error, "Unable to unset event callback for magnetometer rotation vector");
206 private static Interop.SensorListener.SensorAccuracyCallback _accuracyCallback;
208 private void AccuracyListenStart()
210 _accuracyCallback = (IntPtr sensorHandle, UInt64 timestamp, SensorDataAccuracy accuracy, IntPtr data) => {
211 TimeSpan = new TimeSpan((Int64)timestamp);
213 _accuracyChanged?.Invoke(this, new SensorAccuracyChangedEventArgs(new TimeSpan((Int64)timestamp), accuracy));
216 int error = Interop.SensorListener.SetAccuracyCallback(ListenerHandle, _accuracyCallback, IntPtr.Zero);
217 if (error != (int)SensorError.None)
219 Log.Error(Globals.LogTag, "Error setting accuracy event callback for magnetometer rotation vector sensor");
220 throw SensorErrorFactory.CheckAndThrowException(error, "Unable to set accuracy event callback for magnetometer rotation vector");
224 private void AccuracyListenStop()
226 int error = Interop.SensorListener.UnsetAccuracyCallback(ListenerHandle);
227 if (error != (int)SensorError.None)
229 Log.Error(Globals.LogTag, "Error unsetting accuracy event callback for magnetometer rotation vector sensor");
230 throw SensorErrorFactory.CheckAndThrowException(error, "Unable to unset accuracy event callback for magnetometer rotation vector");