edu.wpi.first.wpilibj2.command.ScheduleCommand Class Reference

Inheritance diagram for edu.wpi.first.wpilibj2.command.ScheduleCommand:

Public Member Functions
	ScheduleCommand (Command... toSchedule)
void	initialize ()
boolean	isFinished ()
boolean	runsWhenDisabled ()
Public Member Functions inherited from edu.wpi.first.wpilibj2.command.Command
void	execute ()
void	end (boolean interrupted)
Set< Subsystem >	getRequirements ()
final void	addRequirements (Subsystem... requirements)
String	getName ()
void	setName (String name)
String	getSubsystem ()
void	setSubsystem (String subsystem)
ParallelRaceGroup	withTimeout (double seconds)
ParallelRaceGroup	until (BooleanSupplier condition)
ParallelRaceGroup	onlyWhile (BooleanSupplier condition)
SequentialCommandGroup	beforeStarting (Runnable toRun, Subsystem... requirements)
SequentialCommandGroup	beforeStarting (Command before)
SequentialCommandGroup	andThen (Runnable toRun, Subsystem... requirements)
SequentialCommandGroup	andThen (Command... next)
ParallelDeadlineGroup	deadlineWith (Command... parallel)
ParallelCommandGroup	alongWith (Command... parallel)
ParallelRaceGroup	raceWith (Command... parallel)
RepeatCommand	repeatedly ()
ProxyCommand	asProxy ()
ConditionalCommand	unless (BooleanSupplier condition)
ConditionalCommand	onlyIf (BooleanSupplier condition)
WrapperCommand	ignoringDisable (boolean doesRunWhenDisabled)
WrapperCommand	withInterruptBehavior (InterruptionBehavior interruptBehavior)
WrapperCommand	finallyDo (BooleanConsumer end)
WrapperCommand	finallyDo (Runnable end)
WrapperCommand	handleInterrupt (Runnable handler)
void	schedule ()
void	cancel ()
boolean	isScheduled ()
boolean	hasRequirement (Subsystem requirement)
InterruptionBehavior	getInterruptionBehavior ()
WrapperCommand	withName (String name)
void	initSendable (SendableBuilder builder)
Public Member Functions inherited from edu.wpi.first.util.sendable.Sendable

Additional Inherited Members
Protected Member Functions inherited from edu.wpi.first.wpilibj2.command.Command
	Command ()
Protected Attributes inherited from edu.wpi.first.wpilibj2.command.Command
Set< Subsystem >	m_requirements = new HashSet<>()

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

edu.wpi.first.wpilibj2.command.ScheduleCommand.ScheduleCommand

(

Command...

toSchedule

)

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

Parameters

toSchedule

the commands to schedule

Member Function Documentation

initialize()

void edu.wpi.first.wpilibj2.command.ScheduleCommand.initialize

(

)

The initial subroutine of a command. Called once when the command is initially scheduled.

Reimplemented from edu.wpi.first.wpilibj2.command.Command.

isFinished()

boolean edu.wpi.first.wpilibj2.command.ScheduleCommand.isFinished

(

)

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 edu.wpi.first.wpilibj2.command.Command.

runsWhenDisabled()

boolean edu.wpi.first.wpilibj2.command.ScheduleCommand.runsWhenDisabled

(

)

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 edu.wpi.first.wpilibj2.command.Command.

---

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

• D:/SDASVN/2024/RaspberryPi/VSCode/Source/edu/wpi/first/wpilibj2/command/ScheduleCommand.java