Record Class TimestampedPose

java.lang.Object
java.lang.Record
org.team1126.lib.math.geometry.TimestampedPose
All Implemented Interfaces:
Comparable<TimestampedPose>

public record TimestampedPose(edu.wpi.first.math.geometry.Pose2d pose, double timestamp) extends Record implements Comparable<TimestampedPose>
Contains a Pose2d alongside a timestamp in seconds.
  • Constructor Summary

    Constructors
    Constructor
    Description
    TimestampedPose(edu.wpi.first.math.geometry.Pose2d pose, double timestamp)
    Creates an instance of a TimestampedPose record class.
  • Method Summary

    Modifier and Type
    Method
    Description
    int
     
    final boolean
    Indicates whether some other object is "equal to" this one.
    final int
    Returns a hash code value for this object.
    edu.wpi.first.math.geometry.Pose2d
    Returns the value of the pose record component.
    double
    Returns the value of the timestamp record component.
    Returns a string representation of this record class.

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait
  • Constructor Details

    • TimestampedPose

      public TimestampedPose(edu.wpi.first.math.geometry.Pose2d pose, double timestamp)
      Creates an instance of a TimestampedPose record class.
      Parameters:
      pose - the value for the pose record component
      timestamp - the value for the timestamp record component
  • Method Details

    • compareTo

      public int compareTo(TimestampedPose o)
      Specified by:
      compareTo in interface Comparable<TimestampedPose>
    • toString

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

      public edu.wpi.first.math.geometry.Pose2d pose()
      Returns the value of the pose record component.
      Returns:
      the value of the pose record component
    • timestamp

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