Class Magnetometer

    Definition

    Namespace:
    Tizen.Sensor
    Assembly:
    Tizen.Sensor.dll

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

    public sealed class Magnetometer : Sensor, IDisposable
    Inheritance
    object
    Sensor
    Magnetometer
    Implements
    System.IDisposable

    Constructors

    View Source

    Magnetometer(uint)

    Initializes a new instance of the Magnetometer class.

    Declaration
    public Magnetometer(uint index = 0)
    Parameters
    Type Name Description
    uint 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.

    Properties

    View Source

    Count

    Returns the number of magnetometers available on the device.

    Declaration
    public static int Count { get; }
    Property Value
    Type Description
    int

    The count of magnetometers.

    View Source

    IsSupported

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

    Declaration
    public static bool IsSupported { get; }
    Property Value
    Type Description
    bool

    true if supported; otherwise false.

    View Source

    X

    Gets the X component of the magnetometer.

    Declaration
    public float X { get; }
    Property Value
    Type Description
    float

    X

    View Source

    Y

    Gets the Y component of the magnetometer.

    Declaration
    public float Y { get; }
    Property Value
    Type Description
    float

    Y

    View Source

    Z

    Gets the Z component of the magnetometer.

    Declaration
    public float Z { get; }
    Property Value
    Type Description
    float

    Z

    Events

    View Source

    AccuracyChanged

    An event handler for accuracy changed events.

    Declaration
    public event EventHandler<SensorAccuracyChangedEventArgs> AccuracyChanged
    Event Type
    Type Description
    System.EventHandler<TEventArgs><SensorAccuracyChangedEventArgs>
    View Source

    DataUpdated

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

    Declaration
    public event EventHandler<MagnetometerDataUpdatedEventArgs> DataUpdated
    Event Type
    Type Description
    System.EventHandler<TEventArgs><MagnetometerDataUpdatedEventArgs>

    Implements

    System.IDisposable
    • View Source
    Back to top Copyright © 2016-2024 Samsung
    Generated by DocFX