|
WPILibC++
2020.3.2
|
Represents a tab in the Shuffleboard dashboard. More...
#include <ShuffleboardTab.h>
Public Member Functions | |
| ShuffleboardTab (ShuffleboardRoot &root, wpi::StringRef title) | |
| ShuffleboardRoot & | GetRoot () |
| 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::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. | |
| ShuffleboardLayout & | GetLayout (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... | |
| ShuffleboardLayout & | GetLayout (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... | |
| ShuffleboardLayout & | GetLayout (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... | |
| ShuffleboardLayout & | GetLayout (const wpi::Twine &title) |
| Gets the already-defined layout in this container with the given title. More... | |
| ComplexWidget & | Add (const wpi::Twine &title, Sendable &sendable) |
| Adds a widget to this container to display the given sendable. More... | |
| ComplexWidget & | Add (const wpi::Twine &title, const cs::VideoSource &video) |
| Adds a widget to this container to display the given video stream. More... | |
| ComplexWidget & | Add (Sendable &sendable) |
| Adds a widget to this container to display the given sendable. More... | |
| ComplexWidget & | Add (const cs::VideoSource &video) |
| Adds a widget to this container to display the given video stream. More... | |
| SimpleWidget & | Add (const wpi::Twine &title, std::shared_ptr< nt::Value > defaultValue) |
| Adds a widget to this container to display the given data. More... | |
| SimpleWidget & | Add (const wpi::Twine &title, bool defaultValue) |
| Adds a widget to this container to display the given data. More... | |
| SimpleWidget & | Add (const wpi::Twine &title, double defaultValue) |
| Adds a widget to this container to display the given data. More... | |
| SimpleWidget & | Add (const wpi::Twine &title, int defaultValue) |
| Adds a widget to this container to display the given data. More... | |
| SimpleWidget & | Add (const wpi::Twine &title, const wpi::Twine &defaultValue) |
| Adds a widget to this container to display the given data. More... | |
| SimpleWidget & | Add (const wpi::Twine &title, const char *defaultValue) |
| Adds a widget to this container to display the given data. More... | |
| SimpleWidget & | Add (const wpi::Twine &title, wpi::ArrayRef< bool > defaultValue) |
| Adds a widget to this container to display the given data. More... | |
| SimpleWidget & | Add (const wpi::Twine &title, wpi::ArrayRef< double > defaultValue) |
| Adds a widget to this container to display the given data. More... | |
| SimpleWidget & | Add (const wpi::Twine &title, wpi::ArrayRef< std::string > defaultValue) |
| Adds a widget to this container to display the given data. More... | |
| SuppliedValueWidget< std::string > & | AddString (const wpi::Twine &title, std::function< std::string()> supplier) |
| Adds a widget to this container. More... | |
| SuppliedValueWidget< double > & | AddNumber (const wpi::Twine &title, std::function< double()> supplier) |
| Adds a widget to this container. More... | |
| SuppliedValueWidget< bool > & | AddBoolean (const wpi::Twine &title, std::function< bool()> supplier) |
| Adds a widget to this container. More... | |
| SuppliedValueWidget< std::vector< std::string > > & | AddStringArray (const wpi::Twine &title, std::function< std::vector< std::string >()> supplier) |
| Adds a widget to this container. More... | |
| SuppliedValueWidget< std::vector< double > > & | AddNumberArray (const wpi::Twine &title, std::function< std::vector< double >()> supplier) |
| Adds a widget to this container. More... | |
| SuppliedValueWidget< std::vector< int > > & | AddBooleanArray (const wpi::Twine &title, std::function< std::vector< int >()> supplier) |
| Adds a widget to this container. More... | |
| SuppliedValueWidget< wpi::StringRef > & | AddRaw (const wpi::Twine &title, std::function< wpi::StringRef()> supplier) |
| Adds a widget to this container. More... | |
| SimpleWidget & | AddPersistent (const wpi::Twine &title, std::shared_ptr< nt::Value > defaultValue) |
| Adds a widget to this container to display a simple piece of data. More... | |
| SimpleWidget & | AddPersistent (const wpi::Twine &title, bool defaultValue) |
| Adds a widget to this container to display a simple piece of data. More... | |
| SimpleWidget & | AddPersistent (const wpi::Twine &title, double defaultValue) |
| Adds a widget to this container to display a simple piece of data. More... | |
| SimpleWidget & | AddPersistent (const wpi::Twine &title, int defaultValue) |
| Adds a widget to this container to display a simple piece of data. More... | |
| SimpleWidget & | AddPersistent (const wpi::Twine &title, const wpi::Twine &defaultValue) |
| Adds a widget to this container to display a simple piece of data. More... | |
| SimpleWidget & | AddPersistent (const wpi::Twine &title, wpi::ArrayRef< bool > defaultValue) |
| Adds a widget to this container to display a simple piece of data. More... | |
| SimpleWidget & | AddPersistent (const wpi::Twine &title, wpi::ArrayRef< double > defaultValue) |
| Adds a widget to this container to display a simple piece of data. More... | |
| SimpleWidget & | AddPersistent (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::ShuffleboardValue | |
| ShuffleboardValue (const wpi::Twine &title) | |
| wpi::StringRef | GetTitle () const |
| Gets the title of this Shuffleboard value. | |
Public Member Functions inherited from frc::ErrorBase | |
| ErrorBase (const ErrorBase &)=default | |
| ErrorBase & | operator= (const ErrorBase &)=default |
| ErrorBase (ErrorBase &&)=default | |
| ErrorBase & | operator= (ErrorBase &&)=default |
| virtual Error & | GetError () |
| Retrieve the current error. More... | |
| virtual const Error & | GetError () 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... | |
| void | ClearGlobalErrors () |
| Clear global errors. | |
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 Error | GetGlobalError () |
| Retrieve the last global error. | |
| static std::vector< Error > | GetGlobalErrors () |
| Retrieve all global errors. | |
Protected Attributes inherited from frc::ShuffleboardContainer | |
| bool | m_isLayout = false |
Protected Attributes inherited from frc::ErrorBase | |
| Error | m_error |
Represents a tab in the Shuffleboard dashboard.
Widgets can be added to the tab with add(Sendable), add(String, Object), and add(String, Sendable). Widgets can also be added to layouts with getLayout(String, String); layouts can be nested arbitrarily deep (note that too many levels may make deeper components unusable).
|
overridevirtual |
Builds the entries for this value.
| parentTable | The table containing all the data for the parent. Values that require a complex entry or table structure should call parentTable.getSubtable(getTitle())
parentTable.getEntry(getTitle())
|
| metaTable | The table containing all the metadata for this value and its sub-values |
Implements frc::ShuffleboardValue.