Public Member Functions | |
| PerpetualCommand (Command command) | |
| void | initialize () |
| void | execute () |
| void | end (boolean interrupted) |
| 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 boolean | isFinished () |
| 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 () |
Protected Attributes | |
| final Command | m_command |
| Protected Attributes inherited from edu.wpi.first.wpilibj2.command.CommandBase | |
| Set< Subsystem > | m_requirements = new HashSet<>() |
Detailed Description
A command that runs another command in perpetuity, ignoring that command's end conditions. While this class does not extend CommandGroupBase, it is still considered a CommandGroup, as it allows one to compose another command within it; the command instances that are passed to it cannot be added to any other groups, or scheduled individually.
As a rule, CommandGroups require the union of the requirements of their component commands.
Constructor & Destructor Documentation
◆ PerpetualCommand()
| edu.wpi.first.wpilibj2.command.PerpetualCommand.PerpetualCommand | ( | Command | command | ) |
Creates a new PerpetualCommand. Will run another command in perpetuity, ignoring that command's end conditions, unless this command itself is interrupted.
- Parameters
-
command the command to run perpetually
Member Function Documentation
◆ end()
| void edu.wpi.first.wpilibj2.command.PerpetualCommand.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.PerpetualCommand.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.PerpetualCommand.initialize | ( | ) |
The initial subroutine of a command. Called once when the command is initially scheduled.
Implements edu.wpi.first.wpilibj2.command.Command.
◆ runsWhenDisabled()
| boolean edu.wpi.first.wpilibj2.command.PerpetualCommand.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.
The documentation for this class was generated from the following file:
- D:/SDASVN/2022/RaspberryPi/Source/edu/wpi/first/wpilibj2/command/PerpetualCommand.java
