public class WaitCommand extends Command
WaitCommand
will wait for a certain amount of time before finishing.
It is useful if you want a CommandGroup
to pause for a moment.CommandGroup
Constructor and Description |
---|
WaitCommand(double timeout)
Instantiates a
WaitCommand with the given timeout. |
WaitCommand(String name,
double timeout)
Instantiates a
WaitCommand with the given timeout. |
Modifier and Type | Method and Description |
---|---|
protected void |
end()
Called when the command ended peacefully.
|
protected void |
execute()
The execute method is called repeatedly until this Command either finishes
or is canceled.
|
protected void |
initialize()
The initialize method is called the first time this Command is run after
being started.
|
protected void |
interrupted()
Called when the command ends because somebody called
cancel()
or another command shared the same requirements as this one, and booted
it out. |
protected boolean |
isFinished()
Returns whether this command is finished.
|
cancel, doesRequire, getGroup, getName, getSmartDashboardType, getTable, initTable, isCanceled, isInterruptible, isRunning, isTimedOut, requires, setInterruptible, setRunWhenDisabled, setTimeout, start, timeSinceInitialized, toString, willRunWhenDisabled
public WaitCommand(double timeout)
WaitCommand
with the given timeout.timeout
- the time the command takes to runpublic WaitCommand(String name, double timeout)
WaitCommand
with the given timeout.name
- the name of the commandtimeout
- the time the command takes to runprotected void initialize()
Command
initialize
in class Command
protected void execute()
Command
protected boolean isFinished()
Command
end()
will be called.
It may be useful for a team to reference the isTimedOut()
method
for time-sensitive commands.
isFinished
in class Command
isTimedOut()
protected void end()
Command
protected void interrupted()
Command
cancel()
or another command shared the same requirements as this one, and booted
it out.
This is where you may want to wrap up loose ends, like shutting off a motor that was being used in the command.
Generally, it is useful to simply call the end()
method
within this method
interrupted
in class Command
Copyright © 2015. All rights reserved.