WPILibC++ 2023.2.1-57-gb879a6f
frc2::SelectCommand< Key > Class Template Reference

A command composition that runs one of a selection of commands, either using a selector and a key to command mapping, or a supplier that returns the command directly at runtime. More...

#include <frc2/command/SelectCommand.h>

Inheritance diagram for frc2::SelectCommand< Key >:
frc2::CommandHelper< CommandBase, SelectCommand< Key > > frc2::CommandBase frc2::Command wpi::Sendable wpi::SendableHelper< CommandBase >

Public Member Functions

template<class... Types, typename = std::enable_if_t<std::conjunction_v< std::is_base_of<Command, std::remove_reference_t<Types>>...>>>
 SelectCommand (std::function< Key()> selector, std::pair< Key, Types >... commands)
 Creates a new SelectCommand. More...
 
 SelectCommand (std::function< Key()> selector, std::vector< std::pair< Key, std::unique_ptr< Command > > > &&commands)
 
 SelectCommand (const SelectCommand &other)=delete
 
 SelectCommand (SelectCommand &)=delete
 
 SelectCommand (std::function< Command *()> toRun)
 Creates a new selectcommand. More...
 
 SelectCommand (SelectCommand &&other)=default
 
void Initialize () override
 The initial subroutine of a command. More...
 
void Execute () override
 The main body of a command. More...
 
void End (bool interrupted) override
 The action to take when the command ends. More...
 
bool IsFinished () override
 Whether the command has finished. More...
 
bool RunsWhenDisabled () const override
 Whether the given command should run when the robot is disabled. More...
 
Command::InterruptionBehavior GetInterruptionBehavior () const override
 How the command behaves when another command with a shared requirement is scheduled. More...
 
void InitSendable (wpi::SendableBuilder &builder) override
 Initializes this Sendable object. More...
 
- Public Member Functions inherited from frc2::CommandHelper< CommandBase, SelectCommand< Key > >
 CommandHelper ()=default
 
CommandPtr ToPtr () &&override
 
- Public Member Functions inherited from frc2::CommandBase
void AddRequirements (std::initializer_list< Subsystem * > requirements)
 Adds the specified Subsystem requirements to the command. More...
 
void AddRequirements (std::span< Subsystem *const > requirements)
 Adds the specified Subsystem requirements to the command. More...
 
void AddRequirements (wpi::SmallSet< Subsystem *, 4 > requirements)
 Adds the specified Subsystem requirements to the command. More...
 
void AddRequirements (Subsystem *requirement)
 Adds the specified Subsystem requirement to the command. More...
 
wpi::SmallSet< Subsystem *, 4 > GetRequirements () const override
 Gets the Subsystem requirements of the command. More...
 
void SetName (std::string_view name) override
 Sets the name of this Command. More...
 
std::string GetName () const override
 Gets the name of this Command. More...
 
std::string GetSubsystem () const
 Gets the subsystem name of this Command. More...
 
void SetSubsystem (std::string_view subsystem)
 Sets the subsystem name of this Command. More...
 
void InitSendable (wpi::SendableBuilder &builder) override
 Initializes this Sendable object. More...
 
- Public Member Functions inherited from frc2::Command
 Command ()=default
 
virtual ~Command ()
 
 Command (const Command &)=default
 
Commandoperator= (const Command &rhs)
 
 Command (Command &&)=default
 
Commandoperator= (Command &&)=default
 
virtual void Initialize ()
 The initial subroutine of a command. More...
 
virtual void Execute ()
 The main body of a command. More...
 
virtual void End (bool interrupted)
 The action to take when the command ends. More...
 
virtual bool IsFinished ()
 Whether the command has finished. More...
 
virtual wpi::SmallSet< Subsystem *, 4 > GetRequirements () const =0
 Specifies the set of subsystems used by this command. More...
 
CommandPtr WithTimeout (units::second_t duration) &&
 Decorates this command with a timeout. More...
 
CommandPtr Until (std::function< bool()> condition) &&
 Decorates this command with an interrupt condition. More...
 
CommandPtr WithInterrupt (std::function< bool()> condition) &&
 Decorates this command with an interrupt condition. More...
 
CommandPtr BeforeStarting (std::function< void()> toRun, std::initializer_list< Subsystem * > requirements) &&
 Decorates this command with a runnable to run before this command starts. More...
 
CommandPtr BeforeStarting (std::function< void()> toRun, std::span< Subsystem *const > requirements={}) &&
 Decorates this command with a runnable to run before this command starts. More...
 
CommandPtr AndThen (std::function< void()> toRun, std::initializer_list< Subsystem * > requirements) &&
 Decorates this command with a runnable to run after the command finishes. More...
 
CommandPtr AndThen (std::function< void()> toRun, std::span< Subsystem *const > requirements={}) &&
 Decorates this command with a runnable to run after the command finishes. More...
 
PerpetualCommand Perpetually () &&
 
CommandPtr Repeatedly () &&
 Decorates this command to run repeatedly, restarting it when it ends, until this command is interrupted. More...
 
CommandPtr AsProxy () &&
 Decorates this command to run "by proxy" by wrapping it in a ProxyCommand. More...
 
CommandPtr Unless (std::function< bool()> condition) &&
 Decorates this command to only run if this condition is not met. More...
 
CommandPtr IgnoringDisable (bool doesRunWhenDisabled) &&
 Decorates this command to run or stop when disabled. More...
 
CommandPtr WithInterruptBehavior (Command::InterruptionBehavior interruptBehavior) &&
 Decorates this command to run or stop when disabled. More...
 
CommandPtr FinallyDo (std::function< void(bool)> end) &&
 Decorates this command with a lambda to call on interrupt or end, following the command's inherent Command::End(bool) method. More...
 
CommandPtr HandleInterrupt (std::function< void()> handler) &&
 Decorates this command with a lambda to call on interrupt, following the command's inherent Command::End(bool) method. More...
 
CommandPtr WithName (std::string_view name) &&
 Decorates this Command with a name. More...
 
void Schedule ()
 Schedules this command. More...
 
void Cancel ()
 Cancels this command. More...
 
bool IsScheduled () const
 Whether or not the command is currently scheduled. More...
 
bool HasRequirement (Subsystem *requirement) const
 Whether the command requires a given subsystem. More...
 
bool IsComposed () const
 Whether the command is currently grouped in a command group. More...
 
void SetComposed (bool isComposed)
 Sets whether the command is currently composed in a command composition. More...
 
bool IsGrouped () const
 Whether the command is currently grouped in a command group. More...
 
void SetGrouped (bool grouped)
 Sets whether the command is currently grouped in a command group. More...
 
virtual bool RunsWhenDisabled () const
 Whether the given command should run when the robot is disabled. More...
 
virtual InterruptionBehavior GetInterruptionBehavior () const
 How the command behaves when another command with a shared requirement is scheduled. More...
 
virtual std::string GetName () const
 Gets the name of this Command. More...
 
virtual void SetName (std::string_view name)
 Sets the name of this Command. More...
 
virtual CommandPtr ToPtr () &&=0
 Transfers ownership of this command to a unique pointer. More...
 
- 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< CommandBase >
 SendableHelper (const SendableHelper &rhs)=default
 
 SendableHelper (SendableHelper &&rhs)
 
SendableHelperoperator= (const SendableHelper &rhs)=default
 
SendableHelperoperator= (SendableHelper &&rhs)
 

Protected Member Functions

std::unique_ptr< CommandTransferOwnership () &&override
 Transfers ownership of this command to a unique pointer. More...
 
- Protected Member Functions inherited from frc2::CommandHelper< CommandBase, SelectCommand< Key > >
std::unique_ptr< CommandTransferOwnership () &&override
 
- Protected Member Functions inherited from frc2::CommandBase
 CommandBase ()
 
virtual std::unique_ptr< CommandTransferOwnership () &&=0
 Transfers ownership of this command to a unique pointer. More...
 
- Protected Member Functions inherited from wpi::SendableHelper< CommandBase >
 SendableHelper ()=default
 
 ~SendableHelper ()
 

Additional Inherited Members

- Public Types inherited from frc2::Command
enum class  InterruptionBehavior { kCancelSelf , kCancelIncoming }
 An enum describing the command's behavior when another command with a shared requirement is scheduled. More...
 
- Protected Attributes inherited from frc2::CommandBase
wpi::SmallSet< Subsystem *, 4 > m_requirements
 
- Protected Attributes inherited from frc2::Command
bool m_isComposed = false
 

Detailed Description

template<typename Key>
class frc2::SelectCommand< Key >

A command composition that runs one of a selection of commands, either using a selector and a key to command mapping, or a supplier that returns the command directly at runtime.

The rules for command compositions apply: command instances that are passed to it are owned by the composition and cannot be added to any other composition or scheduled individually, and the composition requires all subsystems its components require.

This class is provided by the NewCommands VendorDep

Constructor & Destructor Documentation

◆ SelectCommand() [1/6]

template<typename Key >
template<class... Types, typename = std::enable_if_t<std::conjunction_v< std::is_base_of<Command, std::remove_reference_t<Types>>...>>>
frc2::SelectCommand< Key >::SelectCommand ( std::function< Key()>  selector,
std::pair< Key, Types >...  commands 
)
inlineexplicit

Creates a new SelectCommand.

Parameters
commandsthe map of commands to choose from
selectorthe selector to determine which command to run

◆ SelectCommand() [2/6]

template<typename Key >
frc2::SelectCommand< Key >::SelectCommand ( std::function< Key()>  selector,
std::vector< std::pair< Key, std::unique_ptr< Command > > > &&  commands 
)
inline

◆ SelectCommand() [3/6]

template<typename Key >
frc2::SelectCommand< Key >::SelectCommand ( const SelectCommand< Key > &  other)
delete

◆ SelectCommand() [4/6]

template<typename Key >
frc2::SelectCommand< Key >::SelectCommand ( SelectCommand< Key > &  )
delete

◆ SelectCommand() [5/6]

template<typename Key >
frc2::SelectCommand< Key >::SelectCommand ( std::function< Command *()>  toRun)
inlineexplicit

Creates a new selectcommand.

Parameters
toRuna supplier providing the command to run
Deprecated:
Replace with ProxyCommand, composing multiple of them in a ParallelRaceGroup if needed.

◆ SelectCommand() [6/6]

template<typename Key >
frc2::SelectCommand< Key >::SelectCommand ( SelectCommand< Key > &&  other)
default

Member Function Documentation

◆ End()

template<typename Key >
void frc2::SelectCommand< Key >::End ( bool  interrupted)
inlineoverridevirtual

The action to take when the command ends.

Called when either the command finishes normally, or when it interrupted/canceled.

Parameters
interruptedwhether the command was interrupted/canceled

Reimplemented from frc2::Command.

◆ Execute()

template<typename Key >
void frc2::SelectCommand< Key >::Execute ( )
inlineoverridevirtual

The main body of a command.

Called repeatedly while the command is scheduled.

Reimplemented from frc2::Command.

◆ GetInterruptionBehavior()

template<typename Key >
Command::InterruptionBehavior frc2::SelectCommand< Key >::GetInterruptionBehavior ( ) const
inlineoverridevirtual

How the command behaves when another command with a shared requirement is scheduled.

Returns
a variant of InterruptionBehavior, defaulting to kCancelSelf.

Reimplemented from frc2::Command.

◆ Initialize()

template<typename T >
void frc2::SelectCommand< T >::Initialize ( )
overridevirtual

The initial subroutine of a command.

Called once when the command is initially scheduled.

Reimplemented from frc2::Command.

◆ InitSendable()

template<typename Key >
void frc2::SelectCommand< Key >::InitSendable ( wpi::SendableBuilder builder)
inlineoverridevirtual

Initializes this Sendable object.

Parameters
buildersendable builder

Reimplemented from frc2::CommandBase.

◆ IsFinished()

template<typename Key >
bool frc2::SelectCommand< Key >::IsFinished ( )
inlineoverridevirtual

Whether the command has finished.

Once a command finishes, the scheduler will call its end() method and un-schedule it.

Returns
whether the command has finished.

Reimplemented from frc2::Command.

◆ RunsWhenDisabled()

template<typename Key >
bool frc2::SelectCommand< Key >::RunsWhenDisabled ( ) const
inlineoverridevirtual

Whether the given command should run when the robot is disabled.

Override to return true if the command should run when disabled.

Returns
whether the command should run when the robot is disabled

Reimplemented from frc2::Command.

◆ TransferOwnership()

template<typename Key >
std::unique_ptr< Command > frc2::SelectCommand< Key >::TransferOwnership ( ) &&
inlineoverrideprotectedvirtual

Transfers ownership of this command to a unique pointer.

Used for decorator methods.

Implements frc2::Command.


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