WPILibC++ 2024.1.1-beta-4
frc::SendableChooser< T > Class Template Reference

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

#include <frc/smartdashboard/SendableChooser.h>

Inheritance diagram for frc::SendableChooser< T >:
frc::SendableChooserBase wpi::Sendable wpi::SendableHelper< SendableChooserBase >

Public Member Functions

 SendableChooser ()=default
 
 ~SendableChooser () override=default
 
 SendableChooser (SendableChooser &&rhs)=default
 
SendableChooseroperator= (SendableChooser &&rhs)=default
 
void AddOption (std::string_view name, T object)
 Adds the given object to the list of options. More...
 
void SetDefaultOption (std::string_view name, T object)
 Add the given object to the list of options and marks it as the default. More...
 
auto GetSelected () -> decltype(_unwrap_smart_ptr(m_choices[""]))
 Returns a copy of the selected option (a raw pointer U* if T = std::unique_ptr<U> or a std::weak_ptr<U> if T = std::shared_ptr<U>). More...
 
void OnChange (std::function< void(T)>)
 Bind a listener that's called when the selected value changes. More...
 
void InitSendable (wpi::SendableBuilder &builder) override
 Initializes this Sendable object. More...
 
- Public Member Functions inherited from frc::SendableChooserBase
 SendableChooserBase ()
 
 ~SendableChooserBase () override=default
 
 SendableChooserBase (SendableChooserBase &&oth)
 
SendableChooserBaseoperator= (SendableChooserBase &&oth)
 
- Public Member Functions inherited from wpi::Sendable
virtual ~Sendable ()=default
 
virtual void InitSendable (SendableBuilder &builder)=0
 Initializes this Sendable object. More...
 
- Public Member Functions inherited from wpi::SendableHelper< SendableChooserBase >
 SendableHelper (const SendableHelper &rhs)=default
 
 SendableHelper (SendableHelper &&rhs)
 
SendableHelperoperator= (const SendableHelper &rhs)=default
 
SendableHelperoperator= (SendableHelper &&rhs)
 

Additional Inherited Members

- Protected Member Functions inherited from wpi::SendableHelper< SendableChooserBase >
 SendableHelper ()=default
 
 ~SendableHelper ()
 
- Protected Attributes inherited from frc::SendableChooserBase
std::string m_defaultChoice
 
std::string m_selected
 
bool m_haveSelected = false
 
wpi::mutex m_mutex
 
int m_instance
 
std::string m_previousVal
 
- Static Protected Attributes inherited from frc::SendableChooserBase
static constexpr const char * kDefault = "default"
 
static constexpr const char * kOptions = "options"
 
static constexpr const char * kSelected = "selected"
 
static constexpr const char * kActive = "active"
 
static constexpr const char * kInstance = ".instance"
 
static std::atomic_int s_instances
 

Detailed Description

template<class T>
requires std::copy_constructible<T> && std::default_initializable<T>
class frc::SendableChooser< T >

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.

Template Parameters
TThe type of values to be stored
See also
SmartDashboard

Constructor & Destructor Documentation

◆ SendableChooser() [1/2]

template<class T >
frc::SendableChooser< T >::SendableChooser ( )
default

◆ ~SendableChooser()

template<class T >
frc::SendableChooser< T >::~SendableChooser ( )
overridedefault

◆ SendableChooser() [2/2]

template<class T >
frc::SendableChooser< T >::SendableChooser ( SendableChooser< T > &&  rhs)
default

Member Function Documentation

◆ AddOption()

template<class T >
requires std::copy_constructible<T> && std::default_initializable<T>
void frc::SendableChooser< T >::AddOption ( std::string_view  name,
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

◆ GetSelected()

template<class T >
requires std::copy_constructible<T> && std::default_initializable<T>
auto frc::SendableChooser< T >::GetSelected

Returns a copy of the selected option (a raw pointer U* if T = std::unique_ptr<U> or a std::weak_ptr<U> if T = std::shared_ptr<U>).

If there is none selected, it will return the default. If there is none selected and no default, then it will return a value-initialized instance. For integer types, this is 0. For container types like std::string, this is an empty string.

Returns
The option selected

◆ InitSendable()

template<class T >
requires std::copy_constructible<T> && std::default_initializable<T>
void frc::SendableChooser< T >::InitSendable ( wpi::SendableBuilder builder)
overridevirtual

Initializes this Sendable object.

Parameters
buildersendable builder

Implements wpi::Sendable.

◆ OnChange()

template<class T >
requires std::copy_constructible<T> && std::default_initializable<T>
void frc::SendableChooser< T >::OnChange ( std::function< void(T)>  listener)

Bind a listener that's called when the selected value changes.

Only one listener can be bound. Calling this function will replace the previous listener.

Parameters
listenerThe function to call that accepts the new value

◆ operator=()

template<class T >
SendableChooser & frc::SendableChooser< T >::operator= ( SendableChooser< T > &&  rhs)
default

◆ SetDefaultOption()

template<class T >
requires std::copy_constructible<T> && std::default_initializable<T>
void frc::SendableChooser< T >::SetDefaultOption ( std::string_view  name,
object 
)

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

Functionally, this is very close to AddOption() except that it will use this as the default option if none other is explicitly selected.

Parameters
namethe name of the option
objectthe option

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