Package crackers.kobots.parts.movement

Class Action

  • All Implemented Interfaces:
    
public final class Action

    An Action is a sequence of Movements to perform. Each Movement is associated with a Actuator and is to be performed in sequence. The Action is considered complete when all Movements have been performed.

    Actions are not re-runnable.

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description

    • Field Summary

      Fields 
      Modifier and Type Field Description

    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description

    • Method Summary

      Modifier and Type Method Description
      final Boolean step(Duration stepExecutionTime) Executes each movement in the Action and returns true if all movements were successful.

      • Methods inherited from class java.lang.Object

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

    • Method Detail

      • step

         final Boolean step(Duration stepExecutionTime)

        Executes each movement in the Action and returns true if all movements were successful. If false, this indicates that the action is not complete and should execute step again.

        If a stepExecutionTime is provided, then each movement will pause until the next is executed (the value is roughly distributed between steps). This is useful for ensuring that the Action is not executed too quickly.

        This is a blocking call: the assumption is that it is only used by a single, controlling thread. There is currently no means to interrupt a single step, aside from each movement's stopCheck.