io.github.robolib.module.sensor

Enum HMC5883L.Axis

java.lang.Object

java.lang.Enum<HMC5883L.Axis>

io.github.robolib.module.sensor.HMC5883L.Axis

All Implemented Interfaces:

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

Enclosing class:

HMC5883L

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

Enum representation of each of the three Axes.

Author:

noriah

Enum Constant Summary

Enum Constants

Enum Constant and Description
X
Y
Z

Field Summary

Fields

Modifier and Type	Field and Description
byte	value

Method Summary

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

X

public static final HMC5883L.Axis X

Z

public static final HMC5883L.Axis Z

Y

public static final HMC5883L.Axis Y

Field Detail

value

public byte value

Method Detail

values

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