Record Class FsmContext<ContextT>

java.lang.Object
java.lang.Record
xbot.common.logic.FsmContext<ContextT>
Type Parameters:
ContextT - The type of the payload.
Record Components:
payload - The caller-supplied object carrying whatever inputs/outputs the state machine needs. Typically the subsystem or command that owns the FiniteStateMachine.
executionsInState - The number of times FiniteStateMachine.execute(Object) has run against the current state, including this call. Reset to zero whenever the state changes.
timeInState - The number of seconds since the current state was entered, per XTimer. Reset to zero whenever the state changes.

public record FsmContext<ContextT>(ContextT payload, long executionsInState, double timeInState) extends Record
The information passed in to every FsmState hook and to every FiniteStateMachine hook. A fresh FsmContext is built for every hook invocation during a single FiniteStateMachine.execute(Object) cycle, so executionsInState/timeInState always reflect the state that is actually running at the moment the hook is called.
  • Constructor Details

    • FsmContext

      public FsmContext(ContextT payload, long executionsInState, double timeInState)
      Creates an instance of a FsmContext record class.
      Parameters:
      payload - the value for the payload record component
      executionsInState - the value for the executionsInState record component
      timeInState - the value for the timeInState record component
  • Method Details

    • toString

      public final String toString()
      Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.
      Specified by:
      toString in class Record
      Returns:
      a string representation of this object
    • hashCode

      public final int hashCode()
      Returns a hash code value for this object. The value is derived from the hash code of each of the record components.
      Specified by:
      hashCode in class Record
      Returns:
      a hash code value for this object
    • equals

      public final boolean equals(Object o)
      Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with the compare method from their corresponding wrapper classes.
      Specified by:
      equals in class Record
      Parameters:
      o - the object with which to compare
      Returns:
      true if this object is the same as the o argument; false otherwise.
    • payload

      public ContextT payload()
      Returns the value of the payload record component.
      Returns:
      the value of the payload record component
    • executionsInState

      public long executionsInState()
      Returns the value of the executionsInState record component.
      Returns:
      the value of the executionsInState record component
    • timeInState

      public double timeInState()
      Returns the value of the timeInState record component.
      Returns:
      the value of the timeInState record component