WPILibC++
2019.1.1-4-g308bdbe
|
Public Member Functions | |
SendableBuilderImpl (SendableBuilderImpl &&)=default | |
SendableBuilderImpl & | operator= (SendableBuilderImpl &&)=default |
void | SetTable (std::shared_ptr< nt::NetworkTable > table) |
Set the network table. More... | |
std::shared_ptr< nt::NetworkTable > | GetTable () |
Get the network table. More... | |
bool | IsActuator () const |
Return whether this sendable should be treated as an actuator. More... | |
void | UpdateTable () |
Update the network table values by calling the getters for all properties. | |
void | StartListeners () |
Hook setters for all properties. | |
void | StopListeners () |
Unhook setters for all properties. | |
void | StartLiveWindowMode () |
Start LiveWindow mode by hooking the setters for all properties. More... | |
void | StopLiveWindowMode () |
Stop LiveWindow mode by unhooking the setters for all properties. More... | |
void | SetSmartDashboardType (const wpi::Twine &type) override |
Set the string representation of the named data type that will be used by the smart dashboard for this sendable. More... | |
void | SetActuator (bool value) override |
Set a flag indicating if this sendable should be treated as an actuator. More... | |
void | SetSafeState (std::function< void()> func) override |
Set the function that should be called to set the Sendable into a safe state. More... | |
void | SetUpdateTable (std::function< void()> func) override |
Set the function that should be called to update the network table for things other than properties. More... | |
nt::NetworkTableEntry | GetEntry (const wpi::Twine &key) override |
Add a property without getters or setters. More... | |
void | AddBooleanProperty (const wpi::Twine &key, std::function< bool()> getter, std::function< void(bool)> setter) override |
Add a boolean property. More... | |
void | AddDoubleProperty (const wpi::Twine &key, std::function< double()> getter, std::function< void(double)> setter) override |
Add a double property. More... | |
void | AddStringProperty (const wpi::Twine &key, std::function< std::string()> getter, std::function< void(wpi::StringRef)> setter) override |
Add a string property. More... | |
void | AddBooleanArrayProperty (const wpi::Twine &key, std::function< std::vector< int >()> getter, std::function< void(wpi::ArrayRef< int >)> setter) override |
Add a boolean array property. More... | |
void | AddDoubleArrayProperty (const wpi::Twine &key, std::function< std::vector< double >()> getter, std::function< void(wpi::ArrayRef< double >)> setter) override |
Add a double array property. More... | |
void | AddStringArrayProperty (const wpi::Twine &key, std::function< std::vector< std::string >()> getter, std::function< void(wpi::ArrayRef< std::string >)> setter) override |
Add a string array property. More... | |
void | AddRawProperty (const wpi::Twine &key, std::function< std::string()> getter, std::function< void(wpi::StringRef)> setter) override |
Add a raw property. More... | |
void | AddValueProperty (const wpi::Twine &key, std::function< std::shared_ptr< nt::Value >()> getter, std::function< void(std::shared_ptr< nt::Value >)> setter) override |
Add a NetworkTableValue property. More... | |
void | AddSmallStringProperty (const wpi::Twine &key, std::function< wpi::StringRef(wpi::SmallVectorImpl< char > &buf)> getter, std::function< void(wpi::StringRef)> setter) override |
Add a string property (SmallString form). More... | |
void | AddSmallBooleanArrayProperty (const wpi::Twine &key, std::function< wpi::ArrayRef< int >(wpi::SmallVectorImpl< int > &buf)> getter, std::function< void(wpi::ArrayRef< int >)> setter) override |
Add a boolean array property (SmallVector form). More... | |
void | AddSmallDoubleArrayProperty (const wpi::Twine &key, std::function< wpi::ArrayRef< double >(wpi::SmallVectorImpl< double > &buf)> getter, std::function< void(wpi::ArrayRef< double >)> setter) override |
Add a double array property (SmallVector form). More... | |
void | AddSmallStringArrayProperty (const wpi::Twine &key, std::function< wpi::ArrayRef< std::string >(wpi::SmallVectorImpl< std::string > &buf)> getter, std::function< void(wpi::ArrayRef< std::string >)> setter) override |
Add a string array property (SmallVector form). More... | |
void | AddSmallRawProperty (const wpi::Twine &key, std::function< wpi::StringRef(wpi::SmallVectorImpl< char > &buf)> getter, std::function< void(wpi::StringRef)> setter) override |
Add a raw property (SmallVector form). More... | |
|
overridevirtual |
Add a boolean array property.
key | property name |
getter | getter function (returns current value) |
setter | setter function (sets new value) |
Implements frc::SendableBuilder.
|
overridevirtual |
Add a boolean property.
key | property name |
getter | getter function (returns current value) |
setter | setter function (sets new value) |
Implements frc::SendableBuilder.
|
overridevirtual |
Add a double array property.
key | property name |
getter | getter function (returns current value) |
setter | setter function (sets new value) |
Implements frc::SendableBuilder.
|
overridevirtual |
Add a double property.
key | property name |
getter | getter function (returns current value) |
setter | setter function (sets new value) |
Implements frc::SendableBuilder.
|
overridevirtual |
Add a raw property.
key | property name |
getter | getter function (returns current value) |
setter | setter function (sets new value) |
Implements frc::SendableBuilder.
|
overridevirtual |
Add a boolean array property (SmallVector form).
key | property name |
getter | getter function (returns current value) |
setter | setter function (sets new value) |
Implements frc::SendableBuilder.
|
overridevirtual |
Add a double array property (SmallVector form).
key | property name |
getter | getter function (returns current value) |
setter | setter function (sets new value) |
Implements frc::SendableBuilder.
|
overridevirtual |
Add a raw property (SmallVector form).
key | property name |
getter | getter function (returns current value) |
setter | setter function (sets new value) |
Implements frc::SendableBuilder.
|
overridevirtual |
Add a string array property (SmallVector form).
key | property name |
getter | getter function (returns current value) |
setter | setter function (sets new value) |
Implements frc::SendableBuilder.
|
overridevirtual |
Add a string property (SmallString form).
key | property name |
getter | getter function (returns current value) |
setter | setter function (sets new value) |
Implements frc::SendableBuilder.
|
overridevirtual |
Add a string array property.
key | property name |
getter | getter function (returns current value) |
setter | setter function (sets new value) |
Implements frc::SendableBuilder.
|
overridevirtual |
Add a string property.
key | property name |
getter | getter function (returns current value) |
setter | setter function (sets new value) |
Implements frc::SendableBuilder.
|
overridevirtual |
Add a NetworkTableValue property.
key | property name |
getter | getter function (returns current value) |
setter | setter function (sets new value) |
Implements frc::SendableBuilder.
|
overridevirtual |
Add a property without getters or setters.
This can be used to get entry handles for the function called by SetUpdateTable().
key | property name |
Implements frc::SendableBuilder.
std::shared_ptr<nt::NetworkTable> frc::SendableBuilderImpl::GetTable | ( | ) |
Get the network table.
bool frc::SendableBuilderImpl::IsActuator | ( | ) | const |
Return whether this sendable should be treated as an actuator.
|
overridevirtual |
Set a flag indicating if this sendable should be treated as an actuator.
By default this flag is false.
value | true if actuator, false if not |
Implements frc::SendableBuilder.
|
overridevirtual |
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.
func | function |
Implements frc::SendableBuilder.
|
overridevirtual |
Set the string representation of the named data type that will be used by the smart dashboard for this sendable.
type | data type |
Implements frc::SendableBuilder.
void frc::SendableBuilderImpl::SetTable | ( | std::shared_ptr< nt::NetworkTable > | table | ) |
Set the network table.
Must be called prior to any Add* functions being called.
table | Network table |
|
overridevirtual |
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().
func | function |
Implements frc::SendableBuilder.
void frc::SendableBuilderImpl::StartLiveWindowMode | ( | ) |
Start LiveWindow mode by hooking the setters for all properties.
Also calls the SafeState function if one was provided.
void frc::SendableBuilderImpl::StopLiveWindowMode | ( | ) |
Stop LiveWindow mode by unhooking the setters for all properties.
Also calls the SafeState function if one was provided.