SendableBuilder¶
- class wpiutil.SendableBuilder¶
Bases:
pybind11_object
- class BackendKind(value: int)¶
Bases:
pybind11_object
The backend kinds used for the sendable builder.
Members:
kUnknown
kNetworkTables
- kNetworkTables = <BackendKind.kNetworkTables: 1>¶
- kUnknown = <BackendKind.kUnknown: 0>¶
- property name¶
- property value¶
- addBooleanArrayProperty(key: str, getter: Callable[[], List[int]], setter: Callable[[List[int]], None]) None ¶
Add a boolean array property.
- Parameters
key – property name
getter – getter function (returns current value)
setter – setter function (sets new value)
- addBooleanProperty(key: str, getter: Callable[[], bool], setter: Callable[[bool], None]) None ¶
Add a boolean property.
- Parameters
key – property name
getter – getter function (returns current value)
setter – setter function (sets new value)
- addDoubleArrayProperty(key: str, getter: Callable[[], List[float]], setter: Callable[[List[float]], None]) None ¶
Add a double array property.
- Parameters
key – property name
getter – getter function (returns current value)
setter – setter function (sets new value)
- addDoubleProperty(key: str, getter: Callable[[], float], setter: Callable[[float], None]) None ¶
Add a double property.
- Parameters
key – property name
getter – getter function (returns current value)
setter – setter function (sets new value)
- addFloatArrayProperty(key: str, getter: Callable[[], List[float]], setter: Callable[[List[float]], None]) None ¶
Add a float array property.
- Parameters
key – property name
getter – getter function (returns current value)
setter – setter function (sets new value)
- addFloatProperty(key: str, getter: Callable[[], float], setter: Callable[[float], None]) None ¶
Add a float property.
- Parameters
key – property name
getter – getter function (returns current value)
setter – setter function (sets new value)
- addIntegerArrayProperty(key: str, getter: Callable[[], List[int]], setter: Callable[[List[int]], None]) None ¶
Add an integer array property.
- Parameters
key – property name
getter – getter function (returns current value)
setter – setter function (sets new value)
- addIntegerProperty(key: str, getter: Callable[[], int], setter: Callable[[int], None]) None ¶
Add an integer property.
- Parameters
key – property name
getter – getter function (returns current value)
setter – setter function (sets new value)
- addRawProperty(key: str, typeString: str, getter: Callable[[], List[int]], setter: Callable[[buffer], None]) None ¶
Add a raw property.
- Parameters
key – property name
typeString – type string
getter – getter function (returns current value)
setter – setter function (sets new value)
- addSmallBooleanArrayProperty(key: str, getter: Callable[[List[int]], List[int]], setter: Callable[[List[int]], None]) None ¶
Add a boolean array property (SmallVector form).
- Parameters
key – property name
getter – getter function (returns current value)
setter – setter function (sets new value)
- addSmallDoubleArrayProperty(key: str, getter: Callable[[List[float]], List[float]], setter: Callable[[List[float]], None]) None ¶
Add a double array property (SmallVector form).
- Parameters
key – property name
getter – getter function (returns current value)
setter – setter function (sets new value)
- addSmallFloatArrayProperty(key: str, getter: Callable[[List[float]], List[float]], setter: Callable[[List[float]], None]) None ¶
Add a float array property (SmallVector form).
- Parameters
key – property name
getter – getter function (returns current value)
setter – setter function (sets new value)
- addSmallIntegerArrayProperty(key: str, getter: Callable[[List[int]], List[int]], setter: Callable[[List[int]], None]) None ¶
Add an integer array property (SmallVector form).
- Parameters
key – property name
getter – getter function (returns current value)
setter – setter function (sets new value)
- addSmallRawProperty(key: str, typeString: str, getter: Callable[[List[int]], buffer], setter: Callable[[buffer], None]) None ¶
Add a raw property (SmallVector form).
- Parameters
key – property name
typeString – type string
getter – getter function (returns current value)
setter – setter function (sets new value)
- addSmallStringArrayProperty(key: str, getter: Callable[[List[str]], List[str]], setter: Callable[[List[str]], None]) None ¶
Add a string array property (SmallVector form).
- Parameters
key – property name
getter – getter function (returns current value)
setter – setter function (sets new value)
- addSmallStringProperty(key: str, getter: Callable[[List[str]], str], setter: Callable[[str], None]) None ¶
Add a string property (SmallString form).
- Parameters
key – property name
getter – getter function (returns current value)
setter – setter function (sets new value)
- addStringArrayProperty(key: str, getter: Callable[[], List[str]], setter: Callable[[List[str]], None]) None ¶
Add a string array property.
- Parameters
key – property name
getter – getter function (returns current value)
setter – setter function (sets new value)
- addStringProperty(key: str, getter: Callable[[], str], setter: Callable[[str], None]) None ¶
Add a string property.
- Parameters
key – property name
getter – getter function (returns current value)
setter – setter function (sets new value)
- clearProperties() None ¶
Clear properties.
- getBackendKind() wpiutil._wpiutil.SendableBuilder.BackendKind ¶
Gets the kind of backend being used.
- Returns
Backend kind
- isPublished() bool ¶
Return whether this sendable has been published.
- Returns
True if it has been published, false if not.
- setActuator(value: bool) None ¶
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(func: Callable[[], None]) None ¶
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
- setSmartDashboardType(type: str) None ¶
Set the string representation of the named data type that will be used by the smart dashboard for this sendable.
- Parameters
type – data type
- update() None ¶
Update the published values by calling the getters for all properties.