SwerveDrivetrain.DriveMode (RooSwerve 2.1.0 API)

java.lang.Object
- java.lang.Enum<SwerveDrivetrain.DriveMode>
- - frc.team4373.swerve.SwerveDrivetrain.DriveMode

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<SwerveDrivetrain.DriveMode>

Enclosing class:

SwerveDrivetrain
```
public static enum SwerveDrivetrain.DriveMode
extends java.lang.Enum<SwerveDrivetrain.DriveMode>
```
The drive mode for the swerve bot.
The modes are as follows:
- North-up mode maintains a constant sense of north using the gyro (i.e., pushing the joystick forward moves in the same direction regardless of the robot's orientation)
- Own-ship-up mode always drives relative to the front of the robot (i.e., pushing the joystick forward moves the robot in the direction it is facing)

Enum Constant Summary

Enum Constants
Enum Constant Description

NORTH_UP

OWN_SHIP_UP

Method Summary

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