WPILibC++  2019.3.1
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Modules Pages
frc::ComplexWidget Class Referencefinal

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

#include <ComplexWidget.h>

Inheritance diagram for frc::ComplexWidget:
frc::ShuffleboardWidget< ComplexWidget > frc::ShuffleboardComponent< ComplexWidget > frc::ShuffleboardComponentBase frc::ShuffleboardValue

Public Member Functions

 ComplexWidget (ShuffleboardContainer &parent, const wpi::Twine &title, Sendable &sendable)
 
void EnableIfActuator () override
 Enables user control of this widget in the Shuffleboard application. More...
 
void DisableIfActuator () override
 Disables user control of this widget in the Shuffleboard application. 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< ComplexWidget >
 ShuffleboardWidget (ShuffleboardContainer &parent, const wpi::Twine &title)
 
ComplexWidgetWithWidget (BuiltInWidgets widgetType)
 Sets the type of widget used to display the data. More...
 
ComplexWidgetWithWidget (const WidgetType &widgetType)
 Sets the type of widget used to display the data. More...
 
ComplexWidgetWithWidget (const wpi::Twine &widgetType)
 Sets the type of widget used to display the data. More...
 
- Public Member Functions inherited from frc::ShuffleboardComponent< ComplexWidget >
 ShuffleboardComponent (ShuffleboardContainer &parent, const wpi::Twine &title, const wpi::Twine &type="")
 
ComplexWidgetWithProperties (const wpi::StringMap< std::shared_ptr< nt::Value >> &properties)
 Sets custom properties for this component. More...
 
ComplexWidgetWithPosition (int columnIndex, int rowIndex)
 Sets the position of this component in the tab. More...
 
ComplexWidgetWithSize (int width, int height)
 Sets the size of this component in the tab. More...
 
- Public Member Functions inherited from frc::ShuffleboardComponentBase
 ShuffleboardComponentBase (ShuffleboardContainer &parent, const wpi::Twine &title, const wpi::Twine &type="")
 
void SetType (const wpi::Twine &type)
 
void BuildMetadata (std::shared_ptr< nt::NetworkTable > metaTable)
 
ShuffleboardContainerGetParent ()
 
const std::string & GetType () const
 
- Public Member Functions inherited from frc::ShuffleboardValue
 ShuffleboardValue (const wpi::Twine &title)
 
wpi::StringRef GetTitle () const
 Gets the title of this Shuffleboard value.
 

Additional Inherited Members

- Protected Attributes inherited from frc::ShuffleboardComponentBase
wpi::StringMap
< std::shared_ptr< 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 speed controller or sensor.

Member Function Documentation

void frc::ComplexWidget::BuildInto ( std::shared_ptr< nt::NetworkTable parentTable,
std::shared_ptr< nt::NetworkTable metaTable 
)
overridevirtual

Builds the entries for this value.

Parameters
parentTableThe 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.
metaTableThe table containing all the metadata for this value and its sub-values

Implements frc::ShuffleboardValue.

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.

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: