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

A layout in a Shuffleboard tab. More...

#include <ShuffleboardLayout.h>

Inheritance diagram for frc::ShuffleboardLayout:
frc::ShuffleboardComponent< ShuffleboardLayout > frc::ShuffleboardContainer frc::ShuffleboardComponentBase frc::ShuffleboardValue frc::ErrorBase frc::ShuffleboardValue

Public Member Functions

 ShuffleboardLayout (ShuffleboardContainer &parent, const wpi::Twine &name, const wpi::Twine &type)
 
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::ShuffleboardComponent< ShuffleboardLayout >
 ShuffleboardComponent (ShuffleboardContainer &parent, const wpi::Twine &title, const wpi::Twine &type="")
 
ShuffleboardLayoutWithProperties (const wpi::StringMap< std::shared_ptr< nt::Value >> &properties)
 Sets custom properties for this component. More...
 
ShuffleboardLayoutWithPosition (int columnIndex, int rowIndex)
 Sets the position of this component in the tab. More...
 
ShuffleboardLayoutWithSize (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.
 
- Public Member Functions inherited from frc::ShuffleboardContainer
 ShuffleboardContainer (const wpi::Twine &title)
 
 ShuffleboardContainer (ShuffleboardContainer &&rhs)=default
 
const std::vector
< std::unique_ptr
< ShuffleboardComponentBase > > & 
GetComponents () const
 Gets the components that are direct children of this container.
 
ShuffleboardLayoutGetLayout (const wpi::Twine &title, BuiltInLayouts type)
 Gets the layout with the given type and title, creating it if it does not already exist at the time this method is called. More...
 
ShuffleboardLayoutGetLayout (const wpi::Twine &title, const LayoutType &type)
 Gets the layout with the given type and title, creating it if it does not already exist at the time this method is called. More...
 
ShuffleboardLayoutGetLayout (const wpi::Twine &title, const wpi::Twine &type)
 Gets the layout with the given type and title, creating it if it does not already exist at the time this method is called. More...
 
ShuffleboardLayoutGetLayout (const wpi::Twine &title)
 Gets the already-defined layout in this container with the given title. More...
 
ComplexWidgetAdd (const wpi::Twine &title, Sendable &sendable)
 Adds a widget to this container to display the given sendable. More...
 
ComplexWidgetAdd (const wpi::Twine &title, const cs::VideoSource &video)
 Adds a widget to this container to display the given video stream. More...
 
ComplexWidgetAdd (Sendable &sendable)
 Adds a widget to this container to display the given sendable. More...
 
ComplexWidgetAdd (const cs::VideoSource &video)
 Adds a widget to this container to display the given video stream. More...
 
SimpleWidgetAdd (const wpi::Twine &title, std::shared_ptr< nt::Value > defaultValue)
 Adds a widget to this container to display the given data. More...
 
SimpleWidgetAdd (const wpi::Twine &title, bool defaultValue)
 Adds a widget to this container to display the given data. More...
 
SimpleWidgetAdd (const wpi::Twine &title, double defaultValue)
 Adds a widget to this container to display the given data. More...
 
SimpleWidgetAdd (const wpi::Twine &title, int defaultValue)
 Adds a widget to this container to display the given data. More...
 
SimpleWidgetAdd (const wpi::Twine &title, const wpi::Twine &defaultValue)
 Adds a widget to this container to display the given data. More...
 
SimpleWidgetAdd (const wpi::Twine &title, const char *defaultValue)
 Adds a widget to this container to display the given data. More...
 
SimpleWidgetAdd (const wpi::Twine &title, wpi::ArrayRef< bool > defaultValue)
 Adds a widget to this container to display the given data. More...
 
SimpleWidgetAdd (const wpi::Twine &title, wpi::ArrayRef< double > defaultValue)
 Adds a widget to this container to display the given data. More...
 
SimpleWidgetAdd (const wpi::Twine &title, wpi::ArrayRef< std::string > defaultValue)
 Adds a widget to this container to display the given data. More...
 
SimpleWidgetAddPersistent (const wpi::Twine &title, std::shared_ptr< nt::Value > defaultValue)
 Adds a widget to this container to display a simple piece of data. More...
 
SimpleWidgetAddPersistent (const wpi::Twine &title, bool defaultValue)
 Adds a widget to this container to display a simple piece of data. More...
 
SimpleWidgetAddPersistent (const wpi::Twine &title, double defaultValue)
 Adds a widget to this container to display a simple piece of data. More...
 
SimpleWidgetAddPersistent (const wpi::Twine &title, int defaultValue)
 Adds a widget to this container to display a simple piece of data. More...
 
SimpleWidgetAddPersistent (const wpi::Twine &title, const wpi::Twine &defaultValue)
 Adds a widget to this container to display a simple piece of data. More...
 
SimpleWidgetAddPersistent (const wpi::Twine &title, wpi::ArrayRef< bool > defaultValue)
 Adds a widget to this container to display a simple piece of data. More...
 
SimpleWidgetAddPersistent (const wpi::Twine &title, wpi::ArrayRef< double > defaultValue)
 Adds a widget to this container to display a simple piece of data. More...
 
SimpleWidgetAddPersistent (const wpi::Twine &title, wpi::ArrayRef< std::string > defaultValue)
 Adds a widget to this container to display a simple piece of data. More...
 
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...
 
- Public Member Functions inherited from frc::ErrorBase
 ErrorBase (ErrorBase &&)=default
 
ErrorBaseoperator= (ErrorBase &&)=default
 
virtual ErrorGetError ()
 Retrieve the current error. More...
 
virtual const ErrorGetError () const
 Retrieve the current error. More...
 
virtual void ClearError () const
 Clear the current error information associated with this sensor.
 
virtual void SetErrnoError (const wpi::Twine &contextMessage, wpi::StringRef filename, wpi::StringRef function, int lineNumber) const
 Set error information associated with a C library call that set an error to the "errno" global variable. More...
 
virtual void SetImaqError (int success, const wpi::Twine &contextMessage, wpi::StringRef filename, wpi::StringRef function, int lineNumber) const
 Set the current error information associated from the nivision Imaq API. More...
 
virtual void SetError (Error::Code code, const wpi::Twine &contextMessage, wpi::StringRef filename, wpi::StringRef function, int lineNumber) const
 Set the current error information associated with this sensor. More...
 
virtual void SetErrorRange (Error::Code code, int32_t minRange, int32_t maxRange, int32_t requestedValue, const wpi::Twine &contextMessage, wpi::StringRef filename, wpi::StringRef function, int lineNumber) const
 Set the current error information associated with this sensor. More...
 
virtual void SetWPIError (const wpi::Twine &errorMessage, Error::Code code, const wpi::Twine &contextMessage, wpi::StringRef filename, wpi::StringRef function, int lineNumber) const
 Set the current error information associated with this sensor. More...
 
virtual void CloneError (const ErrorBase &rhs) const
 
virtual bool StatusIsFatal () const
 Check if the current error code represents a fatal error. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from frc::ErrorBase
static void SetGlobalError (Error::Code code, const wpi::Twine &contextMessage, wpi::StringRef filename, wpi::StringRef function, int lineNumber)
 
static void SetGlobalWPIError (const wpi::Twine &errorMessage, const wpi::Twine &contextMessage, wpi::StringRef filename, wpi::StringRef function, int lineNumber)
 
static const ErrorGetGlobalError ()
 Retrieve the current global error.
 
- 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
 
- Protected Attributes inherited from frc::ShuffleboardContainer
bool m_isLayout = false
 
- Protected Attributes inherited from frc::ErrorBase
Error m_error
 

Detailed Description

A layout in a Shuffleboard tab.

Layouts can contain widgets and other layouts.

Member Function Documentation

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


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