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:

Sendable, 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.

This class is provided by the NewCommands VendorDep

Nested Class Summary

Nested classes/interfaces inherited from interface edu.wpi.first.wpilibj2.command.Command

Command.InterruptionBehavior

Field Summary

Fields

Modifier and Type	Field	Description
protected Timer	m_timer

Fields inherited from class edu.wpi.first.wpilibj2.command.CommandBase

m_requirements

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.
void	initSendable(SendableBuilder builder)	Initializes this sendable.
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, getName, getRequirements, getSubsystem, setName, setSubsystem

Methods inherited from class java.lang.Object

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

Methods inherited from interface edu.wpi.first.wpilibj2.command.Command

alongWith, andThen, andThen, asProxy, beforeStarting, beforeStarting, cancel, deadlineWith, execute, finallyDo, getInterruptionBehavior, handleInterrupt, hasRequirement, ignoringDisable, isScheduled, perpetually, raceWith, repeatedly, schedule, unless, until, withInterrupt, withInterruptBehavior, withName, withTimeout

Field Details

m_timer

protected Timer m_timer

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.

Do not schedule commands here that share requirements with this command. Use Command.andThen(Command...) instead.

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

initSendable

public void initSendable(SendableBuilder builder)

Description copied from class: CommandBase

Initializes this sendable. Useful for allowing implementations to easily extend SendableBase.

Specified by:

initSendable in interface Sendable

Overrides:

initSendable in class CommandBase

Parameters:

builder - the builder used to construct this sendable