Package com.pathplanner.lib.path

Record Class ConstraintsZone

java.lang.Object
java.lang.Record
com.pathplanner.lib.path.ConstraintsZone
Record Components:
minPosition - Starting waypoint relative position of the zone
maxPosition - End waypoint relative position of the zone
constraints - The PathConstraints to apply within the zone
public record ConstraintsZone(double minPosition, double maxPosition, PathConstraints constraints) extends Record
A zone on a path with different kinematic constraints

  • Constructor Details

    • ConstraintsZone

      public ConstraintsZone(double minPosition, double maxPosition, PathConstraints constraints)
      Creates an instance of a ConstraintsZone record class.
      Parameters:
      minPosition - the value for the minPosition record component
      maxPosition - the value for the maxPosition record component
      constraints - the value for the constraints 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.

    • minPosition

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

    • maxPosition

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

    • constraints

      public PathConstraints constraints()
      Returns the value of the constraints record component.
      Returns:
      the value of the constraints record component