Package com.ctre.phoenixpro.sim

Enum ChassisReference

java.lang.Object

java.lang.Enum<ChassisReference>

com.ctre.phoenixpro.sim.ChassisReference

All Implemented Interfaces:

Serializable, Comparable<ChassisReference>, java.lang.constant.Constable

@Deprecated(forRemoval=true)
public enum ChassisReference
extends Enum<ChassisReference>

Deprecated, for removal: This API element is subject to removal in a future version.

Classes in the phoenixpro package will be removed in 2024. Users should instead use classes from the phoenix6 package.

Represents the orientation of a device relative to the robot chassis.

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
Clockwise_Positive	Deprecated, for removal: This API element is subject to removal in a future version. The device should read a clockwise rotation as positive motion.
CounterClockwise_Positive	Deprecated, for removal: This API element is subject to removal in a future version. The device should read a counter-clockwise rotation as positive motion.

Method Summary

Modifier and Type	Method	Description
static ChassisReference	valueOf(String name)	Deprecated, for removal: This API element is subject to removal in a future version. Returns the enum constant of this type with the specified name.
static ChassisReference[]	values()	Deprecated, for removal: This API element is subject to removal in a future version. 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, 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

CounterClockwise_Positive

public static final ChassisReference CounterClockwise_Positive

Deprecated, for removal: This API element is subject to removal in a future version.

The device should read a counter-clockwise rotation as positive motion.

Clockwise_Positive

public static final ChassisReference Clockwise_Positive

Deprecated, for removal: This API element is subject to removal in a future version.

The device should read a clockwise rotation as positive motion.

Method Details

values

public static ChassisReference[] values()

Deprecated, for removal: This API element is subject to removal in a future version.

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

Returns:

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

valueOf

public static ChassisReference valueOf(String name)

Deprecated, for removal: This API element is subject to removal in a future version.

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:

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

NullPointerException - if the argument is null