Record Class Navx.MagneticField

java.lang.Object
java.lang.Record
com.studica.frc.Navx.MagneticField
Record Components:
x - X component
y - Y component
z - Z component
norm - field magnitude
Enclosing class:
Navx
public static record Navx.MagneticField(double x, double y, double z, double norm) extends Record
Magnetic field in microtesla.

  • Constructor Summary

    Constructors
    Constructor
    Description
    MagneticField(double x, double y, double z, double norm)
    Creates an instance of a MagneticField 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
    norm()
    Returns the value of the norm record component.
    final String
    toString()
    Returns a string representation of this record class.
    double
    x()
    Returns the value of the x record component.
    double
    y()
    Returns the value of the y record component.
    double
    z()
    Returns the value of the z record component.

    Methods inherited from class Object

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

  • Constructor Details

    • MagneticField

      public MagneticField(double x, double y, double z, double norm)
      Creates an instance of a MagneticField record class.
      Parameters:
      x - the value for the x record component
      y - the value for the y record component
      z - the value for the z record component
      norm - the value for the norm 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. All components in this record class 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.

    • x

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

    • y

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

    • z

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

    • norm

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