namespace Tizen.Sensor
{
/// <summary>
- /// Abstract sensor for series of sensor data
+ /// Abstract class for sensor for series of sensor data.
+ /// Inherit the class 'Sensor' which is an abstract class.
/// </summary>
+ /// <remarks>
+ /// A class which inherits this abstract class should provide TData as an
+ /// class that inherits BatchData class.
+ /// </remarks>
/// <since_tizen> 8 </since_tizen>
public abstract class BatchSensor<TData> : Sensor where TData : Tizen.Sensor.BatchData
{
public IReadOnlyList<TData> Data { get; protected set; }
/// <summary>
- /// Convert general batch data to specific batch data
+ /// Convert general batch data to specific batch data type "TData".
/// </summary>
/// <since_tizen> 8 </since_tizen>
/// <returns> List of converted specific batch data </returns>
protected abstract IReadOnlyList<TData> ConvertBatchData();
/// <summary>
- /// Update the internal batch data using the latest events
+ /// Update the internal batch data using the latest events.
+ /// Call updateBatchEvents() which inherited from the Sensor class to
+ /// update batch data list which is managed by the Sensor class.
+ /// Then convert the updated batch data to the specific type by using
+ /// the method "ConvertBatchData" and assign it to the Data property.
/// </summary>
+ /// <remarks>
+ /// To use this method, you must override the ConvertBatchData method.
+ /// </remarks>
+ /// <seealso cref="Tizen.Sensor.Sensor">
/// <param name="eventsPtr">
/// General batch data's raw pointer
/// </param>
{
private static string AccelerometerKey = "http://tizen.org/feature/sensor.accelerometer";
/// <summary>
- /// Gets the X component of the acceleration.
+ /// Get the X component value of acceleration from the accelerometer sensor.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <value> X </value>
public float X { get; private set; } = float.MinValue;
/// <summary>
- /// Gets the Y component of the acceleration.
+ /// Get the Y component value of acceleration from the accelerometer sensor.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <value> Y </value>
public float Y { get; private set; } = float.MinValue;
/// <summary>
- /// Gets the Z component of the acceleration.
+ /// Get the Z component value of acceleration from the accelerometer sensor.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <value> Z </value>
public float Z { get; private set; } = float.MinValue;
/// <summary>
- /// Returns true or false based on whether accelerometer sensor is supported by the device.
+ /// Return true or false based on whether accelerometer sensor is supported by the system.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <value><c>true</c> if supported; otherwise <c>false</c>.</value>
}
/// <summary>
- /// Returns the number of accelerometer sensors available on the device.
+ /// Return the number of accelerometer sensors available by the system.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <value> The count of accelerometer sensors. </value>
};
/// <summary>
- /// Gets the activity accuracy of the activity detector.
+ /// Get the activity accuracy of the activity detector sensor.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <value> The activity accuracy. </value>
private event EventHandler<SensorAccuracyChangedEventArgs> _accuracyChanged;
/// <summary>
- /// Gets the value of the rotation state.
+ /// Get the degree of the rotation state of the sensor as enum <see cref="AutoRotationState"/> type.
/// </summary>
/// <since_tizen> 7 </since_tizen>
- /// <value> The rotation state. </value>
+ /// <value> The rotation state, <seealso cref="AutoRotationState"/>. </value>
public AutoRotationState Rotation { get; private set; } = AutoRotationState.Degree_0;
/// <summary>
- /// Gets the accuracy of the auto-rotation data.
+ /// Get the accuracy of the auto-rotation data as enum <see cref="SensorDataAccuracy"/> type.
/// </summary>
/// <since_tizen> 7 </since_tizen>
- /// <value> Accuracy </value>
+ /// <value> Accuracy, <seealso cref="SensorDataAccuracy"/> </value>
public SensorDataAccuracy Accuracy { get; private set; } = SensorDataAccuracy.Undefined;
/// <summary>
- /// Returns true or false based on whether the auto-rotation sensor is supported by the device.
+ /// Return true or false based on whether the auto-rotation sensor is supported by the system.
/// </summary>
/// <since_tizen> 7 </since_tizen>
/// <value><c>true</c> if supported; otherwise <c>false</c>.</value>
/// An event handler for storing the callback functions for the event corresponding to the change in the auto-rotation sensor data.
/// </summary>
/// <since_tizen> 7 </since_tizen>
-
public event EventHandler<AutoRotationSensorDataUpdatedEventArgs> DataUpdated;
/// <summary>
- /// An event handler for accuracy changed events.
+ /// An event handler for the event of accuracy change.
+ /// If an event is added, a new accuracy change callback is registered for this sensor.
+ /// If an event is removed, accuracy change callback is unregistered for this sensor.
/// </summary>
/// <since_tizen> 7 </since_tizen>
public event EventHandler<SensorAccuracyChangedEventArgs> AccuracyChanged
private static string GestureDetectorKey = "http://tizen.org/feature/sensor.gesture_recognition";
/// <summary>
- /// Gets the state of the face down gesture.
+ /// Get the state of the face down gesture as enum <see cref="DetectorState"/> type.
/// </summary>
/// <since_tizen> 3 </since_tizen>
- /// <value> The face down state. </value>
+ /// <value> The face down state, <seealso cref="DetectorState"/>. </value>
public DetectorState FaceDown { get; private set; } = DetectorState.Unknown;
/// <summary>
- /// Returns true or false based on whether the face down gesture detector is supported by the device.
+ /// Return true or false based on whether the face down gesture detector is supported by the system.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <value><c>true</c> if supported; otherwise <c>false</c>.</value>
}
/// <summary>
- /// Returns the number of face down gesture detectors available on the device.
+ /// Return the number of face down gesture detectors available on the system.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <value> The count of face down gesture detectors. </value>
}
/// <summary>
- /// Initializes a new instance of the <see cref="Tizen.Sensor.FaceDownGestureDetector"/> class.
+ /// Initialize a new instance of the <see cref="Tizen.Sensor.FaceDownGestureDetector"/> class.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <feature>http://tizen.org/feature/sensor.gesture_recognition</feature>
/// <exception cref="NotSupportedException">Thrown when the sensor is not supported.</exception>
/// <exception cref="InvalidOperationException">Thrown when the operation is invalid for the current state.</exception>
/// <param name='index'>
- /// Index. Default value for this is 0. Index refers to a particular face down gesture detector in case of multiple sensors.
+ /// Index refers to a particular face down gesture detector in case of multiple sensors.
+ /// Default value is 0.
/// </param>
public FaceDownGestureDetector(uint index = 0) : base(index)
{
private const string GravitySensorKey = "http://tizen.org/feature/sensor.gravity";
private event EventHandler<SensorAccuracyChangedEventArgs> _accuracyChanged;
+
/// <summary>
- /// Gets the X component of the gravity.
+ /// Get the X component value of the gravity sensor as float type.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <value> X </value>
public float X { get; private set; } = float.MinValue;
/// <summary>
- /// Gets the Y component of the gravity.
+ /// Get the Y component value of the gravity sensor as float type.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <value> Y </value>
public float Y { get; private set; } = float.MinValue;
/// <summary>
- /// Gets the Z component of the gravity.
+ /// Get the Z component value of the gravity sensor as float type.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <value> Z </value>
public float Z { get; private set; } = float.MinValue;
/// <summary>
- /// Returns true or false based on whether the gravity sensor is supported by the device.
+ /// Return true or false based on whether the gravity sensor is supported by the system.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <value><c>true</c> if supported; otherwise <c>false</c>.</value>
}
/// <summary>
- /// Returns the number of gravity sensors available on the device.
+ /// Return the number of gravity sensors available on the system.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <value> The count of gravity sensors. </value>
}
/// <summary>
- /// Initializes a new instance of the <see cref="Tizen.Sensor.GravitySensor"/> class.
+ /// Initialize a new instance of the <see cref="Tizen.Sensor.GravitySensor"/> class.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <feature>http://tizen.org/feature/sensor.gravity</feature>
/// <exception cref="NotSupportedException">Thrown when the sensor is not supported.</exception>
/// <exception cref="InvalidOperationException">Thrown when the operation is invalid for the current state.</exception>
/// <param name='index'>
- /// Index. Default value for this is 0. Index refers to a particular gravity sensor in case of multiple sensors.
+ /// Index refers to a particular gravity sensor in case of multiple sensors.
+ /// Default value is 0.
/// </param>
public GravitySensor (uint index = 0) : base(index)
{
/// An event handler for storing the callback functions for the event corresponding to the change in the gravity sensor data.
/// </summary>
/// <since_tizen> 3 </since_tizen>
-
public event EventHandler<GravitySensorDataUpdatedEventArgs> DataUpdated;
/// <summary>
- /// An event handler for accuracy changed events.
+ /// An event handler for the event of accuracy change.
+ /// If an event is added, a new accuracy change callback is registered for this sensor.
+ /// If an event is removed, accuracy change callback is unregistered for this sensor.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public event EventHandler<SensorAccuracyChangedEventArgs> AccuracyChanged
private const string GyroscopeKey = "http://tizen.org/feature/sensor.gyroscope";
/// <summary>
- /// Gets the X component of the acceleration.
+ /// Get the X component value of the acceleration as float type.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <value> X </value>
public float X { get; private set; } = float.MinValue;
/// <summary>
- /// Gets the Y component of the acceleration.
+ /// Get the Y component value of the acceleration as float type.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <value> Y </value>
public float Y { get; private set; } = float.MinValue;
/// <summary>
- /// Gets the Z component of the acceleration.
+ /// Get the Z component value of the acceleration as float type.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <value> Z </value>
public float Z { get; private set; } = float.MinValue;
/// <summary>
- /// Returns true or false based on whether the gyroscope sensor is supported by the device.
+ /// Return true or false based on whether the gyroscope sensor is supported by the system.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <value><c>true</c> if supported; otherwise <c>false</c>.</value>
}
/// <summary>
- /// Returns the number of the gyroscope sensors available on the device.
+ /// Return the number of the gyroscope sensors available on the system.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <value> The count of the gyroscope sensors. </value>
}
/// <summary>
- /// Initializes a new instance of the <see cref="Tizen.Sensor.Gyroscope"/> class.
+ /// Initialize a new instance of the <see cref="Tizen.Sensor.Gyroscope"/> class.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <feature>http://tizen.org/feature/sensor.gyroscope</feature>
/// <exception cref="NotSupportedException">Thrown when the sensor is not supported.</exception>
/// <exception cref="InvalidOperationException">Thrown when the operation is invalid for the current state.</exception>
/// <param name='index'>
- /// Index. Default value for this is 0. Index refers to a particular gyroscope sensor in case of multiple sensors.
+ /// Index refers to a particular gyroscope sensor in case of multiple sensors.
+ /// Default value is 0.
/// </param>
public Gyroscope(uint index = 0) : base(index)
{
/// <summary>
/// An event handler for storing the callback functions for the event corresponding to the change in the gyroscope sensor data.
+ /// If an event is added, a new accuracy change callback is registered for this sensor.
+ /// If an event is removed, accuracy change callback is unregistered for this sensor.
/// </summary>
/// <since_tizen> 3 </since_tizen>
-
public event EventHandler<GyroscopeDataUpdatedEventArgs> DataUpdated;
private static int GetCount()
private const string GyroscopeRVKey = "http://tizen.org/feature/sensor.gyroscope_rotation_vector";
/// <summary>
- /// Gets the X component of the gyroscope rotation vector.
+ /// Get the X component of the gyroscope rotation vector.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <value> X </value>
public float X { get; private set; } = float.MinValue;
/// <summary>
- /// Gets the Y component of the gyroscope rotation vector.
+ /// Get the Y component of the gyroscope rotation vector.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <value> Y </value>
public float Y { get; private set; } = float.MinValue;
/// <summary>
- /// Gets the Z component of the gyroscope rotation vector.
+ /// Get the Z component of the gyroscope rotation vector.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <value> Z </value>
public float Z { get; private set; } = float.MinValue;
/// <summary>
- /// Gets the W component of the gyroscope rotation vector.
+ /// Get the W component of the gyroscope rotation vector.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <value> W </value>
public float W { get; private set; } = float.MinValue;
/// <summary>
- /// Gets the accuracy of the gyroscope rotation vector data.
+ /// Get the accuracy of the gyroscope rotation vector data.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <value> Accuracy </value>
public SensorDataAccuracy Accuracy { get; private set; }
/// <summary>
- /// Returns true or false based on whether the gyroscope rotation vector sensor is supported by the device.
+ /// Return true or false based on whether the gyroscope rotation vector sensor is supported by the device.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <value><c>true</c> if supported; otherwise <c>false</c>.</value>
}
/// <summary>
- /// Returns the number of the gyroscope rotation vector sensors available on the device.
+ /// Return the number of the gyroscope rotation vector sensors available on the system.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <value> The count of accelerometer rotation vector sensors. </value>
}
/// <summary>
- /// Initializes a new instance of the <see cref="Tizen.Sensor.GyroscopeRotationVectorSensor"/> class.
+ /// Initialize a new instance of the <see cref="Tizen.Sensor.GyroscopeRotationVectorSensor"/> class.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <feature>http://tizen.org/feature/sensor.gyroscope_rotation_vector</feature>
/// <exception cref="NotSupportedException">Thrown when the sensor is not supported.</exception>
/// <exception cref="InvalidOperationException">Thrown when the operation is invalid for the current state.</exception>
/// <param name='index'>
- /// Index. Default value for this is 0. Index refers to a particular gyroscope rotation vector sensor in case of multiple sensors.
+ /// Index refers to a particular gyroscope rotation vector sensor in case of multiple sensors.
+ /// Default value is 0.
/// </param>
public GyroscopeRotationVectorSensor(uint index = 0) : base(index)
{
/// An event handler for storing the callback functions for the event corresponding to the change in the gyroscope rotation vector sensor data.
/// </summary>
/// <since_tizen> 3 </since_tizen>
-
public event EventHandler<GyroscopeRotationVectorSensorDataUpdatedEventArgs> DataUpdated;
private static int GetCount()
private const string HRMKey = "http://tizen.org/feature/sensor.heart_rate_monitor";
/// <summary>
- /// Gets the value of the heart rate monitor.
+ /// Get the value of the heart rate monitor as int type.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <value> The heart rate. </value>
public int HeartRate { get; private set; } = int.MinValue;
/// <summary>
- /// Returns true or false based on whether the heart rate monitor is supported by the device.
+ /// Return true or false based on whether the heart rate monitor is supported by the system.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <value><c>true</c> if supported; otherwise <c>false</c>.</value>
}
/// <summary>
- /// Returns the number of heart rate monitors available on the device.
+ /// Return the number of heart rate monitors available on the system.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <value> The count of heart rate monitors. </value>
}
/// <summary>
- /// Initializes a new instance of the <see cref="Tizen.Sensor.HeartRateMonitor"/> class.
+ /// Initialize a new instance of the <see cref="Tizen.Sensor.HeartRateMonitor"/> class.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <privilege>http://tizen.org/privilege/healthinfo</privilege>
/// <exception cref="UnauthorizedAccessException">Thrown when the application has no privilege to use the sensor.</exception>
/// <exception cref="InvalidOperationException">Thrown when the operation is invalid for the current state.</exception>
/// <param name='index'>
- /// Index. Default value for this is 0. Index refers to a particular heart rate monitor in case of multiple sensors.
+ /// Index refers to a particular heart rate monitor in case of multiple sensors.
+ /// Default value is 0.
/// </param>
public HeartRateMonitor(uint index = 0) : base(index)
{
}
/// <summary>
- /// Gets the accuracy of the HeartRateMonitorBatch data.
+ /// Get the accuracy of the HeartRateMonitorBatch data as enum <see cref="SensorDataAccuracy"/> type.
/// </summary>
/// <since_tizen> 8 </since_tizen>
- /// <value> Accuracy </value>
+ /// <value> Accuracy, <seealso cref="SensorDataAccuracy"/>. </value>
public SensorDataAccuracy Accuracy { get; private set; } = SensorDataAccuracy.Undefined;
/// <summary>
- /// Returns true or false based on whether the HeartRateMonitorBatch sensor is supported by the device.
+ /// Return true or false based on whether the HeartRateMonitorBatch sensor is supported by the device.
/// </summary>
/// <since_tizen> 8 </since_tizen>
/// <value><c>true</c> if supported; otherwise <c>false</c>.</value>
}
/// <summary>
- /// Returns the number of HeartRateMonitorBatch sensors available on the device.
+ /// Return the number of HeartRateMonitorBatch sensors available on the system.
/// </summary>
/// <since_tizen> 8 </since_tizen>
/// <value> The count of HeartRateMonitorBatch sensors. </value>
}
/// <summary>
- /// Initializes a new instance of the <see cref="Tizen.Sensor.HeartRateMonitorBatch"/> class.
+ /// Initialize a new instance of the <see cref="Tizen.Sensor.HeartRateMonitorBatch"/> class.
/// </summary>
/// <since_tizen> 8 </since_tizen>
/// <privilege>http://tizen.org/privilege/healthinfo</privilege>
/// <exception cref="UnauthorizedAccessException">Thrown when the application has no privilege to use the sensor.</exception>
/// <exception cref="InvalidOperationException">Thrown when the operation is invalid for the current state.</exception>
/// <param name='index'>
- /// Index. Default value for this is 0. Index refers to a particular HeartRateMonitorBatch in case of multiple sensors.
+ /// Index refers to a particular HeartRateMonitorBatch in case of multiple sensors.
+ /// Default value is 0.
/// </param>
public HeartRateMonitorBatch(uint index = 0) : base(index)
{
/// An event handler for storing the callback functions for the event corresponding to the change in the HeartRateMonitorBatch data.
/// </summary>
/// <since_tizen> 8 </since_tizen>
-
public event EventHandler<HeartRateMonitorBatchDataUpdatedEventArgs> DataUpdated;
/// <summary>
/// An event handler for accuracy changed events.
+ /// If an event is added, a new accuracy change callback is registered for this sensor.
+ /// If an event is removed, accuracy change callback is unregistered for this sensor.
/// </summary>
/// <since_tizen> 8 </since_tizen>
public event EventHandler<SensorAccuracyChangedEventArgs> AccuracyChanged
}
/// <summary>
- /// Gets the accuracy of the auto HeartRateMonitorLEDGreenBatch data.
+ /// Get the accuracy of the auto HeartRateMonitorLEDGreenBatch data as enum <see cref="SensorDataAccuracy"/> type.
/// </summary>
/// <since_tizen> 8 </since_tizen>
- /// <value> Accuracy </value>
+ /// <value> Accuracy, <seealso cref="SensorDataAccuracy"/>. </value>
public SensorDataAccuracy Accuracy { get; private set; } = SensorDataAccuracy.Undefined;
/// <summary>
- /// Returns true or false based on whether the HeartRateMonitorLEDGreenBatch sensor is supported by the device.
+ /// Return true or false based on whether the HeartRateMonitorLEDGreenBatch sensor is supported by the system.
/// </summary>
/// <since_tizen> 8 </since_tizen>
/// <value><c>true</c> if supported; otherwise <c>false</c>.</value>
}
/// <summary>
- /// Returns the number of HeartRateMonitorLEDGreenBatch sensors available on the device.
+ /// Return the number of HeartRateMonitorLEDGreenBatch sensors available on the system.
/// </summary>
/// <since_tizen> 8 </since_tizen>
/// <value> The count of HeartRateMonitorLEDGreenBatch sensors. </value>
}
/// <summary>
- /// Initializes a new instance of the <see cref="Tizen.Sensor.HeartRateMonitorLEDGreenBatch"/> class.
+ /// Initialize a new instance of the <see cref="Tizen.Sensor.HeartRateMonitorLEDGreenBatch"/> class.
/// </summary>
/// <since_tizen> 8 </since_tizen>
/// <privilege>http://tizen.org/privilege/healthinfo</privilege>
/// <exception cref="UnauthorizedAccessException">Thrown when the application has no privilege to use the sensor.</exception>
/// <exception cref="InvalidOperationException">Thrown when the operation is invalid for the current state.</exception>
/// <param name='index'>
- /// Index. Default value for this is 0. Index refers to a particular HeartRateMonitorLEDGreenBatch sensor in case of multiple sensors.
+ /// Index refers to a particular HeartRateMonitorLEDGreenBatch sensor in case of multiple sensors.
+ /// Default value is 0.
/// </param>
public HeartRateMonitorLEDGreenBatch(uint index = 0) : base(index)
{
/// An event handler for storing the callback functions for the event corresponding to the change in the HeartRateMonitorLEDGreenBatch sensor data.
/// </summary>
/// <since_tizen> 8 </since_tizen>
-
public event EventHandler<HeartRateMonitorLEDGreenBatchDataUpdatedEventArgs> DataUpdated;
/// <summary>
/// An event handler for accuracy changed events.
+ /// If an event is added, a new accuracy change callback is registered for this sensor.
+ /// If an event is removed, accuracy change callback is unregistered for this sensor.
/// </summary>
/// <since_tizen> 8 </since_tizen>
public event EventHandler<SensorAccuracyChangedEventArgs> AccuracyChanged
private const string HumiditySensorKey = "http://tizen.org/feature/sensor.humidity";
/// <summary>
- /// Gets the value of the humidity sensor.
+ /// Get the value of the humidity sensor as float type.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <value> Humidity </value>
public float Humidity { get; private set; } = float.MinValue;
/// <summary>
- /// Returns true or false based on whether the humidity sensor is supported by the device.
+ /// Return true or false based on whether the humidity sensor is supported by the system.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <value><c>true</c> if supported; otherwise <c>false</c>.</value>
}
/// <summary>
- /// Returns the number of humidity sensors available on the device.
+ /// Return the number of humidity sensors available on the system.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <value> The count of humidity sensors. </value>
}
/// <summary>
- /// Initializes a new instance of the <see cref="Tizen.Sensor.HumiditySensor"/> class.
+ /// Initialize a new instance of the <see cref="Tizen.Sensor.HumiditySensor"/> class.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <feature>http://tizen.org/feature/sensor.humidity</feature>
/// <exception cref="NotSupportedException">Thrown when the sensor is not supported.</exception>
/// <exception cref="InvalidOperationException">Thrown when the operation is invalid for the current state.</exception>
/// <param name='index'>
- /// Index. Default value for this is 0. Index refers to a particular humidity sensor in case of multiple sensors.
+ /// Index refers to a particular humidity sensor in case of multiple sensors.
+ /// Default value is 0.
/// </param>
public HumiditySensor(uint index = 0) : base(index)
{
/// An event handler for storing the callback functions for the event corresponding to the change in the humidity sensor data.
/// </summary>
/// <since_tizen> 3 </since_tizen>
-
public event EventHandler<HumiditySensorDataUpdatedEventArgs> DataUpdated;
private static int GetCount()
private const string ActivityDetectorKey = "http://tizen.org/feature/sensor.activity_recognition";
/// <summary>
- /// Gets the state of the in-vehicle activity detector.
+ /// Get the state of the in-vehicle activity detector as enum <see cref="DetectorState"/> type.
/// </summary>
/// <since_tizen> 3 </since_tizen>
- /// <value> The in-vehicle state. </value>
+ /// <value> The in-vehicle state, <seealso cref="DetectorState"/>. </value>
public DetectorState InVehicle { get; private set; } = DetectorState.Unknown;
/// <summary>
- /// Returns true or false based on whether the in-vehicle activity detector is supported by the device.
+ /// Return true or false based on whether the in-vehicle activity detector is supported by the system.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <value><c>true</c> if supported; otherwise <c>false</c>.</value>
}
/// <summary>
- /// Returns the number of in-vehicle activity detectors available on the device.
+ /// Return the number of in-vehicle activity detectors available on the system.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <value> The count of in-vehicle activity detectors. </value>
}
/// <summary>
- /// Initializes a new instance of the <see cref="Tizen.Sensor.InVehicleActivityDetector"/> class.
+ /// Initialize a new instance of the <see cref="Tizen.Sensor.InVehicleActivityDetector"/> class.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <feature>http://tizen.org/feature/sensor.activity_recognition</feature>
/// <exception cref="NotSupportedException">Thrown when the sensor is not supported.</exception>
/// <exception cref="InvalidOperationException">Thrown when the operation is invalid for the current state.</exception>
/// <param name='index'>
- /// Index. Default value for this is 0. Index refers to a particular in-vehicle activity detector in case of multiple sensors.
+ /// Index refers to a particular in-vehicle activity detector in case of multiple sensors.
+ /// Default value is 0.
/// </param>
public InVehicleActivityDetector(uint index = 0) : base(index)
{
private const string LightSensorKey = "http://tizen.org/feature/sensor.photometer";
/// <summary>
- /// Gets the level of the light.
+ /// Get the light level of light sensor as float type.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <value> The light level. </value>
public float Level { get; private set; } = float.MinValue;
/// <summary>
- /// Returns true or false based on whether the light sensor is supported by the device.
+ /// Return true or false based on whether the light sensor is supported by the device.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <value><c>true</c> if supported; otherwise <c>false</c>.</value>
}
/// <summary>
- /// Returns the number of light sensors available on the device.
+ /// Return the number of light sensors available on the system.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <value> The count of light sensors. </value>
}
/// <summary>
- /// Initializes a new instance of the <see cref="Tizen.Sensor.LightSensor"/> class.
+ /// Initialize a new instance of the <see cref="Tizen.Sensor.LightSensor"/> class.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <feature>http://tizen.org/feature/sensor.photometer</feature>
/// <exception cref="NotSupportedException">Thrown when the sensor is not supported.</exception>
/// <exception cref="InvalidOperationException">Thrown when the operation is invalid for the current state.</exception>
/// <param name='index'>
- /// Index. Default value for this is 0. Index refers to a particular light sensor in case of multiple sensors.
+ /// Index refers to a particular light sensor in case of multiple sensors.
+ /// Default value is 0.
/// </param>
public LightSensor(uint index = 0) : base(index)
{
/// An event handler for storing the callback functions for the event corresponding to the change in the light sensor data.
/// </summary>
/// <since_tizen> 3 </since_tizen>
-
public event EventHandler<LightSensorDataUpdatedEventArgs> DataUpdated;
private static int GetCount()
private const string LinearAccelerationSensorKey = "http://tizen.org/feature/sensor.linear_acceleration";
private event EventHandler<SensorAccuracyChangedEventArgs> _accuracyChanged;
+
/// <summary>
- /// Gets the X component of the linear acceleration.
+ /// Get the X component value of the linear acceleration.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <value> X </value>
public float X { get; private set; } = float.MinValue;
/// <summary>
- /// Gets the Y component of the linear acceleration.
+ /// Get the Y component value of the linear acceleration.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <value> Y </value>
public float Y { get; private set; } = float.MinValue;
/// <summary>
- /// Gets the Z component of the linear acceleration.
+ /// Get the Z component value of the linear acceleration.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <value> Z </value>
public float Z { get; private set; } = float.MinValue;
/// <summary>
- /// Returns true or false based on whether the linear acceleration sensor is supported by the device.
+ /// Return true or false based on whether the linear acceleration sensor is supported by the device.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <value><c>true</c> if supported; otherwise <c>false</c>.</value>
}
/// <summary>
- /// Returns the number of linear acceleration sensors available on the device.
+ /// Return the number of linear acceleration sensors available on the system.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <value> The count of linear acceleration sensors. </value>
}
/// <summary>
- /// Initializes a new instance of the <see cref="Tizen.Sensor.LinearAccelerationSensor"/> class.
+ /// Initialize a new instance of the <see cref="Tizen.Sensor.LinearAccelerationSensor"/> class.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <feature>http://tizen.org/feature/sensor.linear_acceleration</feature>
/// <exception cref="NotSupportedException">Thrown when the sensor is not supported.</exception>
/// <exception cref="InvalidOperationException">Thrown when the operation is invalid for the current state.</exception>
/// <param name='index'>
- /// Index. Default value for this is 0. Index refers to a particular linear acceleration sensor in case of multiple sensors.
+ /// Index refers to a particular linear acceleration sensor in case of multiple sensors.
+ /// Default value is 0.
/// </param>
public LinearAccelerationSensor(uint index = 0) : base(index)
{
/// An event handler for storing the callback functions for the event corresponding to the change in the linear acceleration sensor data.
/// </summary>
/// <since_tizen> 3 </since_tizen>
-
public event EventHandler<LinearAccelerationSensorDataUpdatedEventArgs> DataUpdated;
/// <summary>
/// An event handler for accuracy changed events.
+ /// If an event is added, a new accuracy change callback is registered for this sensor.
+ /// If an event is removed, accuracy change callback is unregistered for this sensor.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public event EventHandler<SensorAccuracyChangedEventArgs> AccuracyChanged
private static string MagnetometerKey = "http://tizen.org/feature/sensor.magnetometer";
private event EventHandler<SensorAccuracyChangedEventArgs> _accuracyChanged;
+
/// <summary>
- /// Gets the X component of the magnetometer.
+ /// Get the X component value of the magnetometer as float type.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <value> X </value>
public float X { get; private set; } = float.MinValue;
/// <summary>
- /// Gets the Y component of the magnetometer.
+ /// Get the Y component value of the magnetometer as float type.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <value> Y </value>
public float Y { get; private set; } = float.MinValue;
/// <summary>
- /// Gets the Z component of the magnetometer.
+ /// Get the Z component value of the magnetometer as float type.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <value> Z </value>
public float Z { get; private set; } = float.MinValue;
/// <summary>
- /// Returns true or false based on whether magnetometer is supported by the device.
+ /// Return true or false based on whether magnetometer is supported by the system.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <value><c>true</c> if supported; otherwise <c>false</c>.</value>
}
/// <summary>
- /// Returns the number of magnetometers available on the device.
+ /// Return the number of magnetometers available on the system.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <value> The count of magnetometers. </value>
}
/// <summary>
- /// Initializes a new instance of the <see cref="Tizen.Sensor.Magnetometer"/> class.
+ /// Initialize a new instance of the <see cref="Tizen.Sensor.Magnetometer"/> class.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <feature>http://tizen.org/feature/sensor.magnetometer</feature>
/// <exception cref="NotSupportedException">Thrown when the sensor is not supported.</exception>
/// <exception cref="InvalidOperationException">Thrown when the operation is invalid for the current state.</exception>
/// <param name='index'>
- /// Index. Default value for this is 0. Index refers to a particular magnetometer in case of multiple sensors.
+ /// Index refers to a particular magnetometer in case of multiple sensors.
+ /// Default value is 0.
/// </param>
public Magnetometer(uint index = 0) : base(index)
{
/// An event handler for storing the callback functions for the event corresponding to the change in the magnetometer data.
/// </summary>
/// <since_tizen> 3 </since_tizen>
-
public event EventHandler<MagnetometerDataUpdatedEventArgs> DataUpdated;
/// <summary>
/// An event handler for accuracy changed events.
+ /// If an event is added, a new accuracy change callback is registered for this sensor.
+ /// If an event is removed, accuracy change callback is unregistered for this sensor.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public event EventHandler<SensorAccuracyChangedEventArgs> AccuracyChanged
private static string MagnetometerRVKey = "http://tizen.org/feature/sensor.geomagnetic_rotation_vector";
private event EventHandler<SensorAccuracyChangedEventArgs> _accuracyChanged;
+
/// <summary>
- /// Gets the X component of the magnetometer rotation vector.
+ /// Get the X component value of the magnetometer rotation vector as float type.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <value> X </value>
public float X { get; private set; } = float.MinValue;
/// <summary>
- /// Gets the Y component of the magnetometer rotation vector.
+ /// Get the Y component value of the magnetometer rotation vector as float type.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <value> Y </value>
public float Y { get; private set; } = float.MinValue;
/// <summary>
- /// Gets the Z component of the magnetometer rotation vector.
+ /// Get the Z component value of the magnetometer rotation vector as float type.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <value> Z </value>
public float Z { get; private set; } = float.MinValue;
/// <summary>
- /// Gets the W component of the magnetometer rotation vector.
+ /// Get the W component value of the magnetometer rotation vector as float type.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <value> W </value>
public float W { get; private set; } = float.MinValue;
/// <summary>
- /// Gets the accuracy of the magnetometer rotation vector data.
+ /// Get the accuracy of the magnetometer rotation vector data as enum <see cref="SensorDataAccuracy"/> type.
/// </summary>
/// <since_tizen> 3 </since_tizen>
- /// <value> Accuracy </value>
+ /// <value> Accuracy, <seealso cref="SensorDataAccuracy"/>. </value>
public SensorDataAccuracy Accuracy { get; private set; }
/// <summary>
- /// Returns true or false based on whether the magnetometer rotation vector sensor is supported by the device.
+ /// Return true or false based on whether the magnetometer rotation vector sensor is supported by the device.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <value><c>true</c> if supported; otherwise <c>false</c>.</value>
}
/// <summary>
- /// Returns the number of magnetometer rotation vector sensors available on the device.
+ /// Return the number of magnetometer rotation vector sensors available on the system.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <value> The count of magnetometer rotation vector sensors. </value>
}
/// <summary>
- /// Initializes a new instance of the <see cref="Tizen.Sensor.MagnetometerRotationVectorSensor"/> class.
+ /// Initialize a new instance of the <see cref="Tizen.Sensor.MagnetometerRotationVectorSensor"/> class.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <feature>http://tizen.org/feature/sensor.geomagnetic_rotation_vector</feature>
/// <exception cref="NotSupportedException">Thrown when the sensor is not supported.</exception>
/// <exception cref="InvalidOperationException">Thrown when the operation is invalid for the current state.</exception>
/// <param name='index'>
- /// Index. Default value for this is 0. Index refers to a particular magnetometer rotation vector sensor in case of multiple sensors.
+ /// Index refers to a particular magnetometer rotation vector sensor in case of multiple sensors.
+ /// Default value is 0.
/// </param>
public MagnetometerRotationVectorSensor(uint index = 0) : base(index)
{
/// An event handler for storing the callback functions for the event corresponding to the change in the magnetometer rotation vector sensor data.
/// </summary>
/// <since_tizen> 3 </since_tizen>
-
public event EventHandler<MagnetometerRotationVectorSensorDataUpdatedEventArgs> DataUpdated;
/// <summary>
/// An event handler for accuracy changed events.
+ /// If an event is added, a new accuracy change callback is registered for this sensor.
+ /// If an event is removed, accuracy change callback is unregistered for this sensor.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public event EventHandler<SensorAccuracyChangedEventArgs> AccuracyChanged
private static string OrientationSensorKey = "http://tizen.org/feature/sensor.tiltmeter";
private event EventHandler<SensorAccuracyChangedEventArgs> _accuracyChanged;
+
/// <summary>
- /// Gets the azimuth component of the orientation.
+ /// Get the azimuth component value of the orientation as float type.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <value> Azimuth </value>
public float Azimuth { get; private set; } = float.MinValue;
/// <summary>
- /// Gets the pitch component of the orientation.
+ /// Get the pitch component value of the orientation as float type.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <value> Pitch </value>
public float Pitch { get; private set; } = float.MinValue;
/// <summary>
- /// Gets the roll component of the orientation.
+ /// Get the roll component value of the orientation as float type.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <value> Roll </value>
public float Roll { get; private set; } = float.MinValue;
/// <summary>
- /// Returns true or false based on whether the orientation sensor is supported by the device.
+ /// Return true or false based on whether the orientation sensor is supported by the device.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <value><c>true</c> if supported; otherwise <c>false</c>.</value>
}
/// <summary>
- /// Returns the number of orientation sensors available on the device.
+ /// Return the number of orientation sensors available on the system.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <value> The count of orientation sensors. </value>
}
/// <summary>
- /// Initializes a new instance of the <see cref="Tizen.Sensor.OrientationSensor"/> class.
+ /// Initialize a new instance of the <see cref="Tizen.Sensor.OrientationSensor"/> class.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <feature>http://tizen.org/feature/sensor.tiltmeter</feature>
/// <exception cref="NotSupportedException">Thrown when the sensor is not supported.</exception>
/// <exception cref="InvalidOperationException">Thrown when the operation is invalid for the current state.</exception>
/// <param name='index'>
- /// Index. Default value for this is 0. Index refers to a particular orientation sensor in case of multiple sensors.
+ /// Index refers to a particular orientation sensor in case of multiple sensors.
+ /// Default value is 0.
/// </param>
public OrientationSensor(uint index = 0) : base(index)
{
/// An event handler for storing the callback functions for the event corresponding to the change in the orientation sensor data.
/// </summary>
/// <since_tizen> 3 </since_tizen>
-
public event EventHandler<OrientationSensorDataUpdatedEventArgs> DataUpdated;
/// <summary>
/// An event handler for accuracy changed events.
+ /// If an event is added, a new accuracy change callback is registered for this sensor.
+ /// If an event is removed, accuracy change callback is unregistered for this sensor.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public event EventHandler<SensorAccuracyChangedEventArgs> AccuracyChanged
private static string PedometerKey = "http://tizen.org/feature/sensor.pedometer";
/// <summary>
- /// Gets the step count.
+ /// Get the step count from pedometer as unsigned integer type.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <value> The step count. </value>
public uint StepCount { get; private set; } = 0;
/// <summary>
- /// Gets the walking step count.
+ /// Get the walking step count from pedometer as unsigned integer type.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <value> The walk step count. </value>
public uint WalkStepCount { get; private set; } = 0;
/// <summary>
- /// Gets the running step count.
+ /// Get the running step count from pedometer as unsigned integer type.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <value> The run step count. </value>
public uint RunStepCount { get; private set; } = 0;
/// <summary>
- /// Gets the moving distance.
+ /// Get the moving distance from pedometer as float type.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <value> The moving distance. </value>
public float MovingDistance { get; private set; } = 0;
/// <summary>
- /// Gets the calorie burned.
+ /// Get the calorie burned from pedometer as float type.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <value> The calorie burned. </value>
public float CalorieBurned { get; private set; } = 0;
/// <summary>
- /// Gets the last speed.
+ /// Get the last speed from pedometer as float type.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <value> The last speed. </value>
public float LastSpeed { get; private set; } = 0;
/// <summary>
- /// Gets the last stepping frequency.
+ /// Get the last stepping frequency from pedometer as float type.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <value> The last stepping frequency. </value>
public float LastSteppingFrequency { get; private set; } = 0;
/// <summary>
- /// Gets the last step status.
+ /// Get the last step status from pedometer as enum <see cref="PedometerState"/> type.
/// </summary>
/// <since_tizen> 3 </since_tizen>
- /// <value> The last step status. </value>
+ /// <value> The last step status, <seealso cref="PedometerState"/>. </value>
public PedometerState LastStepStatus { get; private set; } = PedometerState.Unknown;
/// <summary>
- /// Returns true or false based on whether the pedometer sensor is supported by the device.
+ /// Return true or false based on whether the pedometer sensor is supported by the device.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <value><c>true</c> if supported; otherwise <c>false</c>.</value>
}
/// <summary>
- /// Returns the number of pedometer sensors available on the device.
+ /// Return the number of pedometer sensors available on the system.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <value> The count of pedometer sensors. </value>
}
/// <summary>
- /// Initializes a new instance of the <see cref="Tizen.Sensor.Pedometer"/> class.
+ /// Initialize a new instance of the <see cref="Tizen.Sensor.Pedometer"/> class.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <privilege>http://tizen.org/privilege/healthinfo</privilege>
/// <exception cref="UnauthorizedAccessException">Thrown when the application has no privilege to use the sensor.</exception>
/// <exception cref="InvalidOperationException">Thrown when the operation is invalid for the current state.</exception>
/// <param name='index'>
- /// Index. Default value for this is 0. Index refers to a particular pedometer sensor in case of multiple sensors.
+ /// Index refers to a particular pedometer sensor in case of multiple sensors.
+ /// Default value is 0.
/// </param>
public Pedometer(uint index = 0) : base(index)
{
/// An event handler for storing the callback functions for the event corresponding to the change in the pedometer sensor data.
/// </summary>
/// <since_tizen> 3 </since_tizen>
-
public event EventHandler<PedometerDataUpdatedEventArgs> DataUpdated;
private static int GetCount()
private static string GestureDetectorKey = "http://tizen.org/feature/sensor.gesture_recognition";
/// <summary>
- /// Gets the state of the pick up gesture.
+ /// Get the state of the pick up gesture as enum <see cref="DetectorState"/> type.
/// </summary>
/// <since_tizen> 3 </since_tizen>
- /// <value> The pick up state. </value>
+ /// <value> The pick up state, <seealso cref="DetectorState"/>. </value>
public DetectorState PickUp { get; private set; } = DetectorState.Unknown;
/// <summary>
- /// Returns true or false based on whether the pick up gesture detector is supported by the device.
+ /// Return true or false based on whether the pick up gesture detector is supported by the system.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <value><c>true</c> if supported; otherwise <c>false</c>.</value>
}
/// <summary>
- /// Returns the number of pick up gesture detectors available on the device.
+ /// Return the number of pick up gesture detectors available on the system.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <value> The count of pick up gesture detectors. </value>
}
/// <summary>
- /// Initializes a new instance of the <see cref="Tizen.Sensor.PickUpGestureDetector"/> class.
+ /// Initialize a new instance of the <see cref="Tizen.Sensor.PickUpGestureDetector"/> class.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <feature>http://tizen.org/feature/sensor.gesture_recognition</feature>
/// <exception cref="NotSupportedException">Thrown when the sensor is not supported.</exception>
/// <exception cref="InvalidOperationException">Thrown when the operation is invalid for the current state.</exception>
/// <param name='index'>
- /// Index. Default value for this is 0. Index refers to a particular pick up gesture detector in case of multiple sensors.
+ /// Index refers to a particular pick up gesture detector in case of multiple sensors.
+ /// Default value is 0.
/// </param>
public PickUpGestureDetector(uint index = 0) : base(index)
{
private static string PressureSensorKey = "http://tizen.org/feature/sensor.barometer";
/// <summary>
- /// Gets the value of the pressure sensor.
+ /// Get the pressure value from the pressure sensor as float type.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <value> Pressure </value>
public float Pressure { get; private set; } = float.MinValue;
/// <summary>
- /// Returns true or false based on whether the pressure sensor is supported by the device.
+ /// Return true or false based on whether the pressure sensor is supported by the device.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <value><c>true</c> if supported; otherwise <c>false</c>.</value>
}
/// <summary>
- /// Returns the number of pressure sensors available on the device.
+ /// Return the number of pressure sensors available on the system.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <value> The count of pressure sensors. </value>
}
/// <summary>
- /// Initializes a new instance of the <see cref="Tizen.Sensor.PressureSensor"/> class.
+ /// Initialize a new instance of the <see cref="Tizen.Sensor.PressureSensor"/> class.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <feature>http://tizen.org/feature/sensor.barometer</feature>
/// <exception cref="NotSupportedException">Thrown when the sensor is not supported.</exception>
/// <exception cref="InvalidOperationException">Thrown when the operation is invalid for the current state.</exception>
/// <param name='index'>
- /// Index. Default value for this is 0. Index refers to a particular pressure sensor in case of multiple sensors.
+ /// Index refers to a particular pressure sensor in case of multiple sensors.
+ /// Default value is 0.
/// </param>
public PressureSensor(uint index = 0) : base(index)
{
/// An event handler for storing the callback functions for the event corresponding to the change in the pressure sensor data.
/// </summary>
/// <since_tizen> 3 </since_tizen>
-
public event EventHandler<PressureSensorDataUpdatedEventArgs> DataUpdated;
private static string ProximitySensorKey = "http://tizen.org/feature/sensor.proximity";
/// <summary>
- /// Gets the proximity state.
+ /// Get the proximity state as enum <see cref="ProximitySensorState"/> type.
/// </summary>
/// <since_tizen> 3 </since_tizen>
- /// <value> The proximity state. </value>
+ /// <value> The proximity state, <seealso cref="ProximitySensorState"/>. </value>
public ProximitySensorState Proximity { get; private set; } = ProximitySensorState.Unknown;
/// <summary>
- /// Returns true or false based on whether the proximity sensor is supported by the device.
+ /// Return true or false based on whether the proximity sensor is supported by the device.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <value><c>true</c> if supported; otherwise <c>false</c>.</value>
}
/// <summary>
- /// Returns the number of proximity sensors available on the device.
+ /// Return the number of proximity sensors available on the system.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <value> The count of proximity sensors. </value>
}
/// <summary>
- /// Initializes a new instance of the <see cref="Tizen.Sensor.ProximitySensor"/> class.
+ /// Initialize a new instance of the <see cref="Tizen.Sensor.ProximitySensor"/> class.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <feature>http://tizen.org/feature/sensor.proximity</feature>
/// <exception cref="NotSupportedException">Thrown when the sensor is not supported.</exception>
/// <exception cref="InvalidOperationException">Thrown when the operation is invalid for the current state.</exception>
/// <param name='index'>
- /// Index. Default value for this is 0. Index refers to a particular proximity sensor in case of multiple sensors.
+ /// Index refers to a particular proximity sensor in case of multiple sensors.
+ /// Default value is 0.
/// </param>
public ProximitySensor(uint index = 0) : base(index)
{
/// An event handler for storing the callback functions for the event corresponding to the change in the proximity sensor data.
/// </summary>
/// <since_tizen> 3 </since_tizen>
-
public event EventHandler<ProximitySensorDataUpdatedEventArgs> DataUpdated;
private static int GetCount()
private static string RotationVectorKey = "http://tizen.org/feature/sensor.rotation_vector";
private event EventHandler<SensorAccuracyChangedEventArgs> _accuracyChanged;
+
/// <summary>
- /// Gets the X component of the rotation vector.
+ /// Get the X component value of the rotation vector as float type.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <value> X </value>
public float X { get; private set; } = float.MinValue;
/// <summary>
- /// Gets the Y component of the rotation vector.
+ /// Get the Y component value of the rotation vector as float type.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <value> Y </value>
public float Y { get; private set; } = float.MinValue;
/// <summary>
- /// Gets the Z component of the rotation vector.
+ /// Get the Z component value of the rotation vector as float type.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <value> Z </value>
public float Z { get; private set; } = float.MinValue;
/// <summary>
- /// Gets the W component of the rotation vector.
+ /// Get the W component value of the rotation vector as float type.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <value> W </value>
public float W { get; private set; } = float.MinValue;
/// <summary>
- /// Gets the accuracy of the rotation vector data.
+ /// Get the accuracy value of the rotation vector data as enum <see cref="SensorDataAccuracy"/> type.
/// </summary>
/// <since_tizen> 3 </since_tizen>
- /// <value> Accuracy </value>
+ /// <value> Accuracy, <seealso cref="SensorDataAccuracy"/>. </value>
public SensorDataAccuracy Accuracy { get; private set; } = SensorDataAccuracy.Undefined;
/// <summary>
- /// Returns true or false based on whether the rotation vector sensor is supported by the device.
+ /// Return true or false based on whether the rotation vector sensor is supported by the device.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <value><c>true</c> if supported; otherwise <c>false</c>.</value>
}
/// <summary>
- /// Returns the number of rotation vector sensors available on the device.
+ /// Return the number of rotation vector sensors available on the system.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <value> The count of rotation vector sensors. </value>
}
/// <summary>
- /// Initializes a new instance of the <see cref="Tizen.Sensor.RotationVectorSensor"/> class.
+ /// Initialize a new instance of the <see cref="Tizen.Sensor.RotationVectorSensor"/> class.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <feature>http://tizen.org/feature/sensor.rotation_vector</feature>
/// <exception cref="NotSupportedException">Thrown when the sensor is not supported.</exception>
/// <exception cref="InvalidOperationException">Thrown when the operation is invalid for the current state.</exception>
/// <param name='index'>
- /// Index. Default value for this is 0. Index refers to a particular rotation vector sensor in case of multiple sensors.
+ /// Index refers to a particular rotation vector sensor in case of multiple sensors.
+ /// Default value is 0.
/// </param>
public RotationVectorSensor(uint index = 0) : base(index)
{
/// An event handler for storing the callback functions for the event corresponding to the change in the rotation vector sensor data.
/// </summary>
/// <since_tizen> 3 </since_tizen>
-
public event EventHandler<RotationVectorSensorDataUpdatedEventArgs> DataUpdated;
/// <summary>
/// An event handler for accuracy changed events.
+ /// If an event is added, a new accuracy change callback is registered for this sensor.
+ /// If an event is removed, accuracy change callback is unregistered for this sensor.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public event EventHandler<SensorAccuracyChangedEventArgs> AccuracyChanged
private static string ActivityDetectorKey = "http://tizen.org/feature/sensor.activity_recognition";
/// <summary>
- /// Gets the state of the running activity detector.
+ /// Get the state of the running activity detector as enum <see cref="DetectorState"/> type.
/// </summary>
/// <since_tizen> 3 </since_tizen>
- /// <value> The running state. </value>
+ /// <value> The running state, <seealso cref="DetectorState"/>. </value>
public DetectorState Running { get; private set; } = DetectorState.Unknown;
/// <summary>
- /// Returns true or false based on whether the running activity detector is supported by the device.
+ /// Return true or false based on whether the running activity detector is supported by the device.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <value><c>true</c> if supported; otherwise <c>false</c>.</value>
}
/// <summary>
- /// Returns the number of running activity detectors available on the device.
+ /// Return the number of running activity detectors available on the system.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <value> The count of running activity detectors. </value>
}
/// <summary>
- /// Initializes a new instance of the <see cref="Tizen.Sensor.RunningActivityDetector"/> class.
+ /// Initialize a new instance of the <see cref="Tizen.Sensor.RunningActivityDetector"/> class.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <feature>http://tizen.org/feature/sensor.activity_recognition</feature>
/// <exception cref="NotSupportedException">Thrown when the sensor is not supported.</exception>
/// <exception cref="InvalidOperationException">Thrown when the operation is invalid for the current state.</exception>
/// <param name='index'>
- /// Index. Default value for this is 0. Index refers to a particular running activity detector in case of multiple sensors.
+ /// Index refers to a particular running activity detector in case of multiple sensors.
+ /// Default value is 0.
/// </param>
public RunningActivityDetector(uint index = 0) : base(index)
{
private static string SleepMonitorKey = "http://tizen.org/feature/sensor.sleep_monitor";
/// <summary>
- /// Gets the value of the sleep state.
+ /// Get the value of the sleep state as enum <see cref="SleepMonitorState"/> type.
/// </summary>
/// <since_tizen> 3 </since_tizen>
- /// <value> The sleep state. </value>
+ /// <value> The sleep state, <seealso cref="SleepMonitorState"/>. </value>
public SleepMonitorState SleepState { get; private set; } = SleepMonitorState.Unknown;
/// <summary>
- /// Returns true or false based on whether the sleep monitor is supported by the device.
+ /// Return true or false based on whether the sleep monitor is supported by the device.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <value><c>true</c> if supported; otherwise <c>false</c>.</value>
}
/// <summary>
- /// Returns the number of sleep monitors available on the device.
+ /// Return the number of sleep monitors available on the system.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <value> The count of sleep monitors. </value>
}
/// <summary>
- /// Initializes a new instance of the <see cref="Tizen.Sensor.SleepMonitor"/> class.
+ /// Initialize a new instance of the <see cref="Tizen.Sensor.SleepMonitor"/> class.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <privilege>http://tizen.org/privilege/healthinfo</privilege>
/// <exception cref="UnauthorizedAccessException">Thrown when the application has no privilege to use the sensor.</exception>
/// <exception cref="InvalidOperationException">Thrown when the operation is invalid for the current state.</exception>
/// <param name='index'>
- /// Index. Default value for this is 0. Index refers to a particular sleep monitor in case of multiple sensors.
+ /// Index refers to a particular sleep monitor in case of multiple sensors.
+ /// Default value is 0.
/// </param>
public SleepMonitor(uint index = 0) : base(index)
{
/// An event handler for storing the callback functions for the event corresponding to the change in the sleep monitor data.
/// </summary>
/// <since_tizen> 3 </since_tizen>
-
public event EventHandler<SleepMonitorDataUpdatedEventArgs> DataUpdated;
private static string ActivityDetectorKey = "http://tizen.org/feature/sensor.activity_recognition";
/// <summary>
- /// Gets the state of the stationary activity detector.
+ /// Get the state of the stationary activity detector as enum <see cref="DetectorState"/> type.
/// </summary>
/// <since_tizen> 3 </since_tizen>
- /// <value> The stationary state. </value>
+ /// <value> The stationary state, <seealso cref="DetectorState"/>. </value>
public DetectorState Stationary { get; private set; } = DetectorState.Unknown;
/// <summary>
- /// Returns true or false based on whether the stationary activity detector is supported by the device.
+ /// Return true or false based on whether the stationary activity detector is supported by the device.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <value><c>true</c> if supported; otherwise <c>false</c>.</value>
}
/// <summary>
- /// Returns the number of stationary activity detectors available on the device.
+ /// Return the number of stationary activity detectors available on the system.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <value> The count of stationary activity detectors. </value>
}
/// <summary>
- /// Initializes a new instance of the <see cref="Tizen.Sensor.StationaryActivityDetector"/> class.
+ /// Initialize a new instance of the <see cref="Tizen.Sensor.StationaryActivityDetector"/> class.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <feature>http://tizen.org/feature/sensor.activity_recognition</feature>
/// <exception cref="NotSupportedException">Thrown when the sensor is not supported.</exception>
/// <exception cref="InvalidOperationException">Thrown when the operation is invalid for the current state.</exception>
/// <param name='index'>
- /// Index. Default value for this is 0. Index refers to a particular stationary activity detector in case of multiple sensors.
+ /// Index refers to a particular stationary activity detector in case of multiple sensors.
+ /// Default value is 0.
/// </param>
public StationaryActivityDetector(uint index = 0) : base(index)
{
private static string TemperatureSensorKey = "http://tizen.org/feature/sensor.temperature";
/// <summary>
- /// Gets the value of the temperature sensor.
+ /// Get the value of the temperature sensor as float type.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <value> Temperature (Celsius) </value>
public float Temperature { get; private set; } = float.MinValue;
/// <summary>
- /// Returns true or false based on whether the temperature sensor is supported by the device.
+ /// Return true or false based on whether the temperature sensor is supported by the device.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <value><c>true</c> if supported; otherwise <c>false</c>.</value>
}
/// <summary>
- /// Returns the number of temperature sensors available on the device.
+ /// Return the number of temperature sensors available on the system.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <value> The count of temperature sensors. </value>
}
/// <summary>
- /// Initializes a new instance of the <see cref="Tizen.Sensor.TemperatureSensor"/> class.
+ /// Initialize a new instance of the <see cref="Tizen.Sensor.TemperatureSensor"/> class.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <feature>http://tizen.org/feature/sensor.temperature</feature>
/// <exception cref="NotSupportedException">Thrown when the sensor is not supported.</exception>
/// <exception cref="InvalidOperationException">Thrown when the operation is invalid for the current state.</exception>
/// <param name='index'>
- /// Index. Default value for this is 0. Index refers to a particular temperature sensor in case of multiple sensors.
+ /// Index refers to a particular temperature sensor in case of multiple sensors.
+ /// Default value is 0.
/// </param>
public TemperatureSensor(uint index = 0) : base(index)
{
/// An event handler for storing the callback functions for the event corresponding to the change in the temperature sensor data.
/// </summary>
/// <since_tizen> 3 </since_tizen>
-
public event EventHandler<TemperatureSensorDataUpdatedEventArgs> DataUpdated;
private static string UltravioletSensorKey = "http://tizen.org/feature/sensor.ultraviolet";
/// <summary>
- /// Gets the value of the ultraviolet sensor.
+ /// Get the value of the ultraviolet sensor as float type.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <value> The ultraviolet index. </value>
public float UltravioletIndex { get; private set; } = float.MinValue;
/// <summary>
- /// Returns true or false based on whether the ultraviolet sensor is supported by the device.
+ /// Return true or false based on whether the ultraviolet sensor is supported by the device.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <value><c>true</c> if supported; otherwise <c>false</c>.</value>
}
/// <summary>
- /// Returns the number of ultraviolet sensors available on the device.
+ /// Return the number of ultraviolet sensors available on the system.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <value> The count of ultraviolet sensors. </value>
}
/// <summary>
- /// Initializes a new instance of the <see cref="Tizen.Sensor.UltravioletSensor"/> class.
+ /// Initialize a new instance of the <see cref="Tizen.Sensor.UltravioletSensor"/> class.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <feature>http://tizen.org/feature/sensor.ultraviolet</feature>
/// <exception cref="NotSupportedException">Thrown when the sensor is not supported.</exception>
/// <exception cref="InvalidOperationException">Thrown when the operation is invalid for the current state.</exception>
/// <param name='index'>
- /// Index. Default value for this is 0. Index refers to a particular ultraviolet sensor in case of multiple sensors.
+ /// Index refers to a particular ultraviolet sensor in case of multiple sensors.
+ /// Default value is 0.
/// </param>
public UltravioletSensor(uint index = 0) : base(index)
{
/// An event handler for storing the callback functions for the event corresponding to the change in the ultraviolet sensor data.
/// </summary>
/// <since_tizen> 3 </since_tizen>
-
public event EventHandler<UltravioletSensorDataUpdatedEventArgs> DataUpdated;
private static string UncalibratedGyroscopeKey = "http://tizen.org/feature/sensor.gyroscope.uncalibrated";
/// <summary>
- /// Gets the X component of the acceleration.
+ /// Get the X component value of the acceleration as float type.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <value> X </value>
public float X { get; private set; } = float.MinValue;
/// <summary>
- /// Gets the Y component of the acceleration.
+ /// Get the Y component value of the acceleration as float type.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <value> Y </value>
public float Y { get; private set; } = float.MinValue;
/// <summary>
- /// Gets the Z component of the acceleration.
+ /// Get the Z component value of the acceleration as float type.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <value> Z </value>
public float Z { get; private set; } = float.MinValue;
/// <summary>
- /// Gets the BiasX component of the uncalibrated gyroscope data.
+ /// Get the BiasX component value of the uncalibrated gyroscope data as float type.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <value> The X bias. </value>
public float BiasX { get; private set; } = 0;
/// <summary>
- /// Gets the BiasY component of the uncalibrated gyroscope data.
+ /// Get the BiasY component value of the uncalibrated gyroscope data as float type.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <value> The Y bias. </value>
public float BiasY { get; private set; } = 0;
/// <summary>
- /// Gets the BiasZ component of the uncalibrated gyroscope data.
+ /// Get the BiasZ component value of the uncalibrated gyroscope data as float type.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <value> The Z bias. </value>
public float BiasZ { get; private set; } = 0;
/// <summary>
- /// Returns true or false based on whether the uncalibrated gyroscope sensor is supported by the device.
+ /// Return true or false based on whether the uncalibrated gyroscope sensor is supported by the device.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <value><c>true</c> if supported; otherwise <c>false</c>.</value>
}
/// <summary>
- /// Returns the number of the uncalibrated gyroscope sensors available on the device.
+ /// Return the number of the uncalibrated gyroscope sensors available on the system.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <value> The count of the uncalibrated gyroscope sensors. </value>
}
/// <summary>
- /// Initializes a new instance of the <see cref="Tizen.Sensor.UncalibratedGyroscope"/> class.
+ /// Initialize a new instance of the <see cref="Tizen.Sensor.UncalibratedGyroscope"/> class.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <feature>http://tizen.org/feature/sensor.gyroscope.uncalibrated</feature>
/// <exception cref="NotSupportedException">Thrown when the sensor is not supported.</exception>
/// <exception cref="InvalidOperationException">Thrown when the operation is invalid for the current state.</exception>
/// <param name='index'>
- /// Index. Default value for this is 0. Index refers to a particular uncalibrated gyroscope sensor in case of multiple sensors.
+ /// Index refers to a particular uncalibrated gyroscope sensor in case of multiple sensors.
+ /// Default value is 0.
/// </param>
public UncalibratedGyroscope(uint index = 0) : base(index)
{
/// An event handler for storing the callback functions for the event corresponding to the change in the uncalibrated gyroscope sensor data.
/// </summary>
/// <since_tizen> 3 </since_tizen>
-
public event EventHandler<UncalibratedGyroscopeDataUpdatedEventArgs> DataUpdated;
private static int GetCount()
private static string UncalibratedMagnetometerKey = "http://tizen.org/feature/sensor.magnetometer.uncalibrated";
private event EventHandler<SensorAccuracyChangedEventArgs> _accuracyChanged;
+
/// <summary>
- /// Gets the X component of the acceleration.
+ /// Get the X component value of the acceleration as float type.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <value> X </value>
public float X { get; private set; } = float.MinValue;
/// <summary>
- /// Gets the Y component of the acceleration.
+ /// Get the Y component value of the acceleration as float type.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <value> Y </value>
public float Y { get; private set; } = float.MinValue;
/// <summary>
- /// Gets the Z component of the acceleration.
+ /// Get the Z component value of the acceleration as float type.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <value> Z </value>
public float Z { get; private set; } = float.MinValue;
/// <summary>
- /// Gets the BiasX component of the uncalibrated magnetometer data.
+ /// Get the BiasX component value of the uncalibrated magnetometer data as float type.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <value> The X bias. </value>
public float BiasX { get; private set; } = 0;
/// <summary>
- /// Gets the BiasY component of the uncalibrated magnetometer data.
+ /// Get the BiasY component value of the uncalibrated magnetometer data as float type.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <value> The Y bias. </value>
public float BiasY { get; private set; } = 0;
/// <summary>
- /// Gets the BiasZ component of the uncalibrated magnetometer data.
+ /// Get the BiasZ component value of the uncalibrated magnetometer data as float type.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <value> The Z bias. </value>
public float BiasZ { get; private set; } = 0;
/// <summary>
- /// Returns true or false based on whether the uncalibrated magnetometer sensor is supported by the device.
+ /// Return true or false based on whether the uncalibrated magnetometer sensor is supported by the device.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <value><c>true</c> if supported; otherwise <c>false</c>.</value>
}
/// <summary>
- /// Returns the number of uncalibrated magnetometer sensors available on the device.
+ /// Return the number of uncalibrated magnetometer sensors available on the system.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <value> The count of uncalibrated magnetometer sensors. </value>
}
/// <summary>
- /// Initializes a new instance of the <see cref="Tizen.Sensor.UncalibratedMagnetometer"/> class.
+ /// Initialize a new instance of the <see cref="Tizen.Sensor.UncalibratedMagnetometer"/> class.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <feature>http://tizen.org/feature/sensor.magnetometer.uncalibrated</feature>
/// <exception cref="NotSupportedException">Thrown when the sensor is not supported.</exception>
/// <exception cref="InvalidOperationException">Thrown when the operation is invalid for the current state.</exception>
/// <param name='index'>
- /// Index. Default value for this is 0. Index refers to a particular uncalibrated magnetometer sensor in case of multiple sensors.
+ /// Index refers to a particular uncalibrated magnetometer sensor in case of multiple sensors.
+ /// Default value is 0.
/// </param>
public UncalibratedMagnetometer(uint index = 0) : base(index)
{
/// An event handler for storing the callback functions for the event corresponding to the change in the uncalibrated magnetometer sensor data.
/// </summary>
/// <since_tizen> 3 </since_tizen>
-
public event EventHandler<UncalibratedMagnetometerDataUpdatedEventArgs> DataUpdated;
/// <summary>
/// An event handler for accuracy changed events.
+ /// If an event is added, a new accuracy change callback is registered for this sensor.
+ /// If an event is removed, accuracy change callback is unregistered for this sensor.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public event EventHandler<SensorAccuracyChangedEventArgs> AccuracyChanged
private static string ActivityDetectorKey = "http://tizen.org/feature/sensor.activity_recognition";
/// <summary>
- /// Gets the state of the walking activity detector.
+ /// Get the state of the walking activity detector as enum <see cref="DetectorState"/> type.
/// </summary>
/// <since_tizen> 3 </since_tizen>
- /// <value> The walking state. </value>
+ /// <value> The walking state, <seealso cref="DetectorState"/>. </value>
public DetectorState Walking { get; private set; } = DetectorState.Unknown;
/// <summary>
- /// Returns true or false based on whether the walking activity detector is supported by the device.
+ /// Return true or false based on whether the walking activity detector is supported by the device.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <value><c>true</c> if supported; otherwise <c>false</c>.</value>
}
/// <summary>
- /// Returns the number of walking activity detectors available on the device.
+ /// Return the number of walking activity detectors available on the system.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <value> The count of walking activity detectors. </value>
}
/// <summary>
- /// Initializes a new instance of the <see cref="Tizen.Sensor.WalkingActivityDetector"/> class.
+ /// Initialize a new instance of the <see cref="Tizen.Sensor.WalkingActivityDetector"/> class.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <feature>http://tizen.org/feature/sensor.activity_recognition</feature>
/// <exception cref="NotSupportedException">Thrown when the sensor is not supported.</exception>
/// <exception cref="InvalidOperationException">Thrown when the operation is invalid for the current state.</exception>
/// <param name='index'>
- /// Index. Default value for this is 0. Index refers to a particular walking activity detector in case of multiple sensors.
+ /// Index refers to a particular walking activity detector in case of multiple sensors.
+ /// Default value is 0.
/// </param>
public WalkingActivityDetector(uint index = 0) : base(index)
{
private static string WristUpKey = "http://tizen.org/feature/sensor.wrist_up";
/// <summary>
- /// Gets the state of the wrist up gesture.
+ /// Get the state of the wrist up gesture as enum <see cref="DetectorState"/> type.
/// </summary>
/// <since_tizen> 3 </since_tizen>
- /// <value> The wrist up state. </value>
+ /// <value> The wrist up state, <seealso cref="DetectorState"/>. </value>
public DetectorState WristUp { get; private set; } = DetectorState.Unknown;
/// <summary>
- /// Returns true or false based on whether the wrist up gesture detector is supported by the device.
+ /// Return true or false based on whether the wrist up gesture detector is supported by the device.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <value><c>true</c> if supported; otherwise <c>false</c>.</value>
}
/// <summary>
- /// Returns the number of wrist up gesture detectors available on the device.
+ /// Return the number of wrist up gesture detectors available on the system.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <value> The count of wrist up gesture detectors. </value>
}
/// <summary>
- /// Initializes a new instance of the <see cref="Tizen.Sensor.WristUpGestureDetector"/> class.
+ /// Initialize a new instance of the <see cref="Tizen.Sensor.WristUpGestureDetector"/> class.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <feature>http://tizen.org/feature/sensor.wrist_up</feature>
/// <exception cref="NotSupportedException">Thrown when the sensor is not supported.</exception>
/// <exception cref="InvalidOperationException">Thrown when the operation is invalid for the current state.</exception>
/// <param name='index'>
- /// Index. Default value for this is 0. Index refers to a particular wrist up gesture detector in case of multiple sensors.
+ /// Index refers to a particular wrist up gesture detector in case of multiple sensors.
+ /// Default value is 0.
/// </param>
public WristUpGestureDetector(uint index = 0) : base(index)
{
/// <summary>
- /// Read a sensor data synchronously.
+ /// Read sensor(which inherits this class) data synchronously.
/// </summary>
internal abstract void ReadData();
+
+ /// <summary>
+ /// Get the type of a sensor which inherits this class.
+ /// </summary>
internal abstract SensorType GetSensorType();
+
+ /// <summary>
+ /// Start to listen the event of a sensor which inherits this class.
+ /// </summary>
internal abstract void EventListenStart();
+
+ /// <summary>
+ /// Stop to listen the event of a sensor which inherits this class.
+ /// </summary>
internal abstract void EventListenStop();
+ /// <summary>
+ /// Update the internal batch event list using the latest events.
+ /// </summary>
+ /// <remarks>
+ /// It will be called for updating events about the sensor like
+ /// BatchSensor or Plugin classes which inherits this class.
+ /// </remarks>
+ /// <param name="eventsPtr">
+ /// General batch data's raw pointer
+ /// </param>
+ /// <param name="events_count">
+ /// Number of general batch events
+ /// </param>
internal void updateBatchEvents(IntPtr eventsPtr, uint events_count)
{
if (events_count >= 1)
}
}
+ /// <summary>
+ /// Return the last element of Batched elements, which is the latest
+ /// sensor event.
+ /// </summary>
+ /// <remarks>
+ /// If there is no event, default(Interop.SensorEventStruct) will be
+ /// returned.
+ /// </remarks>
internal Interop.SensorEventStruct latestEvent()
{
if (BatchedEvents.Count > 0)
return default(Interop.SensorEventStruct);
}
+ /// <summary>
+ /// Create the Sensor object to listen to the sensor events.
+ /// </summary>
internal Sensor(uint index)
{
SensorType type = GetSensorType();
}
/// <summary>
- /// Destroy the Sensor object.
+ /// Destroy the Sensor object and release all resources.
/// </summary>
~Sensor()
{
}
/// <summary>
- /// Property: Gets the name of the sensor.
+ /// Property: Gets the name of the sensor as a string.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <value> The name of the sensor. </value>
}
/// <summary>
- /// Property: Gets the vendor.
+ /// Property: Gets the vendor of the sensor as a string.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <value> The vendor name of the sensor. </value>
}
/// <summary>
- /// Property: Gets the resolution.
+ /// Property: Gets the resolution of the sensor as a float type.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <value> The resolution. </value>
}
/// <summary>
- /// Property: Gets the minimum interval.
+ /// Property: Gets the minimum interval of the sensor.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <value> The minimum update interval. </value>
}
/// <summary>
- /// Property: Gets the FIFO count.
+ /// Property: Gets the FIFO count of the sensor as int type.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <value> The size of the hardware FIFO. </value>
}
/// <summary>
- /// Property: Gets the maximum batch count.
+ /// Property: Gets the maximum batch count of the sensor.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <value> The maximum batch count. </value>
}
/// <summary>
- /// Sets the pause policy of the sensor.
+ /// Get the pause policy or set the pause policy of the sensor as the
+ /// set value.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <value>The pause policy.</value>
/// <summary>
/// Gets or sets the time span.
+ /// Set value will be used as its 'Ticks' attribute.
+ /// Get will return the newly allocated TimeSpan object with the same
+ /// ticks as the sensor's timestamp.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <value> The time span. </value>
}
/// <summary>
- /// Gets or sets the timestamp.
+ /// Gets or sets the timestamp of a sensor which inherits the sensor
+ /// class.
/// </summary>
/// <since_tizen> 8 </since_tizen>
/// <value> Timestamp. </value>
}
/// <summary>
- /// Indicates whether this sensor is sensing.
+ /// Indicate whether the sensor is sensing or not sensing.
/// </summary>
/// <since_tizen> 3 </since_tizen>
- /// <value><c>true</c> if this sensor is sensing; otherwise <c>false</c>.</value>
+ /// <value><c>true</c> if the sensor is sensing; otherwise <c>false</c>.</value>
public bool IsSensing
{
get
}
}
+ /// <summary>
+ /// Check if the sensor type is supported or not by the system.
+ /// </summary>
+ /// <param name="type">The sensor type to check.</param>
+ /// <param name="key">The key for the sensor type to check.</param>
+ /// <returns>True if the sensor type is supported, otherwise false.</returns>
internal static bool CheckIfSupported(SensorType type, String key)
{
bool isSupported = false;
}
/// <summary>
- /// Destroy the current object.
+ /// Destroy the current object and release all the resources.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public void Dispose()
}
}
+ /// <summary>
+ /// Gets the handle list of the sensors of a given type and index.
+ /// </summary>
+ /// <remarks>
+ /// A device may have more than one sensors of the given type.
+ /// In such case, the 'index'th sensor handle will be used.
+ /// </remarks>
private void GetHandleList(SensorType type, uint index)
{
IntPtr list;
Interop.Libc.Free(list);
}
+ /// <summary>
+ /// Get the following sensor properties of the sensor:
+ /// name, vendor, minimum range, maximum range, resolution, minimum interval, fifo count, maximum batch count
+ /// </summary>
private void GetProperty()
{
int error = (int)SensorError.None;
}
}
+ /// <summary>
+ /// Create a sensor listener and store a handle of the listener as an member variable.
+ /// </summary>
private void CreateListener()
{
int error = Interop.SensorListener.CreateListener(_sensorHandle, out _listenerHandle);
}
}
+ /// <summary>
+ /// Change the interval between updates for the sensor with the value stored in member variable.
+ /// </summary>
private void SetInterval()
{
if (CheckListenerHandle())
}
}
+ /// <summary>
+ /// Set the desired maximum batch latency of the sensor.
+ /// Sensors that support batching may allow applications to change their maximum batch latencies.
+ /// For example, if you set the latency as 10,000 ms, the sensor may store its data
+ /// up to 10,000 ms, before delivering the data through the HAL.
+ /// In case of non-batching sensors no error will be occured,
+ /// but nothing is affected by the input latency value.
+ /// </summary>
+ /// <remarks>
+ /// Even if you set a batch latency, the sensor may not work as you intended,
+ /// as one sensor can be used by more than one listeners.
+ /// In addition, some batch sensors may already have fixed batching latency
+ /// or batching queue size, which cannot be altered by applications.
+ /// </remarks>
private void SetMaxBatchLatency()
{
if (CheckListenerHandle())
}
}
+ /// <summary>
+ /// Check if listener handle for the sensor is valid or not.
+ /// </summary>
+ /// <remarks>
+ /// If listener handle is not valid, then it will throw ArgumentException.
+ /// </remarks>
+ /// <exception cref="ArgumentException">Thrown when the sensor listener handler is invalid.</exception>
+ /// <value><c>true</c> if listener handle is valid.</value>
private bool CheckListenerHandle()
{
bool result = false;
return result;
}
+ /// <summary>
+ /// Check if sensor handle for the sensor is valid or not.
+ /// If sensor handle is not valid, then it will throw ArgumentException.
+ /// </summary>
+ /// <exception cref="ArgumentException">Thrown when the sensor handler is invalid.</exception>
+ /// <value><c>true</c> if sensor handle is valid.</value>
private bool CheckSensorHandle()
{
bool result = false;
return result;
}
+ /// <summary>
+ /// Destroy resources of a listener handle of the sensor.
+ /// Release all resources allocated for a listener handle.
+ /// </summary>
+ /// <remarks>
+ /// If this function is called while the sensor is still running,
+ /// that is, then it is implicitly stopped.
+ /// </remarks>
private void DestroyHandles()
{
Interop.SensorListener.DestroyListener(_listenerHandle);
projects / platform / core / csapi / tizenfx.git / commitdiff