Robot Core Documentation
|
Additional Inherited Members | |
![]() | |
Command () | |
![]() | |
Set< Subsystem > | m_requirements = new HashSet<>() |
A command composition that runs a set of commands in parallel, ending only when a specific command (the "deadline") ends, interrupting all other commands that are still running at that point.
The rules for command compositions apply: command instances that are passed to it cannot be added to any other composition or scheduled individually, and the composition requires all subsystems its components require.
This class is provided by the NewCommands VendorDep
edu.wpi.first.wpilibj2.command.ParallelDeadlineGroup.ParallelDeadlineGroup | ( | Command | deadline, |
Command... | otherCommands ) |
Creates a new ParallelDeadlineGroup. The given commands, including the deadline, will be executed simultaneously. The composition will finish when the deadline finishes, interrupting all other still-running commands. If the composition is interrupted, only the commands still running will be interrupted.
deadline | the command that determines when the composition ends |
otherCommands | the other commands to be executed |
IllegalArgumentException | if the deadline command is also in the otherCommands argument |
final void edu.wpi.first.wpilibj2.command.ParallelDeadlineGroup.addCommands | ( | Command... | commands | ) |
Adds the given commands to the group.
commands | Commands to add to the group. |
final void edu.wpi.first.wpilibj2.command.ParallelDeadlineGroup.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.
interrupted | whether the command was interrupted/canceled |
Reimplemented from edu.wpi.first.wpilibj2.command.Command.
final void edu.wpi.first.wpilibj2.command.ParallelDeadlineGroup.execute | ( | ) |
The main body of a command. Called repeatedly while the command is scheduled.
Reimplemented from edu.wpi.first.wpilibj2.command.Command.
InterruptionBehavior edu.wpi.first.wpilibj2.command.ParallelDeadlineGroup.getInterruptionBehavior | ( | ) |
How the command behaves when another command with a shared requirement is scheduled.
InterruptionBehavior
, defaulting to kCancelSelf
. Reimplemented from edu.wpi.first.wpilibj2.command.Command.
final void edu.wpi.first.wpilibj2.command.ParallelDeadlineGroup.initialize | ( | ) |
The initial subroutine of a command. Called once when the command is initially scheduled.
Reimplemented from edu.wpi.first.wpilibj2.command.Command.
void edu.wpi.first.wpilibj2.command.ParallelDeadlineGroup.initSendable | ( | SendableBuilder | builder | ) |
Initializes this Sendable
object.
builder | sendable builder |
Reimplemented from edu.wpi.first.wpilibj2.command.Command.
final boolean edu.wpi.first.wpilibj2.command.ParallelDeadlineGroup.isFinished | ( | ) |
Whether the command has finished. Once a command finishes, the scheduler will call its end() method and un-schedule it.
Reimplemented from edu.wpi.first.wpilibj2.command.Command.
boolean edu.wpi.first.wpilibj2.command.ParallelDeadlineGroup.runsWhenDisabled | ( | ) |
Whether the given command should run when the robot is disabled. Override to return true if the command should run when disabled.
Reimplemented from edu.wpi.first.wpilibj2.command.Command.
final void edu.wpi.first.wpilibj2.command.ParallelDeadlineGroup.setDeadline | ( | Command | deadline | ) |
Sets the deadline to the given command. The deadline is added to the group if it is not already contained.
deadline | the command that determines when the group ends |
IllegalArgumentException | if the deadline command is already in the composition |