wpi::cmd::ScheduleCommand Class Reference

Schedules the given commands when this command is initialized. More...

#include <wpi/commands2/ScheduleCommand.hpp>

Inheritance diagram for wpi::cmd::ScheduleCommand:

Public Member Functions
	ScheduleCommand (std::span< Command *const > toSchedule)
	Creates a new ScheduleCommand that schedules the given commands when initialized.
	ScheduleCommand (Command *toSchedule)
	ScheduleCommand (ScheduleCommand &&other)=default
	ScheduleCommand (const ScheduleCommand &other)=default
void	Initialize () override
bool	IsFinished () override
bool	RunsWhenDisabled () const override
Public Member Functions inherited from wpi::cmd::CommandHelper< Command, ScheduleCommand >
	CommandHelper ()=default
CommandPtr	ToPtr () &&override

Detailed Description

Schedules the given commands when this command is initialized.

Useful for forking off from CommandGroups. Note that if run from a composition, the composition will not know about the status of the scheduled commands, and will treat this command as finishing instantly.

This class is provided by the NewCommands VendorDep

Constructor & Destructor Documentation

ScheduleCommand() [1/4]

wpi::cmd::ScheduleCommand::ScheduleCommand ( std::span< Command *const > toSchedule )

explicit

Creates a new ScheduleCommand that schedules the given commands when initialized.

Parameters

toSchedule

the commands to schedule

ScheduleCommand() [2/4]

wpi::cmd::ScheduleCommand::ScheduleCommand ( Command * toSchedule )

explicit

ScheduleCommand() [3/4]

wpi::cmd::ScheduleCommand::ScheduleCommand ( ScheduleCommand && other )

default

ScheduleCommand() [4/4]

wpi::cmd::ScheduleCommand::ScheduleCommand ( const ScheduleCommand & other )

default

Member Function Documentation

Initialize()

void wpi::cmd::ScheduleCommand::Initialize ( )

override

IsFinished()

bool wpi::cmd::ScheduleCommand::IsFinished ( )

override

RunsWhenDisabled()

bool wpi::cmd::ScheduleCommand::RunsWhenDisabled ( ) const

override

---

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

• wpi/commands2/ScheduleCommand.hpp