Package edu.wpi.first.apriltag

Enum AprilTagFields

java.lang.Object

java.lang.Enum<AprilTagFields>

edu.wpi.first.apriltag.AprilTagFields

All Implemented Interfaces:

Serializable, Comparable<AprilTagFields>, Constable

public enum AprilTagFields
extends Enum<AprilTagFields>

Loadable AprilTag field layouts.

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
k2022RapidReact	2022 Rapid React.
k2023ChargedUp	2023 Charged Up.
k2024Crescendo	2024 Crescendo.

Field Summary

Fields

Modifier and Type	Field	Description
static String	kBaseResourceDir	Base resource directory.
static AprilTagFields	kDefaultField	Alias to the current game.
String	m_resourceFile	Resource filename.

Method Summary

Modifier and Type	Method	Description
AprilTagFieldLayout	loadAprilTagLayoutField()	Get a AprilTagFieldLayout from the resource JSON.
static AprilTagFields	valueOf(String name)	Returns the enum constant of this type with the specified name.
static AprilTagFields[]	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, 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

k2022RapidReact

public static final AprilTagFields k2022RapidReact

2022 Rapid React.

k2023ChargedUp

public static final AprilTagFields k2023ChargedUp

2023 Charged Up.

k2024Crescendo

public static final AprilTagFields k2024Crescendo

2024 Crescendo.

Field Details

kBaseResourceDir

public static final String kBaseResourceDir

Base resource directory.

See Also:

Constant Field Values

kDefaultField

public static final AprilTagFields kDefaultField

Alias to the current game.

m_resourceFile

public final String m_resourceFile

Resource filename.

Method Details

values

public static AprilTagFields[] values()

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 AprilTagFields valueOf(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:

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

NullPointerException - if the argument is null

loadAprilTagLayoutField

public AprilTagFieldLayout loadAprilTagLayoutField()

Get a AprilTagFieldLayout from the resource JSON.

Returns:

AprilTagFieldLayout of the field

Throws:

UncheckedIOException - If the layout does not exist