edu.wpi.first.wpilibj.command

Class TimedCommand

java.lang.Object

edu.wpi.first.wpilibj.command.Command

edu.wpi.first.wpilibj.command.TimedCommand

All Implemented Interfaces:

NamedSendable, Sendable

Direct Known Subclasses:

WaitCommand

public class TimedCommand
extends Command

A TimedCommand will wait for a timeout before finishing. TimedCommand is used to execute a command for a given amount of time.

Constructor Summary

Constructors

Constructor and Description
TimedCommand(double timeout)
TimedCommand(java.lang.String name, double timeout)

Method Summary

Modifier and Type	Method and Description
protected boolean	isFinished() Returns whether this command is finished.

Methods inherited from class edu.wpi.first.wpilibj.command.Command

cancel, clearRequirements, doesRequire, end, execute, getGroup, getName, getSmartDashboardType, getTable, initialize, initTable, interrupted, isCanceled, isInterruptible, isRunning, isTimedOut, requires, setInterruptible, setRunWhenDisabled, setTimeout, start, timeSinceInitialized, toString, willRunWhenDisabled

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

TimedCommand

public TimedCommand(java.lang.String name,
                    double timeout)

TimedCommand

public TimedCommand(double timeout)

Method Detail

isFinished

protected boolean isFinished()

Description copied from class: Command

Returns whether this command is finished. If it is, then the command will be removed and end() will be called.

It may be useful for a team to reference the isTimedOut() method for time-sensitive commands.

Returning false will result in the command never ending automatically. It may still be cancelled manually or interrupted by another command. Returning true will result in the command executing once and finishing immediately. We recommend using InstantCommand for this.

Specified by:

isFinished in class Command

Returns:

whether this command is finished.

See Also:

isTimedOut()