Package com.pathplanner.lib.path

Record Class IdealStartingState

java.lang.Object
java.lang.Record
com.pathplanner.lib.path.IdealStartingState
Record Components:
velocityMPS - The ideal starting velocity (M/S)
rotation - The ideal starting rotation
public record IdealStartingState(double velocityMPS, Rotation2d rotation) extends Record
Describes the ideal starting state of the robot when finishing a path

  • Constructor Summary

    Constructors
    Constructor
    Description
    IdealStartingState(double velocityMPS, Rotation2d rotation)
    Creates an instance of a IdealStartingState record class.
    IdealStartingState(edu.wpi.first.units.measure.LinearVelocity velocity, Rotation2d rotation)
    Describes the ideal starting state of the robot when finishing a path

  • Method Summary

    Modifier and Type
    Method
    Description
    final boolean
    equals(Object o)
    Indicates whether some other object is "equal to" this one.
    IdealStartingState
    flip()
    Flip the ideal starting state for the other side of the field, maintaining a blue alliance origin
    final int
    hashCode()
    Returns a hash code value for this object.
    Rotation2d
    rotation()
    Returns the value of the rotation record component.
    final String
    toString()
    Returns a string representation of this record class.
    edu.wpi.first.units.measure.LinearVelocity
    velocity()
    Get the starting linear velocity
    double
    velocityMPS()
    Returns the value of the velocityMPS record component.

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • IdealStartingState

      public IdealStartingState(edu.wpi.first.units.measure.LinearVelocity velocity, Rotation2d rotation)
      Describes the ideal starting state of the robot when finishing a path
      Parameters:
      velocity - The ideal starting velocity
      rotation - The ideal starting rotation

    • IdealStartingState

      public IdealStartingState(double velocityMPS, Rotation2d rotation)
      Creates an instance of a IdealStartingState record class.
      Parameters:
      velocityMPS - the value for the velocityMPS record component
      rotation - the value for the rotation record component

  • Method Details

    • flip

      public IdealStartingState flip()
      Flip the ideal starting state for the other side of the field, maintaining a blue alliance origin
      Returns:
      The flipped starting state

    • velocity

      public edu.wpi.first.units.measure.LinearVelocity velocity()
      Get the starting linear velocity
      Returns:
      Starting linear velocity

    • 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.

    • velocityMPS

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

    • rotation

      public Rotation2d rotation()
      Returns the value of the rotation record component.
      Returns:
      the value of the rotation record component