frc::detail::ShuffleboardInstance Class Reference

#include <frc/shuffleboard/ShuffleboardInstance.h>

Inheritance diagram for frc::detail::ShuffleboardInstance:

Public Member Functions
	ShuffleboardInstance (nt::NetworkTableInstance ntInstance)
virtual	~ShuffleboardInstance ()
	ShuffleboardInstance (ShuffleboardInstance &&)=default
ShuffleboardInstance &	operator= (ShuffleboardInstance &&)=default
frc::ShuffleboardTab &	GetTab (std::string_view title) override
	Gets the tab with the given title, creating it if it does not already exist. More...
void	Update () override
	Updates all tabs. More...
void	EnableActuatorWidgets () override
	Enables all widgets in Shuffleboard that offer user control over actuators. More...
void	DisableActuatorWidgets () override
	Disables all widgets in Shuffleboard that offer user control over actuators. More...
void	SelectTab (int index) override
	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...
void	SelectTab (std::string_view) override
	Selects the tab in the dashboard with the given title. More...
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...

Constructor & Destructor Documentation

ShuffleboardInstance() [1/2]

frc::detail::ShuffleboardInstance::ShuffleboardInstance ( nt::NetworkTableInstance  ntInstance )

explicit

~ShuffleboardInstance()

virtual frc::detail::ShuffleboardInstance::~ShuffleboardInstance ( )

virtual

ShuffleboardInstance() [2/2]

frc::detail::ShuffleboardInstance::ShuffleboardInstance ( ShuffleboardInstance &&  )

default

Member Function Documentation

DisableActuatorWidgets()

void frc::detail::ShuffleboardInstance::DisableActuatorWidgets ( )

overridevirtual

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

Implements frc::ShuffleboardRoot.

EnableActuatorWidgets()

void frc::detail::ShuffleboardInstance::EnableActuatorWidgets ( )

overridevirtual

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

Implements frc::ShuffleboardRoot.

GetTab()

frc::ShuffleboardTab & frc::detail::ShuffleboardInstance::GetTab ( std::string_view  title )

overridevirtual

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

Implements frc::ShuffleboardRoot.

operator=()

ShuffleboardInstance & frc::detail::ShuffleboardInstance::operator= ( ShuffleboardInstance &&  )

default

SelectTab() [1/2]

void frc::detail::ShuffleboardInstance::SelectTab ( int  index )

overridevirtual

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

Implements frc::ShuffleboardRoot.

SelectTab() [2/2]

void frc::detail::ShuffleboardInstance::SelectTab ( std::string_view  title )

overridevirtual

Selects the tab in the dashboard with the given title.

Parameters

title

the title of the tab to select

Implements frc::ShuffleboardRoot.

Update()

void frc::detail::ShuffleboardInstance::Update ( )

overridevirtual

Updates all tabs.

Implements frc::ShuffleboardRoot.

---

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

• frc/shuffleboard/ShuffleboardInstance.h