A command that runs a given runnable when it is initialized, and another runnable when it ends. More...

#include <frc2/command/StartEndCommand.h>

Inheritance diagram for frc2::StartEndCommand:

Public Member Functions
	StartEndCommand (std::function< void()> onInit, std::function< void()> onEnd, std::initializer_list< Subsystem * > requirements)
	Creates a new StartEndCommand. More...

	StartEndCommand (std::function< void()> onInit, std::function< void()> onEnd, std::span< Subsystem *const > requirements={})
	Creates a new StartEndCommand. More...

	StartEndCommand (StartEndCommand &&other)=default

	StartEndCommand (const StartEndCommand &other)=default

Public Member Functions inherited from frc2::CommandHelper< FunctionalCommand, StartEndCommand >
	CommandHelper ()=default

CommandPtr	ToPtr () &&override

Additional Inherited Members
Protected Member Functions inherited from frc2::CommandHelper< FunctionalCommand, StartEndCommand >
std::unique_ptr< Command >	TransferOwnership () &&override

Detailed Description

A command that runs a given runnable when it is initialized, and another runnable when it ends.

Useful for running and then stopping a motor, or extending and then retracting a solenoid. Has no end condition as-is; either subclass it or use Command.WithTimeout() or Command.Until() to give it one.

This class is provided by the NewCommands VendorDep

Constructor & Destructor Documentation

◆ StartEndCommand() [1/4]

frc2::StartEndCommand::StartEndCommand	(	std::function< void()>	onInit,
		std::function< void()>	onEnd,
		std::initializer_list< Subsystem * >	requirements
	)

Creates a new StartEndCommand.

Will run the given runnables when the command starts and when it ends.

Parameters

onInit	the Runnable to run on command init
onEnd	the Runnable to run on command end
requirements	the subsystems required by this command

◆ StartEndCommand() [2/4]

frc2::StartEndCommand::StartEndCommand	(	std::function< void()>	onInit,
		std::function< void()>	onEnd,
		std::span< Subsystem *const >	requirements = `{}`
	)

Creates a new StartEndCommand.

Will run the given runnables when the command starts and when it ends.

Parameters

onInit	the Runnable to run on command init
onEnd	the Runnable to run on command end
requirements	the subsystems required by this command

◆ StartEndCommand() [3/4]

frc2::StartEndCommand::StartEndCommand ( StartEndCommand && other )

default

◆ StartEndCommand() [4/4]

frc2::StartEndCommand::StartEndCommand ( const StartEndCommand & other )