WPILibC++  2019.3.1
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Modules Pages
frc::ShuffleboardValue Class Referenceabstract
Inheritance diagram for frc::ShuffleboardValue:
frc::ShuffleboardComponentBase frc::ShuffleboardContainer frc::ShuffleboardComponent< Derived > frc::ShuffleboardComponent< ComplexWidget > frc::ShuffleboardComponent< ShuffleboardLayout > frc::ShuffleboardComponent< SimpleWidget > frc::ShuffleboardLayout frc::ShuffleboardTab frc::ShuffleboardWidget< Derived > frc::ShuffleboardWidget< ComplexWidget > frc::ShuffleboardLayout frc::ShuffleboardWidget< SimpleWidget > frc::ComplexWidget frc::SimpleWidget

Public Member Functions

 ShuffleboardValue (const wpi::Twine &title)
 
wpi::StringRef GetTitle () const
 Gets the title of this Shuffleboard value.
 
virtual void BuildInto (std::shared_ptr< nt::NetworkTable > parentTable, std::shared_ptr< nt::NetworkTable > metaTable)=0
 Builds the entries for this value. More...
 
virtual void EnableIfActuator ()
 Enables user control of this widget in the Shuffleboard application. More...
 
virtual void DisableIfActuator ()
 Disables user control of this widget in the Shuffleboard application. More...
 

Member Function Documentation

virtual void frc::ShuffleboardValue::BuildInto ( std::shared_ptr< nt::NetworkTable parentTable,
std::shared_ptr< nt::NetworkTable metaTable 
)
pure virtual

Builds the entries for this value.

Parameters
parentTableThe table containing all the data for the parent. Values that require a complex entry or table structure should call
parentTable.getSubtable(getTitle())
to get the table to put data into. Values that only use a single entry should call
parentTable.getEntry(getTitle())
to get that entry.
metaTableThe table containing all the metadata for this value and its sub-values

Implemented in frc::ComplexWidget, frc::SimpleWidget, frc::ShuffleboardTab, and frc::ShuffleboardLayout.

virtual void frc::ShuffleboardValue::DisableIfActuator ( )
inlinevirtual

Disables user control of this widget in the Shuffleboard application.

This method is package-private to prevent users from enabling control themselves. Has no effect if the sendable is not marked as an actuator with SendableBuilder#setActuator.

Reimplemented in frc::ShuffleboardContainer, and frc::ComplexWidget.

virtual void frc::ShuffleboardValue::EnableIfActuator ( )
inlinevirtual

Enables user control of this widget in the Shuffleboard application.

This method is package-private to prevent users from enabling control themselves. Has no effect if the sendable is not marked as an actuator with SendableBuilder#setActuator.

Reimplemented in frc::ShuffleboardContainer, and frc::ComplexWidget.


The documentation for this class was generated from the following file: