Class UncalibratedMagnetometer

View Source

Definition

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

The UncalibratedMagnetometer sensor class is used for registering callbacks for the uncalibrated magnetometer and getting the uncalibrated magnetometer data.


                
C#

                

                    
Copy

                    

                

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

Constructors

View Source

UncalibratedMagnetometer(uint)

Initializes a new instance of the UncalibratedMagnetometer class.

Declaration

                
C#

                

                    
Copy

                    

                

            
public UncalibratedMagnetometer(uint index = 0)
Parameters
Type Name Description
uint index

Index. Default value for this is 0. Index refers to a particular uncalibrated magnetometer sensor 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

BiasX

Gets the BiasX component of the uncalibrated magnetometer data.

Declaration

                
C#

                

                    
Copy

                    

                

            
public float BiasX { get; }
Property Value
Type Description
float

The X bias.
View Source

BiasY

Gets the BiasY component of the uncalibrated magnetometer data.

Declaration

                
C#

                

                    
Copy

                    

                

            
public float BiasY { get; }
Property Value
Type Description
float

The Y bias.
View Source

BiasZ

Gets the BiasZ component of the uncalibrated magnetometer data.

Declaration

                
C#

                

                    
Copy

                    

                

            
public float BiasZ { get; }
Property Value
Type Description
float

The Z bias.
View Source

Count

Returns the number of uncalibrated magnetometer sensors available on the device.

Declaration

                
C#

                

                    
Copy

                    

                

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

The count of uncalibrated magnetometer sensors.
View Source

IsSupported

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

Declaration

                
C#

                

                    
Copy

                    

                

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

true if supported; otherwise false.
View Source

X

Gets the X component of the acceleration.

Declaration

                
C#

                

                    
Copy

                    

                

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

X
View Source

Y

Gets the Y component of the acceleration.

Declaration

                
C#

                

                    
Copy

                    

                

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

Y
View Source

Z

Gets the Z component of the acceleration.

Declaration

                
C#

                

                    
Copy

                    

                

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

Z

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<TEventArgs><SensorAccuracyChangedEventArgs>
View Source

DataUpdated

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

Declaration

                
C#

                

                    
Copy

                    

                

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

Implements

System.IDisposable