Robot Core Documentation
Loading...
Searching...
No Matches
edu.wpi.first.wpilibj2.command.CommandGroupBase Class Referenceabstract
Inheritance diagram for edu.wpi.first.wpilibj2.command.CommandGroupBase:
edu.wpi.first.wpilibj2.command.CommandBase edu.wpi.first.wpilibj2.command.Command edu.wpi.first.util.sendable.Sendable

Public Member Functions

abstract void addCommands (Command... commands)
 
- Public Member Functions inherited from edu.wpi.first.wpilibj2.command.CommandBase
 CommandBase ()
 
- Public Member Functions inherited from edu.wpi.first.wpilibj2.command.Command
void initialize ()
 
void execute ()
 
void end (boolean interrupted)
 
boolean isFinished ()
 
Set< SubsystemgetRequirements ()
 
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 ()
 
boolean runsWhenDisabled ()
 
WrapperCommand withName (String name)
 
void initSendable (SendableBuilder builder)
 
- Public Member Functions inherited from edu.wpi.first.util.sendable.Sendable

Static Public Member Functions

static SequentialCommandGroup sequence (Command... commands)
 
static ParallelCommandGroup parallel (Command... commands)
 
static ParallelRaceGroup race (Command... commands)
 
static ParallelDeadlineGroup deadline (Command deadline, Command... commands)
 

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< Subsystemm_requirements = new HashSet<>()
 

Detailed Description

A base for CommandGroups.

This class is provided by the NewCommands VendorDep

Deprecated
This class is an empty abstraction. Inherit directly from CommandBase/Command.

Member Function Documentation

◆ addCommands()

abstract void edu.wpi.first.wpilibj2.command.CommandGroupBase.addCommands ( Command... commands)
abstract

Adds the given commands to the command group.

Parameters
commandsThe commands to add.

◆ deadline()

static ParallelDeadlineGroup edu.wpi.first.wpilibj2.command.CommandGroupBase.deadline ( Command deadline,
Command... commands )
static

Factory method for ParallelDeadlineGroup, included for brevity/convenience.

Parameters
deadlinethe deadline command
commandsthe commands to include
Returns
the command group
Deprecated
Replace with Commands#deadline(Command, Command...)

◆ parallel()

static ParallelCommandGroup edu.wpi.first.wpilibj2.command.CommandGroupBase.parallel ( Command... commands)
static

Factory method for ParallelCommandGroup, included for brevity/convenience.

Parameters
commandsthe commands to include
Returns
the command group
Deprecated
Replace with Commands#parallel(Command...)

◆ race()

static ParallelRaceGroup edu.wpi.first.wpilibj2.command.CommandGroupBase.race ( Command... commands)
static

Factory method for ParallelRaceGroup, included for brevity/convenience.

Parameters
commandsthe commands to include
Returns
the command group
Deprecated
Replace with Commands#race(Command...)

◆ sequence()

static SequentialCommandGroup edu.wpi.first.wpilibj2.command.CommandGroupBase.sequence ( Command... commands)
static

Factory method for SequentialCommandGroup, included for brevity/convenience.

Parameters
commandsthe commands to include
Returns
the command group
Deprecated
Replace with Commands#sequence(Command...)

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