Skip to main content

CommandGroup

The CommandGroup class represents a command that contains and manages other sub-commands. This is not generally used by the end user, but is instead a utility to provide common functionality for the SequentialCommandGroup and ParallelCommandGroup classes.

Root​

  • Extends: Command
  • Declaration: abstract class
  • Package: com.atomicrobotics.cflib

Variables​

commands​

  • Default value: mutableListOf()
  • Type: MutableList<Command>
  • Declaration: private

_isDone​

  • Default value: null
  • Type: Boolean
  • Declaration: override val

Operator Overrides​

plusAssign(command: Command)​

This function overrides the standard plusAssign command (+=) so users can add commands to the command group using myCommandGroup += MyCommand()

  • Declaration: operator fun
  • Parameters:
    • command:
  • Returns: Unit

Command.unaryPlus()​

This function overrides Command's unaryPlus function to allow users to create command groups using the following format:

commandGroup {
    +FirstCommand()
    +SecondCommand()
}
  • Declaration: operator fun
  • Parameters: none
  • Returns: Unit

Functions​

end(interrupted: Boolean)​

If the command group is ended forcefully, this function (which overrides Command.end(interrupted: Boolean)) will end all of the commands inside of the group.

  • Declaration: override fun
  • Parameters:
    • interrupted:
      • Type: Boolean
      • Default value: null
  • Returns: Unit

Definition in com.atomicrobotics.cflib/CommandGroup.kt