Class Magnetometer

Definition

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

The Magnetometer class is used for registering callbacks for the magnetometer and getting the magnetometer data.

C#
Copy
public sealed class Magnetometer : Sensor, IDisposable
Inheritance
System.Object
Magnetometer
Implements
System.IDisposable

Constructors

View Source

Magnetometer(UInt32)

Initializes a new instance of the Magnetometer class.

Declaration
C#
Copy
public Magnetometer(uint index = 0U)
Parameters
Type Name Description
System.UInt32 index

Index. Default value for this is 0. Index refers to a particular magnetometer in case of multiple sensors.

Exceptions
Type Condition
System.ArgumentException

Thrown when an invalid argument is used.

System.NotSupportedException

Thrown when the sensor is not supported.

System.InvalidOperationException

Thrown when the operation is invalid for the current state.

API Level: 3
Feature: http://tizen.org/feature/sensor.magnetometer

Properties

View Source

Count

Returns the number of magnetometers available on the device.

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

The count of magnetometers.

API Level: 3
View Source

IsSupported

Returns true or false based on whether magnetometer is supported by the device.

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

true if supported; otherwise false.

API Level: 3
View Source

X

Gets the X component of the magnetometer.

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

X

API Level: 3
View Source

Y

Gets the Y component of the magnetometer.

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

Y

API Level: 3
View Source

Z

Gets the Z component of the magnetometer.

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

Z

API Level: 3

Events

View Source

AccuracyChanged

An event handler for accuracy changed events.

Declaration
C#
Copy
public event EventHandler<SensorAccuracyChangedEventArgs> AccuracyChanged
Event Type
Type Description
System.EventHandler<SensorAccuracyChangedEventArgs>
API Level: 3
View Source

DataUpdated

An event handler for storing the callback functions for the event corresponding to the change in the magnetometer data.

Declaration
C#
Copy
public event EventHandler<MagnetometerDataUpdatedEventArgs> DataUpdated
Event Type
Type Description
System.EventHandler<MagnetometerDataUpdatedEventArgs>
API Level: 3

Implements

System.IDisposable