Package com.marswars.dashboard

Record Class DashboardChannel

java.lang.Object

java.lang.Record

com.marswars.dashboard.DashboardChannel

public record DashboardChannel(String name, DashboardChannel.Type type, DashboardChannel.Direction direction)
extends Record

Describes one NetworkTables channel exposed by a DashboardBridge: its wire name, primitive type, and whether the dashboard is allowed to write to it.

BIDIRECTIONAL channels subscribe on the bridge's ToRobot table (the dashboard writes, the robot reads) and mirror the robot's authoritative value back out on the ToDashboard table. OUTPUT_ONLY channels only publish on ToDashboard -- there is nothing for the dashboard to tell the robot (e.g. whether the current match is an elimination match, which the robot determines for itself).

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	DashboardChannel.Direction
static enum	DashboardChannel.Type

Constructor Summary

Constructors

Constructor	Description
DashboardChannel(String name, DashboardChannel.Type type, DashboardChannel.Direction direction)	Creates an instance of a DashboardChannel record class.

Method Summary

Modifier and Type	Method	Description
static DashboardChannel	bidirectionalBool(String name)
static DashboardChannel	bidirectionalInt(String name)
DashboardChannel.Direction	direction()	Returns the value of the direction record component.
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
final int	hashCode()	Returns a hash code value for this object.
String	name()	Returns the value of the name record component.
static DashboardChannel	outputBool(String name)
static DashboardChannel	outputInt(String name)
final String	toString()	Returns a string representation of this record class.
DashboardChannel.Type	type()	Returns the value of the type record component.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

DashboardChannel

public DashboardChannel(String name,
 DashboardChannel.Type type,
 DashboardChannel.Direction direction)

Creates an instance of a DashboardChannel record class.

Parameters:

name - the value for the name record component

type - the value for the type record component

direction - the value for the direction record component

Method Details

bidirectionalInt

public static DashboardChannel bidirectionalInt(String name)

outputInt

public static DashboardChannel outputInt(String name)

bidirectionalBool

public static DashboardChannel bidirectionalBool(String name)

outputBool

public static DashboardChannel outputBool(String name)

toString

public final String toString()

Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.

Specified by:

toString in class Record

Returns:

a string representation of this object

hashCode

public final int hashCode()

Returns a hash code value for this object. The value is derived from the hash code of each of the record components.

Specified by:

hashCode in class Record

Returns:

a hash code value for this object

equals

public final boolean equals(Object o)

Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with Objects::equals(Object,Object).

Specified by:

equals in class Record

Parameters:

o - the object with which to compare

Returns:

true if this object is the same as the o argument; false otherwise.

name

public String name()

Returns the value of the name record component.

Returns:

the value of the name record component

type

public DashboardChannel.Type type()

Returns the value of the type record component.

Returns:

the value of the type record component

direction

public DashboardChannel.Direction direction()

Returns the value of the direction record component.

Returns:

the value of the direction record component