Class Sensor

Definition

Namespace:
Tizen.Sensor
Assembly:
Tizen.Sensor.dll
API Level:
3

The Sensor class is used for storing the hardware information about a particular sensor.

C#
Copy
public abstract class Sensor : IDisposable
Inheritance
System.Object
Sensor
Derived
Implements
System.IDisposable

Properties

View Source

FifoCount

Property: Gets the FIFO count.

Declaration
C#
Copy
public int FifoCount { get; }
Property Value
Type Description
Int32

The size of the hardware FIFO.

API Level: 3
View Source

Interval

Sets the interval of the sensor for the sensor data event. Callbacks will be called at the frequency of this interval.

Declaration
C#
Copy
public uint Interval { get; set; }
Property Value
Type Description
System.UInt32

The interval of the sensor.

Exceptions
Type Condition
System.InvalidOperationException

Thrown when the operation is invalid for the current state.

API Level: 3
View Source

IsSensing

Indicates whether this sensor is sensing.

Declaration
C#
Copy
public bool IsSensing { get; }
Property Value
Type Description
Boolean

true if this sensor is sensing; otherwise false.

API Level: 3
View Source

MaxBatchCount

Property: Gets the maximum batch count.

Declaration
C#
Copy
public int MaxBatchCount { get; }
Property Value
Type Description
Int32

The maximum batch count.

API Level: 3
View Source

MaxBatchLatency

Sets the maximum batch latency for the sensor corresponding to the sensor data event.

Declaration
C#
Copy
public uint MaxBatchLatency { get; set; }
Property Value
Type Description
System.UInt32

The maximum batch latency.

Exceptions
Type Condition
System.InvalidOperationException

Thrown when the operation is invalid for the current state.

API Level: 3
View Source

MaxValue

Property: Gets the maximum value of the range of the sensor data.

Declaration
C#
Copy
public float MaxValue { get; }
Property Value
Type Description
System.Single

The upper bound of the range of the sensor reading.

API Level: 3
View Source

MinInterval

Property: Gets the minimum interval.

Declaration
C#
Copy
public int MinInterval { get; }
Property Value
Type Description
Int32

The minimum update interval.

API Level: 3
View Source

MinValue

Property: Gets the minimum value of the range of the sensor data.

Declaration
C#
Copy
public float MinValue { get; }
Property Value
Type Description
System.Single

The lower bound of the range of the sensor reading.

API Level: 3
View Source

Name

Property: Gets the name of the sensor.

Declaration
C#
Copy
public string Name { get; }
Property Value
Type Description
System.String

The name of the sensor.

API Level: 3
View Source

PausePolicy

Sets the pause policy of the sensor.

Declaration
C#
Copy
public SensorPausePolicy PausePolicy { get; set; }
Property Value
Type Description
SensorPausePolicy

The pause policy.

Exceptions
Type Condition
System.InvalidOperationException

Thrown when the operation is invalid for the current state.

API Level: 3
View Source

Resolution

Property: Gets the resolution.

Declaration
C#
Copy
public float Resolution { get; }
Property Value
Type Description
System.Single

The resolution.

API Level: 3
View Source

TimeSpan

Gets or sets the time span.

Declaration
C#
Copy
public TimeSpan TimeSpan { get; set; }
Property Value
Type Description
TimeSpan

The time span.

API Level: 3
View Source

Timestamp

Gets or sets the timestamp.

Declaration
C#
Copy
public ulong Timestamp { get; set; }
Property Value
Type Description
System.UInt64

Timestamp.

API Level: 8
View Source

Vendor

Property: Gets the vendor.

Declaration
C#
Copy
public string Vendor { get; }
Property Value
Type Description
System.String

The vendor name of the sensor.

API Level: 3

Methods

View Source

Dispose()

Destroy the current object.

Declaration
C#
Copy
public void Dispose()
API Level: 3
View Source

Dispose(Boolean)

Releases all resources currently used by this instance.

Declaration
C#
Copy
protected virtual void Dispose(bool disposing)
Parameters
Type Name Description
Boolean disposing

true if managed resources should be disposed otherwise, false.

API Level: 3
View Source

Finalize()

Destroy the Sensor object.

Declaration
C#
Copy
protected void Finalize()
View Source

Start()

Starts the sensor. After this, event handlers will start receiving events.

Declaration
C#
Copy
public void Start()
Exceptions
Type Condition
System.InvalidOperationException

Thrown when the operation is invalid for the current state.

API Level: 3
View Source

Stop()

Stops the sensor. After this, event handlers will stop receiving events.

Declaration
C#
Copy
public void Stop()
Exceptions
Type Condition
System.InvalidOperationException

Thrown when the operation is invalid for the current state.

API Level: 3

Implements

System.IDisposable