io.github.robolib.module.sensor

Enum HMC5883L.OutputRate

java.lang.Object

java.lang.Enum<HMC5883L.OutputRate>

io.github.robolib.module.sensor.HMC5883L.OutputRate

All Implemented Interfaces:

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

Enclosing class:

HMC5883L

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

Data Output Rate Bits These bits set the rate at which data is written to all three data output registers.

Author:

noriah

Enum Constant Summary

Enum Constants

Enum Constant and Description
k075Hz 0.75Hz
k15Hz 15.0Hz (Default)
k1P5Hz 1.50Hz
k30Hz 30.0Hz
k3Hz 3.00Hz
k75Hz 75.0Hz
k7P5Hz 7.50Hz
RATE_RES Reserved

Field Summary

Fields

Modifier and Type	Field and Description
byte	value

Method Summary

Modifier and Type	Method and Description
static HMC5883L.OutputRate	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static HMC5883L.OutputRate[]	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

k075Hz

public static final HMC5883L.OutputRate k075Hz

0.75Hz

k1P5Hz

public static final HMC5883L.OutputRate k1P5Hz

1.50Hz

k3Hz

public static final HMC5883L.OutputRate k3Hz

3.00Hz

k7P5Hz

public static final HMC5883L.OutputRate k7P5Hz

7.50Hz

k15Hz

public static final HMC5883L.OutputRate k15Hz

15.0Hz (Default)

k30Hz

public static final HMC5883L.OutputRate k30Hz

30.0Hz

k75Hz

public static final HMC5883L.OutputRate k75Hz

75.0Hz

RATE_RES

public static final HMC5883L.OutputRate RATE_RES

Reserved

Field Detail

value

public byte value

Method Detail

values

public static HMC5883L.OutputRate[] 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.OutputRate c : HMC5883L.OutputRate.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.OutputRate 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