WPILibC++  2019.3.1
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Modules Pages
frc::SimpleWidget Class Referencefinal

A Shuffleboard widget that handles a single data point such as a number or string. More...

#include <SimpleWidget.h>

Inheritance diagram for frc::SimpleWidget:
frc::ShuffleboardWidget< SimpleWidget > frc::ShuffleboardComponent< SimpleWidget > frc::ShuffleboardComponentBase frc::ShuffleboardValue

Public Member Functions

 SimpleWidget (ShuffleboardContainer &parent, const wpi::Twine &title)
 
nt::NetworkTableEntry GetEntry ()
 Gets the NetworkTable entry that contains the data for this widget.
 
void BuildInto (std::shared_ptr< nt::NetworkTable > parentTable, std::shared_ptr< nt::NetworkTable > metaTable) override
 Builds the entries for this value. More...
 
- Public Member Functions inherited from frc::ShuffleboardWidget< SimpleWidget >
 ShuffleboardWidget (ShuffleboardContainer &parent, const wpi::Twine &title)
 
SimpleWidgetWithWidget (BuiltInWidgets widgetType)
 Sets the type of widget used to display the data. More...
 
SimpleWidgetWithWidget (const WidgetType &widgetType)
 Sets the type of widget used to display the data. More...
 
SimpleWidgetWithWidget (const wpi::Twine &widgetType)
 Sets the type of widget used to display the data. More...
 
- Public Member Functions inherited from frc::ShuffleboardComponent< SimpleWidget >
 ShuffleboardComponent (ShuffleboardContainer &parent, const wpi::Twine &title, const wpi::Twine &type="")
 
SimpleWidgetWithProperties (const wpi::StringMap< std::shared_ptr< nt::Value >> &properties)
 Sets custom properties for this component. More...
 
SimpleWidgetWithPosition (int columnIndex, int rowIndex)
 Sets the position of this component in the tab. More...
 
SimpleWidgetWithSize (int width, int height)
 Sets the size of this component in the tab. More...
 
- Public Member Functions inherited from frc::ShuffleboardComponentBase
 ShuffleboardComponentBase (ShuffleboardContainer &parent, const wpi::Twine &title, const wpi::Twine &type="")
 
void SetType (const wpi::Twine &type)
 
void BuildMetadata (std::shared_ptr< nt::NetworkTable > metaTable)
 
ShuffleboardContainerGetParent ()
 
const std::string & GetType () const
 
- Public Member Functions inherited from frc::ShuffleboardValue
 ShuffleboardValue (const wpi::Twine &title)
 
wpi::StringRef GetTitle () const
 Gets the title of this Shuffleboard value.
 
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...
 

Additional Inherited Members

- Protected Attributes inherited from frc::ShuffleboardComponentBase
wpi::StringMap
< std::shared_ptr< nt::Value > > 
m_properties
 
bool m_metadataDirty = true
 
int m_column = -1
 
int m_row = -1
 
int m_width = -1
 
int m_height = -1
 

Detailed Description

A Shuffleboard widget that handles a single data point such as a number or string.

Member Function Documentation

void frc::SimpleWidget::BuildInto ( std::shared_ptr< nt::NetworkTable parentTable,
std::shared_ptr< nt::NetworkTable metaTable 
)
overridevirtual

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

Implements frc::ShuffleboardValue.


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