Package com.uniforge.origin.command

Class SelectCommand<K>

java.lang.Object
com.uniforge.origin.command.Command
com.uniforge.origin.command.SelectCommand<K>
Type Parameters:
K - The type of key used to select the command
All Implemented Interfaces:
edu.wpi.first.util.sendable.Sendable
public class SelectCommand<K> extends Command
A command composition that runs one of a selection of commands using a selector and a key to command mapping.

The rules for command compositions apply: command instances that are passed to it cannot be added to any other composition or scheduled individually, and the composition requires all subsystems its components require.

This class is provided by the NewCommands VendorDep

  • Constructor Details

    • SelectCommand

      public SelectCommand(Map<K,Command> commands, Supplier<? extends K> selector)
      Creates a new SelectCommand.
      Parameters:
      commands - the map of commands to choose from
      selector - the selector to determine which command to run

  • Method Details

    • initialize

      public void initialize()
      Description copied from class: Command
      The initial subroutine of a command. Called once when the command is initially scheduled.
      Overrides:
      initialize in class Command

    • execute

      public void execute()
      Description copied from class: Command
      The main body of a command. Called repeatedly while the command is scheduled.
      Overrides:
      execute in class Command

    • end

      public void end(boolean interrupted)
      Description copied from class: 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.

      Overrides:
      end in class Command
      Parameters:
      interrupted - whether the command was interrupted/canceled

    • isFinished

      public boolean isFinished()
      Description copied from class: Command
      Whether the command has finished. Once a command finishes, the scheduler will call its end() method and un-schedule it.
      Overrides:
      isFinished in class Command
      Returns:
      whether the command has finished.

    • runsWhenDisabled

      public boolean runsWhenDisabled()
      Description copied from class: Command
      Whether the given command should run when the robot is disabled. Override to return true if the command should run when disabled.
      Overrides:
      runsWhenDisabled in class Command
      Returns:
      whether the command should run when the robot is disabled

    • getInterruptionBehavior

      public Command.InterruptionBehavior getInterruptionBehavior()
      Description copied from class: Command
      How the command behaves when another command with a shared requirement is scheduled.
      Overrides:
      getInterruptionBehavior in class Command
      Returns:
      a variant of Command.InterruptionBehavior, defaulting to kCancelSelf.

    • initSendable

      public void initSendable(edu.wpi.first.util.sendable.SendableBuilder builder)
      Specified by:
      initSendable in interface edu.wpi.first.util.sendable.Sendable
      Overrides:
      initSendable in class Command