csapi-sensor: update API spec about exceptions
[platform/core/csapi/sensor.git] / Tizen.Sensor / Tizen.Sensor / Plugins / FaceDownGestureDetector.cs
1 // Copyright 2016 by Samsung Electronics, Inc.,
2 //
3 // This software is the confidential and proprietary information
4 // of Samsung Electronics, Inc. ("Confidential Information"). You
5 // shall not disclose such Confidential Information and shall use
6 // it only in accordance with the terms of the license agreement
7 // you entered into with Samsung.
8
9 using System;
10
11 namespace Tizen.Sensor
12 {
13     /// <summary>
14     /// FaceDownGestureDetector Class. Used for registering callbacks for face down gesture detector and getting the face down state
15     /// </summary>
16     public class FaceDownGestureDetector : Sensor
17     {
18         private static string GestureDetectorKey = "http://tizen.org/feature/sensor.gesture_recognition";
19
20         /// <summary>
21         /// Gets the state of the face down gesture.
22         /// </summary>
23         public DetectorState FaceDown { get; private set; }
24
25         /// <summary>
26         /// Returns true or false based on whether face down gesture detector is supported by device.
27         /// </summary>
28         public static bool IsSupported
29         {
30             get
31             {
32                 Log.Info(Globals.LogTag, "Checking if the face down gesture detector is supported");
33                 return CheckIfSupported(SensorType.FaceDownGestureDetector, GestureDetectorKey);
34             }
35         }
36
37         /// <summary>
38         /// Returns the number of face down gesture detector available on the device.
39         /// </summary>
40         public static int Count
41         {
42             get
43             {
44                 Log.Info(Globals.LogTag, "Getting the count of face down gesture detectors");
45                 return GetCount();
46             }
47         }
48
49         /// <summary>
50         /// Initializes a new instance of the <see cref="Tizen.Sensor.FaceDownGestureDetector"/> class.
51         /// </summary>
52         /// <exception cref="ArgumentException">Thrown when an invalid argument is used</exception>
53         /// <exception cref="NotSupportedException">Thrown when the sensor is not supported</exception>
54         /// <exception cref="InvalidOperationException">Thrown when the operation is invalid for the current state</exception>
55         /// <param name='index'>
56         /// Index. Default value for this is 0. Index refers to a particular face down gesture detector in case of multiple sensors.
57         /// </param>
58         public FaceDownGestureDetector(int index = 0) : base(index)
59         {
60             Log.Info(Globals.LogTag, "Creating face down gesture detector object");
61         }
62
63         internal override SensorType GetSensorType()
64         {
65             return SensorType.FaceDownGestureDetector;
66         }
67
68         private static int GetCount()
69         {
70             IntPtr list;
71             int count;
72             int error = Interop.SensorManager.GetSensorList(SensorType.FaceDownGestureDetector, out list, out count);
73             if (error != (int)SensorError.None)
74             {
75                 Log.Error(Globals.LogTag, "Error getting sensor list for face down gesture detector");
76                 count = 0;
77             }
78             else
79                 Interop.Libc.Free(list);
80             return count;
81         }
82
83         /// <summary>
84         /// Event Handler for storing the callback functions for event corresponding to change in face down gesture detector data.
85         /// </summary>
86         public event EventHandler<FaceDownGestureDetectorDataUpdatedEventArgs> DataUpdated;
87
88         protected override void EventListenStart()
89         {
90             int error = Interop.SensorListener.SetEventCallback(ListenerHandle, Interval, SensorEventCallback, IntPtr.Zero);
91             if (error != (int)SensorError.None)
92             {
93                 Log.Error(Globals.LogTag, "Error setting event callback for face down gesture detector");
94                 throw SensorErrorFactory.CheckAndThrowException(error, "Unable to set event callback for face down gesture detector");
95             }
96         }
97
98         protected override void EventListenStop()
99         {
100             int error = Interop.SensorListener.UnsetEventCallback(ListenerHandle);
101             if (error != (int)SensorError.None)
102             {
103                 Log.Error(Globals.LogTag, "Error unsetting event callback for face down gesture detector");
104                 throw SensorErrorFactory.CheckAndThrowException(error, "Unable to unset event callback for face down gesture detector");
105             }
106         }
107
108         private void SensorEventCallback(IntPtr sensorHandle, IntPtr sensorPtr, IntPtr data)
109         {
110             Interop.SensorEventStruct sensorData = Interop.IntPtrToEventStruct(sensorPtr);
111             TimeSpan = new TimeSpan((Int64)sensorData.timestamp);
112             FaceDown = (DetectorState) sensorData.values[0];
113
114             DataUpdated?.Invoke(this, new FaceDownGestureDetectorDataUpdatedEventArgs(sensorData.values[0]));
115         }
116     }
117 }