frc::ComplexWidget Class Reference

A Shuffleboard widget that handles a Sendable object such as a motor controller or sensor. More...

#include <frc/shuffleboard/ComplexWidget.h>

Inheritance diagram for frc::ComplexWidget:

Public Member Functions
	ComplexWidget (ShuffleboardContainer &parent, std::string_view title, wpi::Sendable &sendable)
	~ComplexWidget () override
void	EnableIfActuator () override
	Enables user control of this widget in the Shuffleboard application.
void	DisableIfActuator () override
	Disables user control of this widget in the Shuffleboard application.
void	BuildInto (std::shared_ptr< nt::NetworkTable > parentTable, std::shared_ptr< nt::NetworkTable > metaTable) override
	Builds the entries for this value.
Public Member Functions inherited from frc::ShuffleboardWidget< ComplexWidget >
	ShuffleboardWidget (ShuffleboardContainer &parent, std::string_view title)
ComplexWidget &	WithWidget (BuiltInWidgets widgetType)
	Sets the type of widget used to display the data.
ComplexWidget &	WithWidget (const WidgetType &widgetType)
	Sets the type of widget used to display the data.
ComplexWidget &	WithWidget (std::string_view widgetType)
	Sets the type of widget used to display the data.
Public Member Functions inherited from frc::ShuffleboardComponent< ComplexWidget >
	ShuffleboardComponent (ShuffleboardContainer &parent, std::string_view title, std::string_view type="")
	Constructs a ShuffleboardComponent.
ComplexWidget &	WithProperties (const wpi::StringMap< nt::Value > &properties)
	Sets custom properties for this component.
ComplexWidget &	WithPosition (int columnIndex, int rowIndex)
	Sets the position of this component in the tab.
ComplexWidget &	WithSize (int width, int height)
	Sets the size of this component in the tab.
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.

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 Sendable object such as a motor controller or sensor.

Constructor & Destructor Documentation

ComplexWidget()

frc::ComplexWidget::ComplexWidget	(	ShuffleboardContainer &	parent,
		std::string_view	title,
		wpi::Sendable &	sendable )

~ComplexWidget()

frc::ComplexWidget::~ComplexWidget ( )

override

Member Function Documentation

BuildInto()

void frc::ComplexWidget::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.

DisableIfActuator()

void frc::ComplexWidget::DisableIfActuator ( )

overridevirtual

Disables user control of this widget in the Shuffleboard application.

This method is package-private to prevent users from enabling control themselves. Has no effect if the sendable is not marked as an actuator with SendableBuilder::SetActuator().

Reimplemented from frc::ShuffleboardValue.

EnableIfActuator()

void frc::ComplexWidget::EnableIfActuator ( )

overridevirtual

Enables user control of this widget in the Shuffleboard application.

This method is package-private to prevent users from enabling control themselves. Has no effect if the sendable is not marked as an actuator with SendableBuilder::SetActuator().

Reimplemented from frc::ShuffleboardValue.

---

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

• frc/shuffleboard/ComplexWidget.h