WPILibC++ 2024.3.2
frc::ShuffleboardComponentBase Class Reference

A shim class to allow storing ShuffleboardComponents in arrays. More...

#include <frc/shuffleboard/ShuffleboardComponentBase.h>

Inheritance diagram for frc::ShuffleboardComponentBase:
frc::ShuffleboardValue frc::ShuffleboardComponent< ComplexWidget > frc::ShuffleboardComponent< ShuffleboardLayout > frc::ShuffleboardComponent< SimpleWidget > frc::ShuffleboardComponent< SuppliedValueWidget< T > > frc::ShuffleboardComponent< Derived > frc::ShuffleboardWidget< ComplexWidget > frc::ShuffleboardLayout frc::ShuffleboardWidget< SimpleWidget > frc::ShuffleboardWidget< SuppliedValueWidget< T > > frc::ShuffleboardWidget< Derived > frc::ComplexWidget frc::SimpleWidget frc::SuppliedValueWidget< T >

Public Member Functions

 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)
 
ShuffleboardContainerGetParent ()
 
const std::string & GetType () const
 
- Public Member Functions inherited from frc::ShuffleboardValue
 ShuffleboardValue (std::string_view title)
 
virtual ~ShuffleboardValue ()=default
 
 ShuffleboardValue (const ShuffleboardValue &)=delete
 
ShuffleboardValueoperator= (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...
 

Protected Attributes

wpi::StringMap< nt::Valuem_properties
 
bool m_metadataDirty = true
 
int m_column = -1
 
int m_row = -1
 
int m_width = -1
 
int m_height = -1
 

Detailed Description

A shim class to allow storing ShuffleboardComponents in arrays.

Constructor & Destructor Documentation

◆ ShuffleboardComponentBase()

frc::ShuffleboardComponentBase::ShuffleboardComponentBase ( ShuffleboardContainer parent,
std::string_view  title,
std::string_view  type = "" 
)

Member Function Documentation

◆ BuildMetadata()

void frc::ShuffleboardComponentBase::BuildMetadata ( std::shared_ptr< nt::NetworkTable metaTable)

◆ GetParent()

ShuffleboardContainer & frc::ShuffleboardComponentBase::GetParent ( )

◆ GetType()

const std::string & frc::ShuffleboardComponentBase::GetType ( ) const

◆ SetType()

void frc::ShuffleboardComponentBase::SetType ( std::string_view  type)

Member Data Documentation

◆ m_column

int frc::ShuffleboardComponentBase::m_column = -1
protected

◆ m_height

int frc::ShuffleboardComponentBase::m_height = -1
protected

◆ m_metadataDirty

bool frc::ShuffleboardComponentBase::m_metadataDirty = true
protected

◆ m_properties

wpi::StringMap<nt::Value> frc::ShuffleboardComponentBase::m_properties
protected

◆ m_row

int frc::ShuffleboardComponentBase::m_row = -1
protected

◆ m_width

int frc::ShuffleboardComponentBase::m_width = -1
protected

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