edu.wpi.first.wpilibj.smartdashboard

Interface SendableBuilder

All Known Implementing Classes:

SendableBuilderImpl

public interface SendableBuilder

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	SendableBuilder.BooleanConsumer Represents an operation that accepts a single boolean-valued argument and returns no result.

Method Summary

Modifier and Type	Method and Description
void	addBooleanArrayProperty(java.lang.String key, java.util.function.Supplier<boolean[]> getter, java.util.function.Consumer<boolean[]> setter) Add a boolean array property.
void	addBooleanProperty(java.lang.String key, java.util.function.BooleanSupplier getter, SendableBuilder.BooleanConsumer setter) Add a boolean property.
void	addDoubleArrayProperty(java.lang.String key, java.util.function.Supplier<double[]> getter, java.util.function.Consumer<double[]> setter) Add a double array property.
void	addDoubleProperty(java.lang.String key, java.util.function.DoubleSupplier getter, java.util.function.DoubleConsumer setter) Add a double property.
void	addRawProperty(java.lang.String key, java.util.function.Supplier<byte[]> getter, java.util.function.Consumer<byte[]> setter) Add a raw property.
void	addStringArrayProperty(java.lang.String key, java.util.function.Supplier<java.lang.String[]> getter, java.util.function.Consumer<java.lang.String[]> setter) Add a string array property.
void	addStringProperty(java.lang.String key, java.util.function.Supplier<java.lang.String> getter, java.util.function.Consumer<java.lang.String> setter) Add a string property.
void	addValueProperty(java.lang.String key, java.util.function.Supplier<NetworkTableValue> getter, java.util.function.Consumer<NetworkTableValue> setter) Add a NetworkTableValue property.
NetworkTableEntry	getEntry(java.lang.String key) Add a property without getters or setters.
void	setSafeState(java.lang.Runnable func) Set the function that should be called to set the Sendable into a safe state.
void	setSmartDashboardType(java.lang.String type) Set the string representation of the named data type that will be used by the smart dashboard for this sendable.
void	setUpdateTable(java.lang.Runnable func) Set the function that should be called to update the network table for things other than properties.

Method Detail

setSmartDashboardType

void setSmartDashboardType(java.lang.String type)

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

Parameters:

type - data type

setSafeState

void setSafeState(java.lang.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.

Parameters:

func - function

setUpdateTable

void setUpdateTable(java.lang.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 entry handles returned by getEntry().

Parameters:

func - function

getEntry

NetworkTableEntry getEntry(java.lang.String key)

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

Parameters:

key - property name

Returns:

Network table entry

addBooleanProperty

void addBooleanProperty(java.lang.String key,
                        java.util.function.BooleanSupplier getter,
                        SendableBuilder.BooleanConsumer setter)

Add a boolean property.

Parameters:

key - property name

getter - getter function (returns current value)

setter - setter function (sets new value)

addDoubleProperty

void addDoubleProperty(java.lang.String key,
                       java.util.function.DoubleSupplier getter,
                       java.util.function.DoubleConsumer setter)

Add a double property.

Parameters:

key - property name

getter - getter function (returns current value)

setter - setter function (sets new value)

addStringProperty

void addStringProperty(java.lang.String key,
                       java.util.function.Supplier<java.lang.String> getter,
                       java.util.function.Consumer<java.lang.String> setter)

Add a string property.

Parameters:

key - property name

getter - getter function (returns current value)

setter - setter function (sets new value)

addBooleanArrayProperty

void addBooleanArrayProperty(java.lang.String key,
                             java.util.function.Supplier<boolean[]> getter,
                             java.util.function.Consumer<boolean[]> setter)

Add a boolean array property.

Parameters:

key - property name

getter - getter function (returns current value)

setter - setter function (sets new value)

addDoubleArrayProperty

void addDoubleArrayProperty(java.lang.String key,
                            java.util.function.Supplier<double[]> getter,
                            java.util.function.Consumer<double[]> setter)

Add a double array property.

Parameters:

key - property name

getter - getter function (returns current value)

setter - setter function (sets new value)

addStringArrayProperty

void addStringArrayProperty(java.lang.String key,
                            java.util.function.Supplier<java.lang.String[]> getter,
                            java.util.function.Consumer<java.lang.String[]> setter)

Add a string array property.

Parameters:

key - property name

getter - getter function (returns current value)

setter - setter function (sets new value)

addRawProperty

void addRawProperty(java.lang.String key,
                    java.util.function.Supplier<byte[]> getter,
                    java.util.function.Consumer<byte[]> setter)

Add a raw property.

Parameters:

key - property name

getter - getter function (returns current value)

setter - setter function (sets new value)

addValueProperty

void addValueProperty(java.lang.String key,
                      java.util.function.Supplier<NetworkTableValue> getter,
                      java.util.function.Consumer<NetworkTableValue> setter)

Add a NetworkTableValue property.

Parameters:

key - property name

getter - getter function (returns current value)

setter - setter function (sets new value)