Package edu.wpi.first.wpilibj2.command
Class WaitCommand
java.lang.Object
edu.wpi.first.wpilibj2.command.CommandBase
edu.wpi.first.wpilibj2.command.WaitCommand
- All Implemented Interfaces:
Command
public class WaitCommand extends CommandBase
A command that does nothing but takes a specified amount of time to finish. Useful for
CommandGroups. Can also be subclassed to make a command with an internal timer.
-
Constructor Summary
Constructors Constructor Description WaitCommand(double seconds)
Creates a new WaitCommand. -
Method Summary
Modifier and Type Method Description void
end(boolean interrupted)
The action to take when the command ends.void
initialize()
The initial subroutine of a command.boolean
isFinished()
Whether the command has finished.boolean
runsWhenDisabled()
Whether the given command should run when the robot is disabled.Methods inherited from class edu.wpi.first.wpilibj2.command.CommandBase
addRequirements, getRequirements
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface edu.wpi.first.wpilibj2.command.Command
alongWith, andThen, asProxy, beforeStarting, cancel, deadlineWith, execute, getName, hasRequirement, interruptOn, isScheduled, perpetually, raceWith, schedule, schedule, whenFinished, withTimeout
-
Constructor Details
-
WaitCommand
public WaitCommand(double seconds)Creates a new WaitCommand. This command will do nothing, and end after the specified duration.- Parameters:
seconds
- the time to wait, in seconds
-
-
Method Details
-
initialize
public void initialize()Description copied from interface:Command
The initial subroutine of a command. Called once when the command is initially scheduled. -
end
public void end(boolean interrupted)Description copied from interface:Command
The action to take when the command ends. Called when either the command finishes normally, or when it interrupted/canceled.- Parameters:
interrupted
- whether the command was interrupted/canceled
-
isFinished
public boolean isFinished()Description copied from interface:Command
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.
-
runsWhenDisabled
public boolean runsWhenDisabled()Description copied from interface:Command
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
-