Record Class StdDevModel.StdDevs

java.lang.Object
java.lang.Record
frc.spectrumLib.localization.StdDevModel.StdDevs
Record Components:
xyMeters - translation std-dev, metres
thetaRadians - heading std-dev, radians
tier - name of the confidence tier that chose these
Enclosing interface:
StdDevModel
public static record StdDevModel.StdDevs(double xyMeters, double thetaRadians, String tier) extends Record
Standard deviations handed to the pose estimator.

  • Constructor Summary

    Constructors
    Constructor
    Description
    StdDevs(double xyMeters, double thetaRadians, String tier)
    Creates an instance of a StdDevs record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    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.
    double
    thetaRadians()
    Returns the value of the thetaRadians record component.
    String
    tier()
    Returns the value of the tier record component.
    final String
    toString()
    Returns a string representation of this record class.
    double
    xyMeters()
    Returns the value of the xyMeters record component.

    Methods inherited from class Object

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

  • Constructor Details

    • StdDevs

      public StdDevs(double xyMeters, double thetaRadians, String tier)
      Creates an instance of a StdDevs record class.
      Parameters:
      xyMeters - the value for the xyMeters record component
      thetaRadians - the value for the thetaRadians record component
      tier - the value for the tier 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.

    • xyMeters

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

    • thetaRadians

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

    • tier

      public String tier()
      Returns the value of the tier record component.
      Returns:
      the value of the tier record component