Robot Core Documentation
Loading...
Searching...
No Matches
edu.wpi.first.wpilibj2.command.WaitUntilCommand Class Reference
Inheritance diagram for edu.wpi.first.wpilibj2.command.WaitUntilCommand:
edu.wpi.first.wpilibj2.command.Command edu.wpi.first.util.sendable.Sendable

Public Member Functions

 WaitUntilCommand (BooleanSupplier condition)
 
 WaitUntilCommand (double time)
 
boolean isFinished ()
 
boolean runsWhenDisabled ()
 
- Public Member Functions inherited from edu.wpi.first.wpilibj2.command.Command
void initialize ()
 
void execute ()
 
void end (boolean interrupted)
 
Set< SubsystemgetRequirements ()
 
final void addRequirements (Subsystem... requirements)
 
String getName ()
 
void setName (String name)
 
String getSubsystem ()
 
void setSubsystem (String subsystem)
 
ParallelRaceGroup withTimeout (double seconds)
 
ParallelRaceGroup until (BooleanSupplier condition)
 
ParallelRaceGroup onlyWhile (BooleanSupplier condition)
 
SequentialCommandGroup beforeStarting (Runnable toRun, Subsystem... requirements)
 
SequentialCommandGroup beforeStarting (Command before)
 
SequentialCommandGroup andThen (Runnable toRun, Subsystem... requirements)
 
SequentialCommandGroup andThen (Command... next)
 
ParallelDeadlineGroup deadlineWith (Command... parallel)
 
ParallelCommandGroup alongWith (Command... parallel)
 
ParallelRaceGroup raceWith (Command... parallel)
 
RepeatCommand repeatedly ()
 
ProxyCommand asProxy ()
 
ConditionalCommand unless (BooleanSupplier condition)
 
ConditionalCommand onlyIf (BooleanSupplier condition)
 
WrapperCommand ignoringDisable (boolean doesRunWhenDisabled)
 
WrapperCommand withInterruptBehavior (InterruptionBehavior interruptBehavior)
 
WrapperCommand finallyDo (BooleanConsumer end)
 
WrapperCommand finallyDo (Runnable end)
 
WrapperCommand handleInterrupt (Runnable handler)
 
void schedule ()
 
void cancel ()
 
boolean isScheduled ()
 
boolean hasRequirement (Subsystem requirement)
 
InterruptionBehavior getInterruptionBehavior ()
 
WrapperCommand withName (String name)
 
void initSendable (SendableBuilder builder)
 
- Public Member Functions inherited from edu.wpi.first.util.sendable.Sendable

Additional Inherited Members

- Protected Member Functions inherited from edu.wpi.first.wpilibj2.command.Command
 Command ()
 
- Protected Attributes inherited from edu.wpi.first.wpilibj2.command.Command
Set< Subsystemm_requirements = new HashSet<>()
 

Detailed Description

A command that does nothing but ends after a specified match time or condition. Useful for CommandGroups.

This class is provided by the NewCommands VendorDep

Constructor & Destructor Documentation

◆ WaitUntilCommand() [1/2]

edu.wpi.first.wpilibj2.command.WaitUntilCommand.WaitUntilCommand ( BooleanSupplier condition)

Creates a new WaitUntilCommand that ends after a given condition becomes true.

Parameters
conditionthe condition to determine when to end

◆ WaitUntilCommand() [2/2]

edu.wpi.first.wpilibj2.command.WaitUntilCommand.WaitUntilCommand ( double time)

Creates a new WaitUntilCommand that ends after a given match time.

NOTE: The match timer used for this command is UNOFFICIAL. Using this command does NOT guarantee that the time at which the action is performed will be judged to be legal by the referees. When in doubt, add a safety factor or time the action manually.

Parameters
timethe match time after which to end, in seconds

Member Function Documentation

◆ isFinished()

boolean edu.wpi.first.wpilibj2.command.WaitUntilCommand.isFinished ( )

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.

Reimplemented from edu.wpi.first.wpilibj2.command.Command.

◆ runsWhenDisabled()

boolean edu.wpi.first.wpilibj2.command.WaitUntilCommand.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

Reimplemented from edu.wpi.first.wpilibj2.command.Command.


The documentation for this class was generated from the following file: