Package frc.robot.lib.BLine

Record Class Path.RangedConstraint

java.lang.Object
java.lang.Record
frc.robot.lib.BLine.Path.RangedConstraint
Record Components:
value - The constraint value (velocity or acceleration)
startOrdinal - The first element ordinal this constraint applies to
endOrdinal - The last element ordinal this constraint applies to
Enclosing class:
Path
public static record Path.RangedConstraint(double value, int startOrdinal, int endOrdinal) extends Record
A constraint value that applies to a range of path elements.

Ranged constraints allow different velocity/acceleration limits for different sections of a path. The constraint applies to elements with ordinals between startOrdinal and endOrdinal (inclusive).

  • Constructor Summary

    Constructors
    Constructor
    Description
    RangedConstraint(double value, int startOrdinal, int endOrdinal)
    Creates an instance of a RangedConstraint record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    int
    endOrdinal()
    Returns the value of the endOrdinal record component.
    final boolean
    equals(Object o)
    Indicates whether some other object is "equal to" this one.
    final int
    hashCode()
    Returns a hash code value for this object.
    int
    startOrdinal()
    Returns the value of the startOrdinal record component.
    final String
    toString()
    Returns a string representation of this record class.
    double
    value()
    Returns the value of the value record component.

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

  • Constructor Details

    • RangedConstraint

      public RangedConstraint(double value, int startOrdinal, int endOrdinal)
      Creates an instance of a RangedConstraint record class.
      Parameters:
      value - the value for the value record component
      startOrdinal - the value for the startOrdinal record component
      endOrdinal - the value for the endOrdinal 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. All components in this record class 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.

    • value

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

    • startOrdinal

      public int startOrdinal()
      Returns the value of the startOrdinal record component.
      Returns:
      the value of the startOrdinal record component

    • endOrdinal

      public int endOrdinal()
      Returns the value of the endOrdinal record component.
      Returns:
      the value of the endOrdinal record component