The root of the data placed in Shuffleboard. More...

#include <frc/shuffleboard/ShuffleboardRoot.h>

Inheritance diagram for frc::ShuffleboardRoot:

Public Member Functions
virtual ShuffleboardTab &	GetTab (std::string_view title)=0
	Gets the tab with the given title, creating it if it does not already exist. More...

virtual void	Update ()=0
	Updates all tabs. More...

virtual void	EnableActuatorWidgets ()=0
	Enables all widgets in Shuffleboard that offer user control over actuators. More...

virtual void	DisableActuatorWidgets ()=0
	Disables all widgets in Shuffleboard that offer user control over actuators. More...

virtual void	SelectTab (int index)=0
	Selects the tab in the dashboard with the given index in the range [0..n-1], where n is the number of tabs in the dashboard at the time this method is called. More...

virtual void	SelectTab (std::string_view title)=0
	Selects the tab in the dashboard with the given title. More...

Detailed Description

The root of the data placed in Shuffleboard.

It contains the tabs, but no data is placed directly in the root.

This class is package-private to minimize API surface area.

Member Function Documentation

◆ DisableActuatorWidgets()

virtual void frc::ShuffleboardRoot::DisableActuatorWidgets ( )

pure virtual

Disables all widgets in Shuffleboard that offer user control over actuators.

Implemented in frc::detail::ShuffleboardInstance.

◆ EnableActuatorWidgets()

virtual void frc::ShuffleboardRoot::EnableActuatorWidgets ( )

pure virtual

Enables all widgets in Shuffleboard that offer user control over actuators.

Implemented in frc::detail::ShuffleboardInstance.

◆ GetTab()

virtual ShuffleboardTab & frc::ShuffleboardRoot::GetTab ( std::string_view title )

pure virtual

Gets the tab with the given title, creating it if it does not already exist.

Parameters

title the title of the tab

Returns: the tab with the given title

Implemented in frc::detail::ShuffleboardInstance.

◆ SelectTab() [1/2]

virtual void frc::ShuffleboardRoot::SelectTab ( int index )

pure virtual

Selects the tab in the dashboard with the given index in the range [0..n-1], where n is the number of tabs in the dashboard at the time this method is called.

Parameters

index the index of the tab to select

Implemented in frc::detail::ShuffleboardInstance.