Interface SendableBuilder
-
- All Known Implementing Classes:
SendableBuilderImpl
public interface SendableBuilder
-
-
Nested Class Summary
Nested Classes Modifier and Type Interface Description static interface
SendableBuilder.BooleanConsumer
Represents an operation that accepts a single boolean-valued argument and returns no result.
-
Method Summary
All Methods Instance Methods Abstract Methods 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, SendableBuilder.BooleanConsumer setter)
Add a boolean property.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
addRawProperty(String key, 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
addValueProperty(String key, Supplier<NetworkTableValue> getter, Consumer<NetworkTableValue> setter)
Add a NetworkTableValue property.NetworkTableEntry
getEntry(String key)
Add a property without getters or setters.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
setUpdateTable(Runnable func)
Set the function that should be called to update the network table for things other than properties.
-
-
-
Method Detail
-
setSmartDashboardType
void setSmartDashboardType(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
-
setActuator
void setActuator(boolean value)
Set a flag indicating if this sendable should be treated as an actuator. By default this flag is false.- Parameters:
value
- true if actuator, false if not
-
setSafeState
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.- Parameters:
func
- function
-
setUpdateTable
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 entry handles returned by getEntry().- Parameters:
func
- function
-
getEntry
NetworkTableEntry getEntry(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(String key, BooleanSupplier getter, SendableBuilder.BooleanConsumer setter)
Add a boolean property.- Parameters:
key
- property namegetter
- getter function (returns current value)setter
- setter function (sets new value)
-
addDoubleProperty
void addDoubleProperty(String key, DoubleSupplier getter, DoubleConsumer setter)
Add a double property.- Parameters:
key
- property namegetter
- getter function (returns current value)setter
- setter function (sets new value)
-
addStringProperty
void addStringProperty(String key, Supplier<String> getter, Consumer<String> setter)
Add a string property.- Parameters:
key
- property namegetter
- getter function (returns current value)setter
- setter function (sets new value)
-
addBooleanArrayProperty
void addBooleanArrayProperty(String key, Supplier<boolean[]> getter, Consumer<boolean[]> setter)
Add a boolean array property.- Parameters:
key
- property namegetter
- getter function (returns current value)setter
- setter function (sets new value)
-
addDoubleArrayProperty
void addDoubleArrayProperty(String key, Supplier<double[]> getter, Consumer<double[]> setter)
Add a double array property.- Parameters:
key
- property namegetter
- getter function (returns current value)setter
- setter function (sets new value)
-
addStringArrayProperty
void addStringArrayProperty(String key, Supplier<String[]> getter, Consumer<String[]> setter)
Add a string array property.- Parameters:
key
- property namegetter
- getter function (returns current value)setter
- setter function (sets new value)
-
addRawProperty
void addRawProperty(String key, Supplier<byte[]> getter, Consumer<byte[]> setter)
Add a raw property.- Parameters:
key
- property namegetter
- getter function (returns current value)setter
- setter function (sets new value)
-
addValueProperty
void addValueProperty(String key, Supplier<NetworkTableValue> getter, Consumer<NetworkTableValue> setter)
Add a NetworkTableValue property.- Parameters:
key
- property namegetter
- getter function (returns current value)setter
- setter function (sets new value)
-
-