Enum Class VisionConstants.Camera

java.lang.Object

java.lang.Enum<VisionConstants.Camera>

com.stuypulse.robot.subsystems.vision.VisionConstants.Camera

All Implemented Interfaces:

Serializable, Comparable<VisionConstants.Camera>, Constable

Enclosing interface:

VisionConstants

public static enum VisionConstants.Camera
extends Enum<VisionConstants.Camera>

Represents a camera from its physical position and identified by name.

An constant of this enum looks like this NAME("detailed name", new Transform3d(x, y, z, rotation), 1.0);

Nested Class Summary

Nested classes/interfaces inherited from class Enum

Enum.EnumDesc<E>

Field Summary

Fields

Modifier and Type	Field	Description
private final VisionConstants.CameraData	data

Constructor Summary

Constructors

Modifier	Constructor	Description
private	Camera(String name, org.wpilib.math.geometry.Transform3d robotToCamera, double stdDevFactor)	Internal constructor to setup a camera with a VisionConstants.CameraData instance

Method Summary

Modifier and Type	Method	Description
VisionConstants.CameraData	getData()	Gets the backing data object
String	getName()
org.wpilib.math.geometry.Transform3d	getRobotToCamera()
double	getStdDevFactor()
static VisionConstants.Camera	valueOf(String name)	Returns the enum constant of this class with the specified name.
static VisionConstants.Camera[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class Enum

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

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

Field Details

data

private final VisionConstants.CameraData data

Constructor Details

Camera

private Camera(String name,
 org.wpilib.math.geometry.Transform3d robotToCamera,
 double stdDevFactor)

Internal constructor to setup a camera with a VisionConstants.CameraData instance

Parameters:

name - name of the camera, can be more detailed than its simple enum constant's name

robotToCamera - transformation from the robot origin to the camera's position

stdDevFactor - scalar factor to multiply the camrea's standard deviations by

Method Details

values

public static VisionConstants.Camera[] 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 VisionConstants.Camera 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

getName

public String getName()

getRobotToCamera

public org.wpilib.math.geometry.Transform3d getRobotToCamera()

getStdDevFactor

public double getStdDevFactor()

getData

public VisionConstants.CameraData getData()

Gets the backing data object

Returns:

The corresponding VisionConstants.CameraData instance