Record Class VisionIO.PoseObservation

java.lang.Object
java.lang.Record
com.stuypulse.robot.subsystems.vision.VisionIO.PoseObservation
Enclosing interface:
VisionIO
public static record VisionIO.PoseObservation(double timestamp, org.wpilib.math.geometry.Pose3d pose, double ambiguity, int tagCount, double averageTagDistance, VisionIO.PoseObservationType type) extends Record
Represents a robot pose sample used for pose estimation.

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    private final double
    ambiguity
    The field for the ambiguity record component.
    private final double
    averageTagDistance
    The field for the averageTagDistance record component.
    private final org.wpilib.math.geometry.Pose3d
    pose
    The field for the pose record component.
    private final int
    tagCount
    The field for the tagCount record component.
    private final double
    timestamp
    The field for the timestamp record component.
    private final VisionIO.PoseObservationType
    type
    The field for the type record component.

  • Constructor Summary

    Constructors
    Constructor
    Description
    PoseObservation(double timestamp, org.wpilib.math.geometry.Pose3d pose, double ambiguity, int tagCount, double averageTagDistance, VisionIO.PoseObservationType type)
    Creates an instance of a PoseObservation record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    double
    ambiguity()
    Returns the value of the ambiguity record component.
    double
    averageTagDistance()
    Returns the value of the averageTagDistance 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.
    org.wpilib.math.geometry.Pose3d
    pose()
    Returns the value of the pose record component.
    int
    tagCount()
    Returns the value of the tagCount record component.
    double
    timestamp()
    Returns the value of the timestamp record component.
    final String
    toString()
    Returns a string representation of this record class.
    VisionIO.PoseObservationType
    type()
    Returns the value of the type record component.

    Methods inherited from class Object

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

  • Field Details

    • timestamp

      private final double timestamp
      The field for the timestamp record component.

    • pose

      private final org.wpilib.math.geometry.Pose3d pose
      The field for the pose record component.

    • ambiguity

      private final double ambiguity
      The field for the ambiguity record component.

    • tagCount

      private final int tagCount
      The field for the tagCount record component.

    • averageTagDistance

      private final double averageTagDistance
      The field for the averageTagDistance record component.

    • type

      private final VisionIO.PoseObservationType type
      The field for the type record component.

  • Constructor Details

    • PoseObservation

      public PoseObservation(double timestamp, org.wpilib.math.geometry.Pose3d pose, double ambiguity, int tagCount, double averageTagDistance, VisionIO.PoseObservationType type)
      Creates an instance of a PoseObservation record class.
      Parameters:
      timestamp - the value for the timestamp record component
      pose - the value for the pose record component
      ambiguity - the value for the ambiguity record component
      tagCount - the value for the tagCount record component
      averageTagDistance - the value for the averageTagDistance record component
      type - the value for the type 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 the compare method from their corresponding wrapper classes.
      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.

    • timestamp

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

    • pose

      public org.wpilib.math.geometry.Pose3d pose()
      Returns the value of the pose record component.
      Returns:
      the value of the pose record component

    • ambiguity

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

    • tagCount

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

    • averageTagDistance

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

    • type

      public VisionIO.PoseObservationType type()
      Returns the value of the type record component.
      Returns:
      the value of the type record component