Package com.pathplanner.lib.path

Record Class EventMarker

java.lang.Object
java.lang.Record
com.pathplanner.lib.path.EventMarker
Record Components:
triggerName - The name of the trigger this event marker will control
position - The waypoint relative position of the marker
endPosition - The end waypoint relative position of the event's zone. A value of -1.0 indicates that this event is not zoned.
command - The command that should be run at this marker. Can be null to not run a command.
public record EventMarker(String triggerName, double position, double endPosition, Command command) extends Record
Position along the path that will trigger a command when reached

  • Constructor Details

    • EventMarker

      public EventMarker(String triggerName, double position, Command command)
      Create a new event marker
      Parameters:
      triggerName - The name of the trigger this event marker will control
      position - The waypoint relative position of the marker
      command - The command that should be triggered at this marker

    • EventMarker

      public EventMarker(String triggerName, double position, double endPosition)
      Create a new event marker
      Parameters:
      triggerName - The name of the trigger this event marker will control
      position - The waypoint relative position of the marker
      endPosition - The end waypoint relative position of the event's zone. A value of -1.0 indicates that this event is not zoned.

    • EventMarker

      public EventMarker(String triggerName, double position)
      Create a new event marker
      Parameters:
      triggerName - The name of the trigger this event marker will control
      position - The waypoint relative position of the marker

    • EventMarker

      public EventMarker(String triggerName, double position, double endPosition, Command command)
      Creates an instance of a EventMarker record class.
      Parameters:
      triggerName - the value for the triggerName record component
      position - the value for the position record component
      endPosition - the value for the endPosition record component
      command - the value for the command 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 '=='.
      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.

    • triggerName

      public String triggerName()
      Returns the value of the triggerName record component.
      Returns:
      the value of the triggerName record component

    • position

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

    • endPosition

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

    • command

      public Command command()
      Returns the value of the command record component.
      Returns:
      the value of the command record component