net.happybrackets.device.sensors

Class Magnetometer

java.lang.Object

net.happybrackets.device.sensors.Sensor

net.happybrackets.device.sensors.Magnetometer

All Implemented Interfaces:

MagnetometerSensor

public class Magnetometer
extends Sensor
implements MagnetometerSensor

Default Accelerometer for HB. The type of accelerometer will be detected and listeners will register to receive Accelerometer events

Field Summary

Fields inherited from class net.happybrackets.device.sensors.Sensor

simulatedOnly, validLoad

Constructor Summary

Constructors

Constructor and Description
Magnetometer() Loads the default connected sensor

Method Summary

Modifier and Type	Method and Description
double[]	getMagnetometerData()
float	getMagnetometerX()
float	getMagnetometerY()
float	getMagnetometerZ()
java.lang.String	getSensorName() Returns the sensor name, typically the make/model of the hardware sensor that this class refers to.
void	reloadSimulation() Override this on any classes you need to do something as a simulated sensor
void	resetToDefault() Remove all rounding
Magnetometer	setRounding(int resolution) Set the resolution for all three axis to the number of decimal places set by resolution.
void	setXRounding(int resolution) Set the resolution for X axis to the number of decimal places set by resolution.
void	setYRounding(int resolution) Set the resolution for Y axis to the number of decimal places set by resolution.
void	setZRounding(int resolution) Set the resolution for Z axis to the number of decimal places set by resolution.

Methods inherited from class net.happybrackets.device.sensors.Sensor

addListener, addNonResettableListener, addNonResettableValueChangedListener, addValueChangedListener, clearListeners, getSensor, isSimulatedOnly, isValidLoadedSensor, notifyListeners, removeListener, removeListener, roundValue, scaleValue, setSimulatedOnly, setValidLoad, storeSensor

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Magnetometer

public Magnetometer()

Loads the default connected sensor

Method Detail

resetToDefault

public void resetToDefault()

Remove all rounding

Overrides:

resetToDefault in class Sensor

reloadSimulation

public void reloadSimulation()

Description copied from class: Sensor

Override this on any classes you need to do something as a simulated sensor

Overrides:

reloadSimulation in class Sensor

setRounding

public Magnetometer setRounding(int resolution)

Set the resolution for all three axis to the number of decimal places set by resolution. A value of -1 will remove rounding

Parameters:

resolution - the number of decimal places to round to. -1 will be no rounding

Returns:

this object

setXRounding

public void setXRounding(int resolution)

Set the resolution for X axis to the number of decimal places set by resolution. A value of -1 will remove rounding

Parameters:

resolution - the number of decimal places to round to. -1 will be no rounding

setYRounding

public void setYRounding(int resolution)

Set the resolution for Y axis to the number of decimal places set by resolution. A value of -1 will remove rounding

Parameters:

resolution - the number of decimal places to round to. -1 will be no rounding

setZRounding

public void setZRounding(int resolution)

Set the resolution for Z axis to the number of decimal places set by resolution. A value of -1 will remove rounding

Parameters:

resolution - the number of decimal places to round to. -1 will be no rounding

getSensorName

public java.lang.String getSensorName()

Description copied from class: Sensor

Returns the sensor name, typically the make/model of the hardware sensor that this class refers to.

Specified by:

getSensorName in class Sensor

Returns:

a String representing the sensor's name.

getMagnetometerData

public double[] getMagnetometerData()

Specified by:

getMagnetometerData in interface MagnetometerSensor

getMagnetometerX

public float getMagnetometerX()

Specified by:

getMagnetometerX in interface MagnetometerSensor

getMagnetometerY

public float getMagnetometerY()

Specified by:

getMagnetometerY in interface MagnetometerSensor

getMagnetometerZ

public float getMagnetometerZ()

Specified by:

getMagnetometerZ in interface MagnetometerSensor