WPILibC++ 2024.3.2
frc2::ScheduleCommand Class Reference

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

#include <frc2/command/ScheduleCommand.h>

Inheritance diagram for frc2::ScheduleCommand:
frc2::CommandHelper< Command, ScheduleCommand >

Public Member Functions

 ScheduleCommand (std::span< Command *const > toSchedule)
 Creates a new ScheduleCommand that schedules the given commands when initialized. More...
 
 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 frc2::CommandHelper< Command, ScheduleCommand >
 CommandHelper ()=default
 
CommandPtr ToPtr () &&override
 

Additional Inherited Members

- Protected Member Functions inherited from frc2::CommandHelper< Command, ScheduleCommand >
std::unique_ptr< CommandTransferOwnership () &&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]

frc2::ScheduleCommand::ScheduleCommand ( std::span< Command *const >  toSchedule)
explicit

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

Parameters
toSchedulethe commands to schedule

◆ ScheduleCommand() [2/4]

frc2::ScheduleCommand::ScheduleCommand ( Command toSchedule)
explicit

◆ ScheduleCommand() [3/4]

frc2::ScheduleCommand::ScheduleCommand ( ScheduleCommand &&  other)
default

◆ ScheduleCommand() [4/4]

frc2::ScheduleCommand::ScheduleCommand ( const ScheduleCommand other)
default

Member Function Documentation

◆ Initialize()

void frc2::ScheduleCommand::Initialize ( )
override

◆ IsFinished()

bool frc2::ScheduleCommand::IsFinished ( )
override

◆ RunsWhenDisabled()

bool frc2::ScheduleCommand::RunsWhenDisabled ( ) const
override

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