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

Public Member Functions

 SequentialCommandGroup (Command... commands)
final void addCommands (Command... commands)
void initialize ()
void execute ()
void end (boolean interrupted)
boolean isFinished ()
boolean runsWhenDisabled ()
- 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 String getName ()

Additional Inherited Members

- Static Public Member Functions inherited from edu.wpi.first.wpilibj2.command.CommandGroupBase
static void clearGroupedCommands ()
static void clearGroupedCommand (Command command)
static void requireUngrouped (Command... commands)
static void requireUngrouped (Collection< Command > commands)
static CommandGroupBase sequence (Command... commands)
static CommandGroupBase parallel (Command... commands)
static CommandGroupBase race (Command... commands)
static CommandGroupBase deadline (Command deadline, Command... commands)
- Protected Attributes inherited from edu.wpi.first.wpilibj2.command.CommandBase
Set< Subsystemm_requirements = new HashSet<>()

Detailed Description

A CommandGroups that runs a list of commands in sequence.

As a rule, CommandGroups require the union of the requirements of their component commands.

Constructor & Destructor Documentation

◆ SequentialCommandGroup()

edu.wpi.first.wpilibj2.command.SequentialCommandGroup.SequentialCommandGroup ( Command...  commands)

Creates a new SequentialCommandGroup. The given commands will be run sequentially, with the CommandGroup finishing when the last command finishes.

commandsthe commands to include in this group.

Member Function Documentation

◆ addCommands()

final void edu.wpi.first.wpilibj2.command.SequentialCommandGroup.addCommands ( Command...  commands)

Adds the given commands to the command group.

commandsThe commands to add.

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

◆ end()

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

◆ runsWhenDisabled()

boolean edu.wpi.first.wpilibj2.command.SequentialCommandGroup.runsWhenDisabled ( )

Whether the given command should run when the robot is disabled. Override to return true if the command should run when disabled.

whether the command should run when the robot is disabled

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

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