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

#include <frc/shuffleboard/SimpleWidget.h>

Inheritance diagram for frc::SimpleWidget:

Public Member Functions
	SimpleWidget (ShuffleboardContainer &parent, std::string_view title)

nt::GenericEntry *	GetEntry ()
	Gets the NetworkTable entry that contains the data for this widget. More...

nt::GenericEntry *	GetEntry (std::string_view typeString)
	Gets the NetworkTable entry that contains the data for this widget. More...

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, std::string_view title)

SimpleWidget &	WithWidget (BuiltInWidgets widgetType)
	Sets the type of widget used to display the data. More...

SimpleWidget &	WithWidget (const WidgetType &widgetType)
	Sets the type of widget used to display the data. More...

SimpleWidget &	WithWidget (std::string_view widgetType)
	Sets the type of widget used to display the data. More...

Public Member Functions inherited from frc::ShuffleboardComponent< SimpleWidget >
	ShuffleboardComponent (ShuffleboardContainer &parent, std::string_view title, std::string_view type="")

SimpleWidget &	WithProperties (const wpi::StringMap< nt::Value > &properties)
	Sets custom properties for this component. More...

SimpleWidget &	WithPosition (int columnIndex, int rowIndex)
	Sets the position of this component in the tab. More...

SimpleWidget &	WithSize (int width, int height)
	Sets the size of this component in the tab. More...

Public Member Functions inherited from frc::ShuffleboardComponentBase
	ShuffleboardComponentBase (ShuffleboardContainer &parent, std::string_view title, std::string_view type="")

void	SetType (std::string_view type)

void	BuildMetadata (std::shared_ptr< nt::NetworkTable > metaTable)

ShuffleboardContainer &	GetParent ()

const std::string &	GetType () const

Public Member Functions inherited from frc::ShuffleboardValue
	ShuffleboardValue (std::string_view title)

virtual	~ShuffleboardValue ()=default

	ShuffleboardValue (const ShuffleboardValue &)=delete

ShuffleboardValue &	operator= (const ShuffleboardValue &)=delete

const std::string &	GetTitle () const
	Gets the title of this Shuffleboard value. More...

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...

Additional Inherited Members
Protected Attributes inherited from frc::ShuffleboardComponentBase
wpi::StringMap< 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.

Constructor & Destructor Documentation

◆ SimpleWidget()

frc::SimpleWidget::SimpleWidget	(	ShuffleboardContainer &	parent,
		std::string_view	title
	)

Member Function Documentation

◆ BuildInto()

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

overridevirtual

Builds the entries for this value.

Parameters

parentTable	The 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.
metaTable	The table containing all the metadata for this value and its sub-values

Implements frc::ShuffleboardValue.

◆ GetEntry() [1/2]

nt::GenericEntry * frc::SimpleWidget::GetEntry ( )

Gets the NetworkTable entry that contains the data for this widget.

The widget owns the entry; the returned pointer's lifetime is the same as that of the widget.

◆ GetEntry() [2/2]

nt::GenericEntry * frc::SimpleWidget::GetEntry ( std::string_view typeString )