Package edu.wpi.first.wpilibj2.command
Class SelectCommand
- java.lang.Object
-
- edu.wpi.first.wpilibj2.command.CommandBase
-
- edu.wpi.first.wpilibj2.command.SelectCommand
-
public class SelectCommand extends CommandBase
Runs one of a selection of commands, either using a selector and a key to command mapping, or a supplier that returns the command directly at runtime. Does not actually schedule the selected command - rather, the command is run through this command; this ensures that the command will behave as expected if used as part of a CommandGroup. Requires the requirements of all included commands, again to ensure proper functioning when used in a CommandGroup. If this is undesired, consider usingScheduleCommand.As this command contains multiple component commands within it, it is technically a command group; the command instances that are passed to it cannot be added to any other groups, or scheduled individually.
As a rule, CommandGroups require the union of the requirements of their component commands.
-
-
Field Summary
-
Fields inherited from class edu.wpi.first.wpilibj2.command.CommandBase
m_requirements
-
-
Constructor Summary
Constructors Constructor Description SelectCommand(Supplier<Command> toRun)Creates a new selectcommand.SelectCommand(Map<Object,Command> commands, Supplier<Object> selector)Creates a new selectcommand.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description voidend(boolean interrupted)The action to take when the command ends.voidexecute()The main body of a command.voidinitialize()The initial subroutine of a command.booleanisFinished()Whether the command has finished.booleanrunsWhenDisabled()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, initSendable, 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, cancel, deadlineWith, hasRequirement, isScheduled, perpetually, raceWith, schedule, schedule, withInterrupt, withTimeout
-
-
-
-
Method Detail
-
initialize
public void initialize()
Description copied from interface:CommandThe initial subroutine of a command. Called once when the command is initially scheduled.
-
execute
public void execute()
Description copied from interface:CommandThe main body of a command. Called repeatedly while the command is scheduled.
-
end
public void end(boolean interrupted)
Description copied from interface:CommandThe 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:CommandWhether 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:CommandWhether 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
-
-