WPILibC++
2019.1.1-4-g308bdbe
|
A layout in a Shuffleboard tab. More...
#include <ShuffleboardLayout.h>
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... | |
![]() | |
ShuffleboardComponent (ShuffleboardContainer &parent, const wpi::Twine &title, const wpi::Twine &type="") | |
ShuffleboardLayout & | WithProperties (const wpi::StringMap< std::shared_ptr< nt::Value >> &properties) |
Sets custom properties for this component. More... | |
ShuffleboardLayout & | WithPosition (int columnIndex, int rowIndex) |
Sets the position of this component in the tab. More... | |
ShuffleboardLayout & | WithSize (int width, int height) |
Sets the size of this component in the tab. More... | |
![]() | |
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) |
ShuffleboardContainer & | GetParent () |
const std::string & | GetType () const |
![]() | |
ShuffleboardValue (const wpi::Twine &title) | |
wpi::StringRef | GetTitle () const |
Gets the title of this Shuffleboard value. | |
![]() | |
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, 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... | |
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... | |
![]() | |
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... | |
Additional Inherited Members | |
![]() | |
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 Error & | GetGlobalError () |
Retrieve the current global error. | |
![]() | |
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 |
![]() | |
bool | m_isLayout = false |
![]() | |
Error | m_error |
A layout in a Shuffleboard tab.
Layouts can contain widgets and other layouts.
|
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.