io.github.robolib.module.sensor

Enum HMC5883L.MeasurementMode

java.lang.Object

java.lang.Enum<HMC5883L.MeasurementMode>

io.github.robolib.module.sensor.HMC5883L.MeasurementMode

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<HMC5883L.MeasurementMode>

Enclosing class:

HMC5883L

public static enum HMC5883L.MeasurementMode
extends java.lang.Enum<HMC5883L.MeasurementMode>

Measurement Configuration Bits. These bits define the measurement flow of the device, specifically whether or not to incorporate an applied bias into the measurement.

Author:

noriah

Enum Constant Summary

Enum Constants

Enum Constant and Description
kNEGBIAS Negative bias configuration for X, Y and Z axes In this configuration, a negative current is forced across the resistive load for all three axes.
kNORMAL Normal Measurement Config (Default) In normal measurement configuration the device follows normal measurement flow.
kPOSBIAS Positive bias configuration for X, Y, and Z axes In this configuration, a positive current is forced across the resistive load for all three axes.
MODE_RES Reserved

Field Summary

Fields

Modifier and Type	Field and Description
byte	value

Method Summary

Modifier and Type	Method and Description
static HMC5883L.MeasurementMode	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static HMC5883L.MeasurementMode[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

kNORMAL

public static final HMC5883L.MeasurementMode kNORMAL

Normal Measurement Config (Default) In normal measurement configuration the device follows normal measurement flow. The positive and negative pins of the resistive load are left floating and high impedance.

kPOSBIAS

public static final HMC5883L.MeasurementMode kPOSBIAS

Positive bias configuration for X, Y, and Z axes In this configuration, a positive current is forced across the resistive load for all three axes.

kNEGBIAS

public static final HMC5883L.MeasurementMode kNEGBIAS

Negative bias configuration for X, Y and Z axes In this configuration, a negative current is forced across the resistive load for all three axes.

MODE_RES

public static final HMC5883L.MeasurementMode MODE_RES

Reserved

Field Detail

value

public byte value

Method Detail

values

public static HMC5883L.MeasurementMode[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (HMC5883L.MeasurementMode c : HMC5883L.MeasurementMode.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static HMC5883L.MeasurementMode valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null