csapi-sensor: change index type from int to unit in constructor
[platform/core/csapi/sensor.git] / Tizen.Sensor / Tizen.Sensor / Plugins / TemperatureSensor.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     /// TemperatureSensor Class. Used for registering callbacks for temperature sensor and getting temperature data
15     /// /// </summary>
16     public class TemperatureSensor : Sensor
17     {
18         private static string TemperatureSensorKey = "http://tizen.org/feature/sensor.temperature";
19
20         /// <summary>
21         /// Gets the value of the temperature sensor.
22         /// </summary>
23         public float Temperature { get; private set; }
24
25         /// <summary>
26         /// Returns true or false based on whether temperature sensor is supported by device.
27         /// </summary>
28         public static bool IsSupported
29         {
30             get
31             {
32                 Log.Info(Globals.LogTag, "Checking if the TemperatureSensor is supported");
33                 return CheckIfSupported(SensorType.TemperatureSensor, TemperatureSensorKey);
34             }
35         }
36
37         /// <summary>
38         /// Returns the number of temperature sensors available on the device.
39         /// </summary>
40         public static int Count
41         {
42             get
43             {
44                 Log.Info(Globals.LogTag, "Getting the count of temperature sensors");
45                 return GetCount();
46             }
47         }
48
49         /// <summary>
50         /// Initializes a new instance of the <see cref="Tizen.Sensor.TemperatureSensor"/> 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 temperature sensor in case of multiple sensors
57         /// </param>
58         public TemperatureSensor(uint index = 0) : base(index)
59         {
60             Log.Info(Globals.LogTag, "Creating TemperatureSensor object");
61         }
62
63         internal override SensorType GetSensorType()
64         {
65             return SensorType.TemperatureSensor;
66         }
67
68         /// <summary>
69         /// Event Handler for storing the callback functions for event corresponding to change in temperature sensor data.
70         /// </summary>
71
72         public event EventHandler<TemperatureSensorDataUpdatedEventArgs> DataUpdated;
73
74
75         private static int GetCount()
76         {
77             IntPtr list;
78             int count;
79             int error = Interop.SensorManager.GetSensorList(SensorType.TemperatureSensor, out list, out count);
80             if (error != (int)SensorError.None)
81             {
82                 Log.Error(Globals.LogTag, "Error getting sensor list for temperature");
83                 count = 0;
84             }
85             else
86                 Interop.Libc.Free(list);
87             return count;
88         }
89
90         protected override void EventListenStart()
91         {
92             int error = Interop.SensorListener.SetEventCallback(ListenerHandle, Interval, SensorEventCallback, IntPtr.Zero);
93             if (error != (int)SensorError.None)
94             {
95                 Log.Error(Globals.LogTag, "Error setting event callback for temperature sensor");
96                 throw SensorErrorFactory.CheckAndThrowException(error, "Unable to set event callback for temperature");
97             }
98         }
99
100         protected override void EventListenStop()
101         {
102             int error = Interop.SensorListener.UnsetEventCallback(ListenerHandle);
103             if (error != (int)SensorError.None)
104             {
105                 Log.Error(Globals.LogTag, "Error unsetting event callback for temperature sensor");
106                 throw SensorErrorFactory.CheckAndThrowException(error, "Unable to unset event callback for temperature");
107             }
108         }
109
110         private void SensorEventCallback(IntPtr sensorHandle, IntPtr sensorPtr, IntPtr data)
111         {
112             Interop.SensorEventStruct sensorData = Interop.IntPtrToEventStruct(sensorPtr);
113             TimeSpan = new TimeSpan((Int64)sensorData.timestamp);
114             Temperature = sensorData.values[0];
115
116             DataUpdated?.Invoke(this, new TemperatureSensorDataUpdatedEventArgs(sensorData.values[0]));
117         }
118     }
119 }