Robot Core Documentation
Public Member Functions | List of all members
edu.wpi.first.wpilibj2.command.ProxyScheduleCommand Class Reference
Inheritance diagram for edu.wpi.first.wpilibj2.command.ProxyScheduleCommand:
edu.wpi.first.wpilibj2.command.CommandBase edu.wpi.first.wpilibj2.command.Command

Public Member Functions

 ProxyScheduleCommand (Command... toSchedule)
void initialize ()
void end (boolean interrupted)
void execute ()
boolean isFinished ()
- Public Member Functions inherited from edu.wpi.first.wpilibj2.command.CommandBase
final void addRequirements (Subsystem... requirements)
Set< SubsystemgetRequirements ()
- Public Member Functions inherited from edu.wpi.first.wpilibj2.command.Command
default ParallelRaceGroup withTimeout (double seconds)
default ParallelRaceGroup withInterrupt (BooleanSupplier condition)
default SequentialCommandGroup beforeStarting (Runnable toRun, Subsystem... requirements)
default SequentialCommandGroup andThen (Runnable toRun, Subsystem... requirements)
default SequentialCommandGroup andThen (Command... next)
default ParallelDeadlineGroup deadlineWith (Command... parallel)
default ParallelCommandGroup alongWith (Command... parallel)
default ParallelRaceGroup raceWith (Command... parallel)
default PerpetualCommand perpetually ()
default ProxyScheduleCommand asProxy ()
default void schedule (boolean interruptible)
default void schedule ()
default void cancel ()
default boolean isScheduled ()
default boolean hasRequirement (Subsystem requirement)
default boolean runsWhenDisabled ()
default String getName ()

Additional Inherited Members

- Protected Attributes inherited from edu.wpi.first.wpilibj2.command.CommandBase
Set< Subsystemm_requirements = new HashSet<>()

Detailed Description

Schedules the given commands when this command is initialized, and ends when all the commands are no longer scheduled. Useful for forking off from CommandGroups. If this command is interrupted, it will cancel all of the commands.

Constructor & Destructor Documentation

◆ ProxyScheduleCommand()

edu.wpi.first.wpilibj2.command.ProxyScheduleCommand.ProxyScheduleCommand ( Command...  toSchedule)

Creates a new ProxyScheduleCommand that schedules the given commands when initialized, and ends when they are all no longer scheduled.

toSchedulethe commands to schedule

Member Function Documentation

◆ end()

void edu.wpi.first.wpilibj2.command.ProxyScheduleCommand.end ( boolean  interrupted)

The action to take when the command ends. Called when either the command finishes normally, or when it interrupted/canceled.

Do not schedule commands here that share requirements with this command. Use andThen(Command...) instead.

interruptedwhether the command was interrupted/canceled

Implements edu.wpi.first.wpilibj2.command.Command.

◆ execute()

void edu.wpi.first.wpilibj2.command.ProxyScheduleCommand.execute ( )

The main body of a command. Called repeatedly while the command is scheduled.

Implements edu.wpi.first.wpilibj2.command.Command.

◆ initialize()

void edu.wpi.first.wpilibj2.command.ProxyScheduleCommand.initialize ( )

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

Implements edu.wpi.first.wpilibj2.command.Command.

◆ isFinished()

boolean edu.wpi.first.wpilibj2.command.ProxyScheduleCommand.isFinished ( )

Whether the command has finished. Once a command finishes, the scheduler will call its end() method and un-schedule it.

whether the command has finished.

Implements edu.wpi.first.wpilibj2.command.Command.

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