WPILibC++  unspecified
 All Classes Files Functions Variables Typedefs Enumerations Enumerator Pages
frc::SendableChooser Class Reference

The SendableChooser class is a useful tool for presenting a selection of options to the SmartDashboard. More...

#include <SendableChooser.h>

Inheritance diagram for frc::SendableChooser:
frc::Sendable

Public Member Functions

void AddObject (const std::string &name, void *object)
 Adds the given object to the list of options. More...
 
void AddDefault (const std::string &name, void *object)
 Add the given object to the list of options and marks it as the default. More...
 
void * GetSelected ()
 Returns the selected option. More...
 
void InitTable (std::shared_ptr< ITable > subtable) override
 Initializes a table for this sendable object. More...
 
std::shared_ptr< ITableGetTable () const override
 
std::string GetSmartDashboardType () const override
 

Detailed Description

The SendableChooser class is a useful tool for presenting a selection of options to the SmartDashboard.

For instance, you may wish to be able to select between multiple autonomous modes. You can do this by putting every possible Command you want to run as an autonomous into a SendableChooser and then put it into the SmartDashboard to have a list of options appear on the laptop. Once autonomous starts, simply ask the SendableChooser what the selected value is.

See Also
SmartDashboard

Member Function Documentation

void SendableChooser::AddDefault ( const std::string &  name,
void *  object 
)

Add the given object to the list of options and marks it as the default.

Functionally, this is very close to char *name, void *object) AddObject(...) except that it will use this as the default option if none other is explicitly selected.

Parameters
namethe name of the option
objectthe option
void SendableChooser::AddObject ( const std::string &  name,
void *  object 
)

Adds the given object to the list of options.

On the SmartDashboard on the desktop, the object will appear as the given name.

Parameters
namethe name of the option
objectthe option
void * SendableChooser::GetSelected ( )

Returns the selected option.

If there is none selected, it will return the default. If there is none selected and no default, then it will return

nullptr

.

Returns
the option selected
std::string SendableChooser::GetSmartDashboardType ( ) const
overridevirtual
Returns
the string representation of the named data type that will be used by the smart dashboard for this sendable

Implements frc::Sendable.

std::shared_ptr< ITable > SendableChooser::GetTable ( ) const
overridevirtual
Returns
the table that is currently associated with the sendable

Implements frc::Sendable.

void SendableChooser::InitTable ( std::shared_ptr< ITable subtable)
overridevirtual

Initializes a table for this sendable object.

Parameters
subtableThe table to put the values in.

Implements frc::Sendable.


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