Package edu.wpi.first.wpilibj.shuffleboard

Enum EventImportance

java.lang.Object

java.lang.Enum<EventImportance>

edu.wpi.first.wpilibj.shuffleboard.EventImportance

All Implemented Interfaces:

Serializable, Comparable<EventImportance>, Constable

public enum EventImportance
extends Enum<EventImportance>

The importance of an event marker in Shuffleboard. The exact meaning of each importance level is up for interpretation on a team-to-team basis, but users should follow the general guidelines of the various importance levels. The examples given are for reference and may be ignored or considered to be more or less important from team to team.

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
kCritical	A critically important event such as a brownout, component failure, or software deadlock.
kHigh	A high-importance event such as scoring a game piece.
kLow	A low importance event such as acquisition of a game piece.
kNormal	A "normal" importance event, such as a transition from autonomous mode to teleoperated control.
kTrivial	A trivial event such as a change in command state.

Method Summary

Modifier and Type	Method	Description
String	getSimpleName()	Returns name of the given enum.
static EventImportance	valueOf(String name)	Returns the enum constant of this type with the specified name.
static EventImportance[]	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

kTrivial

public static final EventImportance kTrivial

A trivial event such as a change in command state.

kLow

public static final EventImportance kLow

A low importance event such as acquisition of a game piece.

kNormal

public static final EventImportance kNormal

A "normal" importance event, such as a transition from autonomous mode to teleoperated control.

kHigh

public static final EventImportance kHigh

A high-importance event such as scoring a game piece.

kCritical

public static final EventImportance kCritical

A critically important event such as a brownout, component failure, or software deadlock.

Method Details

values

public static EventImportance[] 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 EventImportance 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

getSimpleName

public String getSimpleName()

Returns name of the given enum.

Returns:

Name of the given enum.