AHRS.BoardAxis (navx_frc API)

java.lang.Object
- java.lang.Enum<AHRS.BoardAxis>
- - com.kauailabs.navx.frc.AHRS.BoardAxis

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<AHRS.BoardAxis>

Enclosing class:

AHRS
```
public static enum AHRS.BoardAxis
extends java.lang.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.

Enum Constant Summary

Enum Constants
Enum Constant Description

kBoardAxisX

kBoardAxisY

kBoardAxisZ

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`int`	`getValue()`
`static AHRS.BoardAxis`	`valueOf(java.lang.String name)`	Returns the enum constant of this type with the specified name.
`static AHRS.BoardAxis[]`	`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
  - kBoardAxisX
```
public static final AHRS.BoardAxis kBoardAxisX
```
  - kBoardAxisY
```
public static final AHRS.BoardAxis kBoardAxisY
```
  - kBoardAxisZ
```
public static final AHRS.BoardAxis kBoardAxisZ
```
- Method Detail
  - values
```
public static AHRS.BoardAxis[] 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 (AHRS.BoardAxis c : AHRS.BoardAxis.values()) System.out.println(c);
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static AHRS.BoardAxis 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
  - getValue
```
public int getValue()
```