A class used internally to wrap commands while overriding a specific method; all other methods will call through to the wrapped command. More...

#include <frc2/command/WrapperCommand.h>

Inheritance diagram for frc2::WrapperCommand:

Public Member Functions
	WrapperCommand (std::unique_ptr< Command > &&command)
	Wrap a command. More...

template<class T , typename = std::enable_if_t<std::is_base_of_v< Command, std::remove_reference_t<T>>>>
	WrapperCommand (T &&command)
	Wrap a command. More...

	WrapperCommand (WrapperCommand &&other)=default

	WrapperCommand (const WrapperCommand &other)=delete

	WrapperCommand (WrapperCommand &)=delete

void	Initialize () override
	The initial subroutine of a command. More...

void	Execute () override
	The main body of a command. More...

bool	IsFinished () override
	Whether the command has finished. More...

void	End (bool interrupted) override
	The action to take when the command ends. More...

bool	RunsWhenDisabled () const override
	Whether the given command should run when the robot is disabled. More...

InterruptionBehavior	GetInterruptionBehavior () const override
	How the command behaves when another command with a shared requirement is scheduled. More...

wpi::SmallSet< Subsystem *, 4 >	GetRequirements () const override
	Gets the Subsystem requirements of the command. More...

Public Member Functions inherited from frc2::CommandHelper< CommandBase, WrapperCommand >
	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

Command &	operator= (const Command &rhs)

	Command (Command &&)=default

Command &	operator= (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)

SendableHelper &	operator= (const SendableHelper &rhs)=default

SendableHelper &	operator= (SendableHelper &&rhs)

Protected Attributes
std::unique_ptr< Command >	m_command

Protected Attributes inherited from frc2::CommandBase
wpi::SmallSet< Subsystem *, 4 >	m_requirements

Protected Attributes inherited from frc2::Command
bool	m_isComposed = false

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 Member Functions inherited from frc2::CommandHelper< CommandBase, WrapperCommand >
std::unique_ptr< Command >	TransferOwnership () &&override

Protected Member Functions inherited from frc2::CommandBase
	CommandBase ()

virtual std::unique_ptr< Command >	TransferOwnership () &&=0
	Transfers ownership of this command to a unique pointer. More...

Protected Member Functions inherited from wpi::SendableHelper< CommandBase >
	SendableHelper ()=default

	~SendableHelper ()

Detailed Description

A class used internally to wrap commands while overriding a specific method; all other methods will call through to the wrapped command.

Wrapped commands may only be used through the wrapper, trying to directly schedule them or add them to a group will throw an exception.

Constructor & Destructor Documentation

◆ WrapperCommand() [1/5]

frc2::WrapperCommand::WrapperCommand ( std::unique_ptr< Command > && command )

explicit

Wrap a command.

Parameters

command the command being wrapped. Trying to directly schedule this command or add it to a group will throw an exception.

◆ WrapperCommand() [2/5]

template<class T , typename = std::enable_if_t<std::is_base_of_v< Command, std::remove_reference_t<T>>>>

frc2::WrapperCommand::WrapperCommand ( T && command )

inlineexplicit

Wrap a command.

Parameters

command the command being wrapped. Trying to directly schedule this command or add it to a group will throw an exception.

◆ WrapperCommand() [3/5]

frc2::WrapperCommand::WrapperCommand ( WrapperCommand && other )

default

◆ WrapperCommand() [4/5]

frc2::WrapperCommand::WrapperCommand ( const WrapperCommand & other )

delete

◆ WrapperCommand() [5/5]

frc2::WrapperCommand::WrapperCommand ( WrapperCommand & )

delete

Member Function Documentation

◆ End()

void frc2::WrapperCommand::End ( bool interrupted )

overridevirtual

The action to take when the command ends.

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

Parameters

interrupted whether the command was interrupted/canceled

Reimplemented from frc2::Command.

◆ Execute()

void frc2::WrapperCommand::Execute ( )

overridevirtual

The main body of a command.

Called repeatedly while the command is scheduled.

Reimplemented from frc2::Command.

◆ GetInterruptionBehavior()

InterruptionBehavior frc2::WrapperCommand::GetInterruptionBehavior ( ) const

overridevirtual

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.

◆ GetRequirements()

wpi::SmallSet< Subsystem *, 4 > frc2::WrapperCommand::GetRequirements ( ) const

overridevirtual

Gets the Subsystem requirements of the command.

Returns: the Command's Subsystem requirements

Reimplemented from frc2::CommandBase.

◆ Initialize()

void frc2::WrapperCommand::Initialize ( )

overridevirtual

The initial subroutine of a command.

Called once when the command is initially scheduled.

Reimplemented from frc2::Command.

◆ IsFinished()

bool frc2::WrapperCommand::IsFinished ( )

overridevirtual

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()

bool frc2::WrapperCommand::RunsWhenDisabled ( ) const

overridevirtual

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.

Member Data Documentation

◆ m_command

std::unique_ptr<Command> frc2::WrapperCommand::m_command

protected

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

frc2/command/WrapperCommand.h

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ WrapperCommand() [1/5]

◆ WrapperCommand() [2/5]

◆ WrapperCommand() [3/5]

◆ WrapperCommand() [4/5]

◆ WrapperCommand() [5/5]

Member Function Documentation

◆ End()

◆ Execute()

◆ GetInterruptionBehavior()

◆ GetRequirements()

◆ Initialize()

◆ IsFinished()

◆ RunsWhenDisabled()

Member Data Documentation

◆ m_command