Package com.studica.frc

Enum Class AHRS.BoardAxis

java.lang.Object

java.lang.Enum<AHRS.BoardAxis>

com.studica.frc.AHRS.BoardAxis

All Implemented Interfaces:

Serializable, Comparable<AHRS.BoardAxis>, Constable

Enclosing class:

AHRS

public static enum AHRS.BoardAxis
extends Enum<AHRS.BoardAxis>

Identifies one of the three sensing axes on the navX sensor board. Note that these axes are board-relative ("Board Frame"), and are not necessarily the same as the logical axes of the chassis on which the sensor is mounted. For more information on sensor orientation, please see the navX sensor Orientation page.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
kBoardAxisX
kBoardAxisY
kBoardAxisZ

Method Summary

Modifier and Type	Method	Description
int	getValue()
static AHRS.BoardAxis	valueOf(String name)	Returns the enum constant of this class with the specified name.
static AHRS.BoardAxis[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

kBoardAxisX

public static final AHRS.BoardAxis kBoardAxisX

kBoardAxisY

public static final AHRS.BoardAxis kBoardAxisY

kBoardAxisZ

public static final AHRS.BoardAxis kBoardAxisZ

Method Details

values

public static AHRS.BoardAxis[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

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

valueOf

public static AHRS.BoardAxis valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null

getValue

public int getValue()