#include <frc/shuffleboard/ShuffleboardValue.h>

Inheritance diagram for frc::ShuffleboardValue:

Public Member Functions
	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...

Constructor & Destructor Documentation

◆ ShuffleboardValue() [1/2]

frc::ShuffleboardValue::ShuffleboardValue ( std::string_view title )

inlineexplicit

◆ ~ShuffleboardValue()

virtual frc::ShuffleboardValue::~ShuffleboardValue ( )

virtualdefault

◆ ShuffleboardValue() [2/2]

frc::ShuffleboardValue::ShuffleboardValue ( const ShuffleboardValue & )

delete

Member Function Documentation

◆ BuildInto()

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

pure virtual

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

Implemented in frc::ComplexWidget, frc::ShuffleboardLayout, frc::ShuffleboardTab, frc::SimpleWidget, and frc::SuppliedValueWidget< T >.

◆ DisableIfActuator()

virtual void frc::ShuffleboardValue::DisableIfActuator ( )

inlinevirtual

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 in frc::ComplexWidget, and frc::ShuffleboardContainer.

◆ EnableIfActuator()

virtual void frc::ShuffleboardValue::EnableIfActuator ( )

inlinevirtual

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 in frc::ComplexWidget, and frc::ShuffleboardContainer.

◆ GetTitle()

const std::string & frc::ShuffleboardValue::GetTitle ( ) const

inline

Gets the title of this Shuffleboard value.

◆ operator=()

ShuffleboardValue & frc::ShuffleboardValue::operator= ( const ShuffleboardValue & )