Package edu.wpi.first.wpilibj.smartdashboard

Class SendableBuilderImpl

java.lang.Object

edu.wpi.first.wpilibj.smartdashboard.SendableBuilderImpl

All Implemented Interfaces:

NTSendableBuilder, SendableBuilder, AutoCloseable

public class SendableBuilderImpl
extends Object
implements NTSendableBuilder

Nested Class Summary

Nested classes/interfaces inherited from interface edu.wpi.first.util.sendable.SendableBuilder

SendableBuilder.BackendKind

Constructor Summary

Constructors

Constructor	Description
SendableBuilderImpl()

Method Summary

Modifier and Type	Method	Description
void	addBooleanArrayProperty(String key, Supplier<boolean[]> getter, Consumer<boolean[]> setter)	Add a boolean array property.
void	addBooleanProperty(String key, BooleanSupplier getter, BooleanConsumer setter)	Add a boolean property.
void	addCloseable(AutoCloseable closeable)	Adds a closeable.
void	addDoubleArrayProperty(String key, Supplier<double[]> getter, Consumer<double[]> setter)	Add a double array property.
void	addDoubleProperty(String key, DoubleSupplier getter, DoubleConsumer setter)	Add a double property.
void	addFloatArrayProperty(String key, Supplier<float[]> getter, Consumer<float[]> setter)	Add a float array property.
void	addFloatProperty(String key, FloatSupplier getter, FloatConsumer setter)	Add a float property.
void	addIntegerArrayProperty(String key, Supplier<long[]> getter, Consumer<long[]> setter)	Add an integer array property.
void	addIntegerProperty(String key, LongSupplier getter, LongConsumer setter)	Add an integer property.
void	addRawProperty(String key, String typeString, Supplier<byte[]> getter, Consumer<byte[]> setter)	Add a raw property.
void	addStringArrayProperty(String key, Supplier<String[]> getter, Consumer<String[]> setter)	Add a string array property.
void	addStringProperty(String key, Supplier<String> getter, Consumer<String> setter)	Add a string property.
void	clearProperties()	Clear properties.
void	close()
NetworkTable	getTable()	Get the network table.
Topic	getTopic(String key)	Add a property without getters or setters.
boolean	isActuator()	Return whether this sendable should be treated as an actuator.
boolean	isPublished()	Return whether this sendable has an associated table.
void	publishConstBoolean(String key, boolean value)	Add a constant boolean property.
void	publishConstBooleanArray(String key, boolean[] value)	Add a constant boolean array property.
void	publishConstDouble(String key, double value)	Add a constant double property.
void	publishConstDoubleArray(String key, double[] value)	Add a constant double array property.
void	publishConstFloat(String key, float value)	Add a constant float property.
void	publishConstFloatArray(String key, float[] value)	Add a constant float array property.
void	publishConstInteger(String key, long value)	Add a constant integer property.
void	publishConstIntegerArray(String key, long[] value)	Add a constant integer property.
void	publishConstRaw(String key, String typestring, byte[] value)	Add a constant raw property.
void	publishConstString(String key, String value)	Add a constant string property.
void	publishConstStringArray(String key, String[] value)	Add a constant string array property.
void	setActuator(boolean value)	Set a flag indicating if this sendable should be treated as an actuator.
void	setSafeState(Runnable func)	Set the function that should be called to set the Sendable into a safe state.
void	setSmartDashboardType(String type)	Set the string representation of the named data type that will be used by the smart dashboard for this sendable.
void	setTable(NetworkTable table)	Set the network table.
void	setUpdateTable(Runnable func)	Set the function that should be called to update the network table for things other than properties.
void	startListeners()	Hook setters for all properties.
void	startLiveWindowMode()	Start LiveWindow mode by hooking the setters for all properties.
void	stopListeners()	Unhook setters for all properties.
void	stopLiveWindowMode()	Stop LiveWindow mode by unhooking the setters for all properties.
void	update()	Update the network table values by calling the getters for all properties.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface edu.wpi.first.networktables.NTSendableBuilder

getBackendKind

Constructor Details

SendableBuilderImpl

public SendableBuilderImpl()

Method Details

close

public void close()

Specified by:

close in interface AutoCloseable

setTable

public void setTable(NetworkTable table)

Set the network table. Must be called prior to any Add* functions being called.

Parameters:

table - Network table

getTable

public NetworkTable getTable()

Get the network table.

Specified by:

getTable in interface NTSendableBuilder

Returns:

The network table

isPublished

public boolean isPublished()

Return whether this sendable has an associated table.

Specified by:

isPublished in interface SendableBuilder

Returns:

True if it has a table, false if not.

isActuator

public boolean isActuator()

Return whether this sendable should be treated as an actuator.

Returns:

True if actuator, false if not.

update

public void update()

Update the network table values by calling the getters for all properties.

Specified by:

update in interface SendableBuilder

startListeners

public void startListeners()

Hook setters for all properties.

stopListeners

public void stopListeners()

Unhook setters for all properties.

startLiveWindowMode

public void startLiveWindowMode()

Start LiveWindow mode by hooking the setters for all properties. Also calls the safeState function if one was provided.

stopLiveWindowMode

public void stopLiveWindowMode()

Stop LiveWindow mode by unhooking the setters for all properties. Also calls the safeState function if one was provided.

clearProperties

public void clearProperties()

Clear properties.

Specified by:

clearProperties in interface SendableBuilder

addCloseable

public void addCloseable(AutoCloseable closeable)

Description copied from interface: SendableBuilder

Adds a closeable. The closeable.close() will be called when close() is called.

Specified by:

addCloseable in interface SendableBuilder

Parameters:

closeable - closeable object

setSmartDashboardType

public void setSmartDashboardType(String type)

Set the string representation of the named data type that will be used by the smart dashboard for this sendable.

Specified by:

setSmartDashboardType in interface SendableBuilder

Parameters:

type - data type

setActuator

public void setActuator(boolean value)

Set a flag indicating if this sendable should be treated as an actuator. By default, this flag is false.

Specified by:

setActuator in interface SendableBuilder

Parameters:

value - true if actuator, false if not

setSafeState

public void setSafeState(Runnable func)

Set the function that should be called to set the Sendable into a safe state. This is called when entering and exiting Live Window mode.

Specified by:

setSafeState in interface SendableBuilder

Parameters:

func - function

setUpdateTable

public void setUpdateTable(Runnable func)

Set the function that should be called to update the network table for things other than properties. Note this function is not passed the network table object; instead it should use the topics returned by getTopic().

Specified by:

setUpdateTable in interface NTSendableBuilder

Parameters:

func - function

getTopic

public Topic getTopic(String key)

Add a property without getters or setters. This can be used to get entry handles for the function called by setUpdateTable().

Specified by:

getTopic in interface NTSendableBuilder

Parameters:

key - property name

Returns:

Network table entry

addBooleanProperty

public void addBooleanProperty(String key, BooleanSupplier getter, BooleanConsumer setter)

Add a boolean property.

Specified by:

addBooleanProperty in interface SendableBuilder

Parameters:

key - property name

getter - getter function (returns current value)

setter - setter function (sets new value)

publishConstBoolean

public void publishConstBoolean(String key, boolean value)

Description copied from interface: SendableBuilder

Add a constant boolean property.

Specified by:

publishConstBoolean in interface SendableBuilder

Parameters:

key - property name

value - the value

addIntegerProperty

public void addIntegerProperty(String key, LongSupplier getter, LongConsumer setter)

Add an integer property.

Specified by:

addIntegerProperty in interface SendableBuilder

Parameters:

key - property name

getter - getter function (returns current value)

setter - setter function (sets new value)

publishConstInteger

public void publishConstInteger(String key, long value)

Description copied from interface: SendableBuilder

Add a constant integer property.

Specified by:

publishConstInteger in interface SendableBuilder

Parameters:

key - property name

value - the value

addFloatProperty

public void addFloatProperty(String key, FloatSupplier getter, FloatConsumer setter)

Add a float property.

Specified by:

addFloatProperty in interface SendableBuilder

Parameters:

key - property name

getter - getter function (returns current value)

setter - setter function (sets new value)

publishConstFloat

public void publishConstFloat(String key, float value)

Description copied from interface: SendableBuilder

Add a constant float property.

Specified by:

publishConstFloat in interface SendableBuilder

Parameters:

key - property name

value - the value

addDoubleProperty

public void addDoubleProperty(String key, DoubleSupplier getter, DoubleConsumer setter)

Add a double property.

Specified by:

addDoubleProperty in interface SendableBuilder

Parameters:

key - property name

getter - getter function (returns current value)

setter - setter function (sets new value)

publishConstDouble

public void publishConstDouble(String key, double value)

Description copied from interface: SendableBuilder

Add a constant double property.

Specified by:

publishConstDouble in interface SendableBuilder

Parameters:

key - property name

value - the value

addStringProperty

public void addStringProperty(String key, Supplier<String> getter, Consumer<String> setter)

Add a string property.

Specified by:

addStringProperty in interface SendableBuilder

Parameters:

key - property name

getter - getter function (returns current value)

setter - setter function (sets new value)

publishConstString

public void publishConstString(String key, String value)

Description copied from interface: SendableBuilder

Add a constant string property.

Specified by:

publishConstString in interface SendableBuilder

Parameters:

key - property name

value - the value

addBooleanArrayProperty

public void addBooleanArrayProperty(String key, Supplier<boolean[]> getter, Consumer<boolean[]> setter)

Add a boolean array property.

Specified by:

addBooleanArrayProperty in interface SendableBuilder

Parameters:

key - property name

getter - getter function (returns current value)

setter - setter function (sets new value)

publishConstBooleanArray

public void publishConstBooleanArray(String key, boolean[] value)

Description copied from interface: SendableBuilder

Add a constant boolean array property.

Specified by:

publishConstBooleanArray in interface SendableBuilder

Parameters:

key - property name

value - the value

addIntegerArrayProperty

public void addIntegerArrayProperty(String key, Supplier<long[]> getter, Consumer<long[]> setter)

Add an integer array property.

Specified by:

addIntegerArrayProperty in interface SendableBuilder

Parameters:

key - property name

getter - getter function (returns current value)

setter - setter function (sets new value)

publishConstIntegerArray

public void publishConstIntegerArray(String key, long[] value)

Description copied from interface: SendableBuilder

Add a constant integer property.

Specified by:

publishConstIntegerArray in interface SendableBuilder

Parameters:

key - property name

value - the value

addFloatArrayProperty

public void addFloatArrayProperty(String key, Supplier<float[]> getter, Consumer<float[]> setter)

Add a float array property.

Specified by:

addFloatArrayProperty in interface SendableBuilder

Parameters:

key - property name

getter - getter function (returns current value)

setter - setter function (sets new value)

publishConstFloatArray

public void publishConstFloatArray(String key, float[] value)

Description copied from interface: SendableBuilder

Add a constant float array property.

Specified by:

publishConstFloatArray in interface SendableBuilder

Parameters:

key - property name

value - the value

addDoubleArrayProperty

public void addDoubleArrayProperty(String key, Supplier<double[]> getter, Consumer<double[]> setter)

Add a double array property.

Specified by:

addDoubleArrayProperty in interface SendableBuilder

Parameters:

key - property name

getter - getter function (returns current value)

setter - setter function (sets new value)

publishConstDoubleArray

public void publishConstDoubleArray(String key, double[] value)

Description copied from interface: SendableBuilder

Add a constant double array property.

Specified by:

publishConstDoubleArray in interface SendableBuilder

Parameters:

key - property name

value - the value

addStringArrayProperty

public void addStringArrayProperty(String key, Supplier<String[]> getter, Consumer<String[]> setter)

Add a string array property.

Specified by:

addStringArrayProperty in interface SendableBuilder

Parameters:

key - property name

getter - getter function (returns current value)

setter - setter function (sets new value)

publishConstStringArray

public void publishConstStringArray(String key, String[] value)

Description copied from interface: SendableBuilder

Add a constant string array property.

Specified by:

publishConstStringArray in interface SendableBuilder

Parameters:

key - property name

value - the value

addRawProperty

public void addRawProperty(String key, String typeString, Supplier<byte[]> getter, Consumer<byte[]> setter)

Add a raw property.

Specified by:

addRawProperty in interface SendableBuilder

Parameters:

key - property name

typeString - type string

getter - getter function (returns current value)

setter - setter function (sets new value)

publishConstRaw

public void publishConstRaw(String key, String typestring, byte[] value)

Description copied from interface: SendableBuilder

Add a constant raw property.

Specified by:

publishConstRaw in interface SendableBuilder

Parameters:

key - property name

typestring - type string

value - the value