SendableChooser

class wpilib.SendableChooser(self: wpilib.SendableChooser) → None

Bases: wpilib.SendableChooserBase

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.

@tparam T The type of values to be stored @see SmartDashboard

addOption(self: wpilib.SendableChooser, name: str, object: object) → None

Adds the given object to the list of options.

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

Parameters
  • name – the name of the option

  • object – the option

getSelected(self: wpilib.SendableChooser) → object

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(self: wpilib.SendableChooser, builder: wpilib.SendableBuilder) → None
setDefaultOption(self: wpilib.SendableChooser, name: str, object: object) → None

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
  • name – the name of the option

  • object – the option