MagneticFieldSensorEvent Class Reference

A magnetic field sensor event, which measures the ambient magnetic field. More...

#include <MagneticFieldSensorEvent.hpp>

Inheritance diagram for MagneticFieldSensorEvent:

Public Types
enum	Type { Type_Key, Type_Motion, Type_Sensor, Type_Timer }
	Event types. More...

Public Member Functions
virtual	~MagneticFieldSensorEvent ()
	Destructor. More...
float	getFieldX () const
	Get the ambient magnetic field in the X-axis. More...
float	getFieldY () const
	Get the ambient magnetic field in the Y-axis. More...
float	getFieldZ () const
	Get the ambient magnetic field in the Z-axis. More...
Accuracy	getAccuracy () const
	Get the accuracy of the sensor event values. More...
float	getValue (int index) const throw ()
	Get a sensor value. More...
virtual time_ms_t	getEventTime () const
	Get the time at which this event occurred. More...
Sensor::Type	getSensorType () const
	Get the sensor type. More...
Type	getType () const
	Get the event type. More...

Detailed Description

A magnetic field sensor event, which measures the ambient magnetic field.

All values are in uT (micro-Tesla).

Author

Mark Lindner

Member Enumeration Documentation

Type

enum Type

inherited

Event types.

Enumerator
Type_Key	Key input events.
Type_Motion	Motion input events.
Type_Sensor	Sensor events.
Type_Timer	Timer events.

Constructor & Destructor Documentation

~MagneticFieldSensorEvent()

~MagneticFieldSensorEvent ( )

virtual

Destructor.

Member Function Documentation

getAccuracy()

Accuracy getAccuracy ( ) const

inlineinherited

Get the accuracy of the sensor event values.

getEventTime()

virtual time_ms_t getEventTime ( ) const

inlinevirtualinherited

Get the time at which this event occurred.

Implements Event.

getFieldX()

float getFieldX ( ) const

inline

Get the ambient magnetic field in the X-axis.

getFieldY()

float getFieldY ( ) const

inline

Get the ambient magnetic field in the Y-axis.

getFieldZ()

float getFieldZ ( ) const

inline

Get the ambient magnetic field in the Z-axis.

getSensorType()

Sensor::Type getSensorType ( ) const

inlineinherited

Get the sensor type.

getType()

Type getType ( ) const

inlineinherited

Get the event type.

getValue()

float getValue ( int  index ) const throw ( )

inherited

Get a sensor value.

Parameters

index

The value index. Must be between 0 and 15, inclusive. The number of significant values, and the meaning of each, is dependent on the sensor type.

Returns

The sensor value.

---

The documentation for this class was generated from the following files:

• MagneticFieldSensorEvent.hpp
• MagneticFieldSensorEvent.cpp