Package frc.robot.lib.BLine

Record Class Path.WaypointConstraint

java.lang.Object
java.lang.Record
frc.robot.lib.BLine.Path.WaypointConstraint
Record Components:
maxVelocityMetersPerSec - Maximum translational velocity in meters per second
maxAccelerationMetersPerSec2 - Maximum translational acceleration in meters per second squared
maxVelocityDegPerSec - Maximum rotational velocity in degrees per second
maxAccelerationDegPerSec2 - Maximum rotational acceleration in degrees per second squared
All Implemented Interfaces:
Path.PathElementConstraint
Enclosing class:
Path
public static record Path.WaypointConstraint(double maxVelocityMetersPerSec, double maxAccelerationMetersPerSec2, double maxVelocityDegPerSec, double maxAccelerationDegPerSec2) extends Record implements Path.PathElementConstraint
Constraints for a Path.Waypoint, including both translation and rotation limits.

  • Constructor Details

    • WaypointConstraint

      public WaypointConstraint(double maxVelocityMetersPerSec, double maxAccelerationMetersPerSec2, double maxVelocityDegPerSec, double maxAccelerationDegPerSec2)
      Creates an instance of a WaypointConstraint record class.
      Parameters:
      maxVelocityMetersPerSec - the value for the maxVelocityMetersPerSec record component
      maxAccelerationMetersPerSec2 - the value for the maxAccelerationMetersPerSec2 record component
      maxVelocityDegPerSec - the value for the maxVelocityDegPerSec record component
      maxAccelerationDegPerSec2 - the value for the maxAccelerationDegPerSec2 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.

    • maxVelocityMetersPerSec

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

    • maxAccelerationMetersPerSec2

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

    • maxVelocityDegPerSec

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

    • maxAccelerationDegPerSec2

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