WPILibC++  2019.1.1-beta-1-20-g746f950
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Modules Pages
frc::ShuffleboardTab Class Referencefinal

Represents a tab in the Shuffleboard dashboard. More...

#include <ShuffleboardTab.h>

Inheritance diagram for frc::ShuffleboardTab:
frc::ShuffleboardContainer frc::ShuffleboardValue

Public Member Functions

 ShuffleboardTab (ShuffleboardRoot &root, wpi::StringRef title)
 
ShuffleboardRootGetRoot ()
 
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::ShuffleboardContainer
 ShuffleboardContainer (const wpi::Twine &title)
 
 ShuffleboardContainer (ShuffleboardContainer &&rhs)=default
 
const std::vector
< std::unique_ptr
< ShuffleboardComponentBase > > & 
GetComponents () const
 Gets the components that are direct children of this container.
 
ShuffleboardLayoutGetLayout (const wpi::Twine &type, const wpi::Twine &title)
 Gets the layout with the given type and title, creating it if it does not already exist at the time this method is called. More...
 
ComplexWidgetAdd (const wpi::Twine &title, Sendable &sendable)
 Adds a widget to this container to display the given sendable. More...
 
ComplexWidgetAdd (Sendable &sendable)
 Adds a widget to this container to display the given sendable. More...
 
SimpleWidgetAdd (const wpi::Twine &title, std::shared_ptr< nt::Value > defaultValue)
 Adds a widget to this container to display the given data. More...
 
SimpleWidgetAdd (const wpi::Twine &title, bool defaultValue)
 Adds a widget to this container to display the given data. More...
 
SimpleWidgetAdd (const wpi::Twine &title, double defaultValue)
 Adds a widget to this container to display the given data. More...
 
SimpleWidgetAdd (const wpi::Twine &title, int defaultValue)
 Adds a widget to this container to display the given data. More...
 
SimpleWidgetAdd (const wpi::Twine &title, const wpi::Twine &defaultValue)
 Adds a widget to this container to display the given data. More...
 
SimpleWidgetAdd (const wpi::Twine &title, const char *defaultValue)
 Adds a widget to this container to display the given data. More...
 
SimpleWidgetAdd (const wpi::Twine &title, wpi::ArrayRef< bool > defaultValue)
 Adds a widget to this container to display the given data. More...
 
SimpleWidgetAdd (const wpi::Twine &title, wpi::ArrayRef< double > defaultValue)
 Adds a widget to this container to display the given data. More...
 
SimpleWidgetAdd (const wpi::Twine &title, wpi::ArrayRef< std::string > defaultValue)
 Adds a widget to this container to display the given data. More...
 
SimpleWidgetAddPersistent (const wpi::Twine &title, std::shared_ptr< nt::Value > defaultValue)
 Adds a widget to this container to display a simple piece of data. More...
 
SimpleWidgetAddPersistent (const wpi::Twine &title, bool defaultValue)
 Adds a widget to this container to display a simple piece of data. More...
 
SimpleWidgetAddPersistent (const wpi::Twine &title, double defaultValue)
 Adds a widget to this container to display a simple piece of data. More...
 
SimpleWidgetAddPersistent (const wpi::Twine &title, int defaultValue)
 Adds a widget to this container to display a simple piece of data. More...
 
SimpleWidgetAddPersistent (const wpi::Twine &title, const wpi::Twine &defaultValue)
 Adds a widget to this container to display a simple piece of data. More...
 
SimpleWidgetAddPersistent (const wpi::Twine &title, wpi::ArrayRef< bool > defaultValue)
 Adds a widget to this container to display a simple piece of data. More...
 
SimpleWidgetAddPersistent (const wpi::Twine &title, wpi::ArrayRef< double > defaultValue)
 Adds a widget to this container to display a simple piece of data. More...
 
SimpleWidgetAddPersistent (const wpi::Twine &title, wpi::ArrayRef< std::string > defaultValue)
 Adds a widget to this container to display a simple piece of data. More...
 
void EnableIfActuator () override
 Enables user control of this widget in the Shuffleboard application. More...
 
void DisableIfActuator () override
 Disables user control of this widget in the Shuffleboard application. More...
 
- Public Member Functions inherited from frc::ShuffleboardValue
 ShuffleboardValue (const wpi::Twine &title)
 
wpi::StringRef GetTitle () const
 Gets the title of this Shuffleboard value.
 

Additional Inherited Members

- Protected Attributes inherited from frc::ShuffleboardContainer
bool m_isLayout = false
 

Detailed Description

Represents a tab in the Shuffleboard dashboard.

Widgets can be added to the tab with add(Sendable), add(String, Object), and add(String, Sendable). Widgets can also be added to layouts with getLayout(String, String); layouts can be nested arbitrarily deep (note that too many levels may make deeper components unusable).

Member Function Documentation

void frc::ShuffleboardTab::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: