Public Member Functions | |
| ParallelDeadlineGroup (Command deadline, Command... commands) | |
| void | setDeadline (Command deadline) |
| 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< Subsystem > | getRequirements () |
| 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< Subsystem > | m_requirements = new HashSet<>() |
Detailed Description
A CommandGroup 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.
As a rule, CommandGroups require the union of the requirements of their component commands.
Constructor & Destructor Documentation
◆ ParallelDeadlineGroup()
| edu.wpi.first.wpilibj2.command.ParallelDeadlineGroup.ParallelDeadlineGroup | ( | Command | deadline, |
| Command... | commands | ||
| ) |
Creates a new ParallelDeadlineGroup. The given commands (including the deadline) will be executed simultaneously. The CommandGroup will finish when the deadline finishes, interrupting all other still-running commands. If the CommandGroup is interrupted, only the commands still running will be interrupted.
- Parameters
-
deadline the command that determines when the group ends commands the commands to be executed
Member Function Documentation
◆ addCommands()
| final void edu.wpi.first.wpilibj2.command.ParallelDeadlineGroup.addCommands | ( | Command... | commands | ) |
Adds the given commands to the command group.
- Parameters
-
commands The commands to add.
Reimplemented from edu.wpi.first.wpilibj2.command.CommandGroupBase.
◆ end()
| 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.
- Parameters
-
interrupted whether the command was interrupted/canceled
Implements edu.wpi.first.wpilibj2.command.Command.
◆ execute()
| void edu.wpi.first.wpilibj2.command.ParallelDeadlineGroup.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.ParallelDeadlineGroup.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.ParallelDeadlineGroup.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.
Implements edu.wpi.first.wpilibj2.command.Command.
◆ runsWhenDisabled()
| 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.
- Returns
- whether the command should run when the robot is disabled
Implements edu.wpi.first.wpilibj2.command.Command.
◆ setDeadline()
| 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.
- Parameters
-
deadline the command that determines when the group ends
The documentation for this class was generated from the following file:
- D:/SDASVN/2022/RaspberryPi/Source/edu/wpi/first/wpilibj2/command/ParallelDeadlineGroup.java
