Package gg.questnav.questnav

Record Class PoseFrame

java.lang.Object
java.lang.Record
gg.questnav.questnav.PoseFrame
Record Components:
questPose - The current pose of the Quest on the field. This will only return the field-relative pose if QuestNav.setPose(Pose2d) has been called at least once.
dataTimestamp - The NT timestamp of when the last frame data was sent. This is the value which should be used with a pose estimator.
appTimestamp - The Quest app's uptime timestamp. For integration with a pose estimator, use the timestamp from dataTimestamp() instead!
frameCount - The current frame count.
public record PoseFrame(edu.wpi.first.math.geometry.Pose2d questPose, double dataTimestamp, double appTimestamp, int frameCount) extends Record
A frame of data from the Quest.

  • Constructor Summary

    Constructors
    Constructor
    Description
    PoseFrame(edu.wpi.first.math.geometry.Pose2d questPose, double dataTimestamp, double appTimestamp, int frameCount)
    Creates an instance of a PoseFrame record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    double
    appTimestamp()
    Returns the value of the appTimestamp record component.
    double
    dataTimestamp()
    Returns the value of the dataTimestamp record component.
    final boolean
    equals(Object o)
    Indicates whether some other object is "equal to" this one.
    int
    frameCount()
    Returns the value of the frameCount record component.
    final int
    hashCode()
    Returns a hash code value for this object.
    edu.wpi.first.math.geometry.Pose2d
    questPose()
    Returns the value of the questPose record component.
    final String
    toString()
    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

    • PoseFrame

      public PoseFrame(edu.wpi.first.math.geometry.Pose2d questPose, double dataTimestamp, double appTimestamp, int frameCount)
      Creates an instance of a PoseFrame record class.
      Parameters:
      questPose - the value for the questPose record component
      dataTimestamp - the value for the dataTimestamp record component
      appTimestamp - the value for the appTimestamp record component
      frameCount - the value for the frameCount 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.

    • questPose

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

    • dataTimestamp

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

    • appTimestamp

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

    • frameCount

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