Package com.irurueta.navigation.inertial

Class BodyMagneticFluxDensity

java.lang.Object
com.irurueta.navigation.inertial.BodyMagneticFluxDensity
All Implemented Interfaces:
Serializable, Cloneable
public class BodyMagneticFluxDensity extends Object implements Serializable, Cloneable
Contains magnetic flux density resolved around body coordinates. Body frame axes are typically defined so that x is the forward axis, pointing in the usual direction of travel, z is the down axis, pointing in the usual direction of gravity, and y is the right axis, completing the orthogonal set.
See Also:

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    private double
    bx
    X component of magnetic flux density expressed in Teslas (T).
    private double
    by
    Y component of magnetic flux density expressed in Teslas (T).
    private double
    bz
    Z component of magnetic flux density expressed in Teslas (T).
    static final int
    COMPONENTS
    Number of components.
    private static final long
    serialVersionUID
    Serialization version.

  • Constructor Summary

    Constructors
    Constructor
    Description
    BodyMagneticFluxDensity()
    Constructor.
    BodyMagneticFluxDensity(double bx, double by, double bz)
    Constructor.
    BodyMagneticFluxDensity(BodyMagneticFluxDensity input)
    Constructor.
    BodyMagneticFluxDensity(MagneticFluxDensityTriad triad)
    Constructor.
    BodyMagneticFluxDensity(com.irurueta.units.MagneticFluxDensity bx, com.irurueta.units.MagneticFluxDensity by, com.irurueta.units.MagneticFluxDensity bz)
    Constructor.

  • Method Summary

    Modifier and Type
    Method
    Description
    double[]
    asArray()
    Gets magnetic flux density as an array.
    void
    asArray(double[] result)
    Gets magnetic flux density as an array.
    com.irurueta.algebra.Matrix
    asMatrix()
    Gets magnetic flux density as a column matrix.
    void
    asMatrix(com.irurueta.algebra.Matrix result)
    Gets magnetic flux density as a column matrix.
    protected Object
    clone()
    Makes a copy of this instance.
    private double
    convertMagneticFluxDensity(double value, com.irurueta.units.MagneticFluxDensityUnit unit)
    Converts magnetic flux density to Teslas.
    private double
    convertMagneticFluxDensity(com.irurueta.units.MagneticFluxDensity b)
    Converts magnetic flux density to Teslas.
    void
    copyFrom(BodyMagneticFluxDensity input)
    Copies data of provided instance into this instance.
    void
    copyTo(BodyMagneticFluxDensity output)
    Copies this instance data into provided instance.
    boolean
    equals(BodyMagneticFluxDensity other)
    Checks if provided instance has exactly the same contents as this instance.
    boolean
    equals(BodyMagneticFluxDensity other, double threshold)
    Checks if provided instance has contents similar to this instance up to provided threshold value.
    boolean
    equals(Object obj)
    Check if provided object is a BodyMagneticFluxDensity instance having exactly the same contents as this instance.
    double
    getBx()
    Gets x component of magnetic flux density expressed in Teslas (T).
    com.irurueta.units.MagneticFluxDensity
    getBxAsMagneticFluxDensity()
    Gets x component of magnetic flux density.
    void
    getBxAsMagneticFluxDensity(com.irurueta.units.MagneticFluxDensity result)
    Gets x component of magnetic flux density.
    double
    getBy()
    Gets y component of magnetic flux density expressed in Teslas (T).
    com.irurueta.units.MagneticFluxDensity
    getByAsMagneticFluxDensity()
    Gets y component of magnetic flux density.
    void
    getByAsMagneticFluxDensity(com.irurueta.units.MagneticFluxDensity result)
    Gets y component of magnetic flux density.
    double
    getBz()
    Gets z component of magnetic flux density expressed in Teslas (T).
    com.irurueta.units.MagneticFluxDensity
    getBzAsMagneticFluxDensity()
    Gets z component of magnetic flux density.
    void
    getBzAsMagneticFluxDensity(com.irurueta.units.MagneticFluxDensity result)
    Gets z component of magnetic flux density.
    MagneticFluxDensityTriad
    getCoordinatesAsTriad()
    Gets body coordinates of magnetic flux density as a triad.
    void
    getCoordinatesAsTriad(MagneticFluxDensityTriad result)
    Gets body coordinates of magnetic flux density as a triad.
    double
    getNorm()
    Gets magnetic flux density magnitude (e.g. norm) expressed in Teslas (T).
    com.irurueta.units.MagneticFluxDensity
    getNormAsMagneticFluxDensity()
    Gets magnetic flux density magnitude (e.g. norm).
    void
    getNormAsMagneticFluxDensity(com.irurueta.units.MagneticFluxDensity result)
    Gets magnetic flux density magnitude (e.g. norm).
    int
    hashCode()
    Computes and returns hash code for this instance.
    void
    setBx(double bx)
    Sets x component of magnetic flux density expressed in Teslas (T).
    void
    setBx(com.irurueta.units.MagneticFluxDensity bx)
    Sets x component of magnetic flux density.
    void
    setBy(double by)
    Sets y component of magnetic flux density expressed in Teslas (T).
    void
    setBy(com.irurueta.units.MagneticFluxDensity by)
    Sets y component of magnetic flux density.
    void
    setBz(double bz)
    Sets z component of magnetic flux density expressed in Teslas (T).
    void
    setBz(com.irurueta.units.MagneticFluxDensity bz)
    Sets z component of magnetic flux density.
    void
    setCoordinates(double bx, double by, double bz)
    Sets body coordinates of magnetic flux density expressed in Teslas (T).
    void
    setCoordinates(MagneticFluxDensityTriad triad)
    Sets body coordinates of magnetic flux density.
    void
    setCoordinates(com.irurueta.units.MagneticFluxDensity bx, com.irurueta.units.MagneticFluxDensity by, com.irurueta.units.MagneticFluxDensity bz)
    Sets body coordinates of magnetic flux density.

    Methods inherited from class java.lang.Object

    finalize, getClass, notify, notifyAll, toString, wait, wait, wait

  • Field Details

    • COMPONENTS

      public static final int COMPONENTS
      Number of components.
      See Also:

    • serialVersionUID

      private static final long serialVersionUID
      Serialization version. This is used to ensure compatibility of deserialization of permanently stored serialized instances.
      See Also:

    • bx

      private double bx
      X component of magnetic flux density expressed in Teslas (T).

    • by

      private double by
      Y component of magnetic flux density expressed in Teslas (T).

    • bz

      private double bz
      Z component of magnetic flux density expressed in Teslas (T).

  • Constructor Details

    • BodyMagneticFluxDensity

      public BodyMagneticFluxDensity()
      Constructor.

    • BodyMagneticFluxDensity

      public BodyMagneticFluxDensity(double bx, double by, double bz)
      Constructor.
      Parameters:
      bx - x component of magnetic flux density expressed in Teslas (T).
      by - y component of magnetic flux density expressed in Teslas (T).
      bz - z component of magnetic flux density expressed in Teslas (T).

    • BodyMagneticFluxDensity

      public BodyMagneticFluxDensity(com.irurueta.units.MagneticFluxDensity bx, com.irurueta.units.MagneticFluxDensity by, com.irurueta.units.MagneticFluxDensity bz)
      Constructor.
      Parameters:
      bx - x component of magnetic flux density.
      by - y component of magnetic flux density.
      bz - z component of magnetic flux density.

    • BodyMagneticFluxDensity

      public BodyMagneticFluxDensity(MagneticFluxDensityTriad triad)
      Constructor.
      Parameters:
      triad - triad containing magnetic flux density values.

    • BodyMagneticFluxDensity

      public BodyMagneticFluxDensity(BodyMagneticFluxDensity input)
      Constructor.
      Parameters:
      input - instance to copy data from.

  • Method Details

    • getBx

      public double getBx()
      Gets x component of magnetic flux density expressed in Teslas (T).
      Returns:
      x component of magnetic flux density.

    • setBx

      public void setBx(double bx)
      Sets x component of magnetic flux density expressed in Teslas (T).
      Parameters:
      bx - x component of magnetic flux density.

    • getBxAsMagneticFluxDensity

      public com.irurueta.units.MagneticFluxDensity getBxAsMagneticFluxDensity()
      Gets x component of magnetic flux density.
      Returns:
      x component of magnetic flux density.

    • getBxAsMagneticFluxDensity

      public void getBxAsMagneticFluxDensity(com.irurueta.units.MagneticFluxDensity result)
      Gets x component of magnetic flux density.
      Parameters:
      result - instance where result will be stored.

    • setBx

      public void setBx(com.irurueta.units.MagneticFluxDensity bx)
      Sets x component of magnetic flux density.
      Parameters:
      bx - x component of magnetic flux density.

    • getBy

      public double getBy()
      Gets y component of magnetic flux density expressed in Teslas (T).
      Returns:
      y component of magnetic flux density.

    • setBy

      public void setBy(double by)
      Sets y component of magnetic flux density expressed in Teslas (T).
      Parameters:
      by - y component of magnetic flux density.

    • getByAsMagneticFluxDensity

      public com.irurueta.units.MagneticFluxDensity getByAsMagneticFluxDensity()
      Gets y component of magnetic flux density.
      Returns:
      y component of magnetic flux density.

    • getByAsMagneticFluxDensity

      public void getByAsMagneticFluxDensity(com.irurueta.units.MagneticFluxDensity result)
      Gets y component of magnetic flux density.
      Parameters:
      result - instance where result will be stored.

    • setBy

      public void setBy(com.irurueta.units.MagneticFluxDensity by)
      Sets y component of magnetic flux density.
      Parameters:
      by - y component of magnetic flux density.

    • getBz

      public double getBz()
      Gets z component of magnetic flux density expressed in Teslas (T).
      Returns:
      z component of magnetic flux density.

    • setBz

      public void setBz(double bz)
      Sets z component of magnetic flux density expressed in Teslas (T).
      Parameters:
      bz - z component of magnetic flux density.

    • getBzAsMagneticFluxDensity

      public com.irurueta.units.MagneticFluxDensity getBzAsMagneticFluxDensity()
      Gets z component of magnetic flux density.
      Returns:
      z component of magnetic flux density.

    • getBzAsMagneticFluxDensity

      public void getBzAsMagneticFluxDensity(com.irurueta.units.MagneticFluxDensity result)
      Gets z component of magnetic flux density.
      Parameters:
      result - instance where result will be stored.

    • setBz

      public void setBz(com.irurueta.units.MagneticFluxDensity bz)
      Sets z component of magnetic flux density.
      Parameters:
      bz - z component of magnetic flux density.

    • setCoordinates

      public void setCoordinates(double bx, double by, double bz)
      Sets body coordinates of magnetic flux density expressed in Teslas (T).
      Parameters:
      bx - x component of magnetic flux density.
      by - y component of magnetic flux density.
      bz - z component of magnetic flux density.

    • setCoordinates

      public void setCoordinates(com.irurueta.units.MagneticFluxDensity bx, com.irurueta.units.MagneticFluxDensity by, com.irurueta.units.MagneticFluxDensity bz)
      Sets body coordinates of magnetic flux density.
      Parameters:
      bx - x component of magnetic flux density.
      by - y component of magnetic flux density.
      bz - z component of magnetic flux density.

    • getCoordinatesAsTriad

      public MagneticFluxDensityTriad getCoordinatesAsTriad()
      Gets body coordinates of magnetic flux density as a triad.
      Returns:
      body coordinates of magnetic flux density as a triad.

    • getCoordinatesAsTriad

      public void getCoordinatesAsTriad(MagneticFluxDensityTriad result)
      Gets body coordinates of magnetic flux density as a triad.
      Parameters:
      result - instance where result will be stored.

    • setCoordinates

      public void setCoordinates(MagneticFluxDensityTriad triad)
      Sets body coordinates of magnetic flux density.
      Parameters:
      triad - triad containing body magnetic flux density values.

    • getNorm

      public double getNorm()
      Gets magnetic flux density magnitude (e.g. norm) expressed in Teslas (T).
      Returns:
      magnetic flux density magnitude.

    • getNormAsMagneticFluxDensity

      public com.irurueta.units.MagneticFluxDensity getNormAsMagneticFluxDensity()
      Gets magnetic flux density magnitude (e.g. norm).
      Returns:
      magnetic flux density magnitude.

    • getNormAsMagneticFluxDensity

      public void getNormAsMagneticFluxDensity(com.irurueta.units.MagneticFluxDensity result)
      Gets magnetic flux density magnitude (e.g. norm).
      Parameters:
      result - instance where result will be stored.

    • copyTo

      public void copyTo(BodyMagneticFluxDensity output)
      Copies this instance data into provided instance.
      Parameters:
      output - destination instance where data will be copied to.

    • copyFrom

      public void copyFrom(BodyMagneticFluxDensity input)
      Copies data of provided instance into this instance.
      Parameters:
      input - instance to copy data from.

    • asArray

      public void asArray(double[] result)
      Gets magnetic flux density as an array.
      Parameters:
      result - array instance where magnetic flux density coordinates will be stored in x,y,z order.
      Throws:
      IllegalArgumentException - if provided array does not have length 3.

    • asArray

      public double[] asArray()
      Gets magnetic flux density as an array.
      Returns:
      array containing magnetic flux density coordinates in x,y,z order.

    • asMatrix

      public void asMatrix(com.irurueta.algebra.Matrix result)
      Gets magnetic flux density as a column matrix. If provided matrix does not have size 3x1, it will be resized.
      Parameters:
      result - matrix instance where magnetic flux density coordinates will be stored in x,y,z order.

    • asMatrix

      public com.irurueta.algebra.Matrix asMatrix()
      Gets magnetic flux density as a column matrix.
      Returns:
      a matrix containing magnetic flux density coordinates stored in x,y,z order.

    • hashCode

      public int hashCode()
      Computes and returns hash code for this instance. Hash codes are almost unique values that are useful for fast classification and storage of objects in collections.
      Overrides:
      hashCode in class Object
      Returns:
      Hash code.

    • equals

      public boolean equals(Object obj)
      Check if provided object is a BodyMagneticFluxDensity instance having exactly the same contents as this instance.
      Overrides:
      equals in class Object
      Parameters:
      obj - object to be compared.
      Returns:
      true if both objects are considered to be equal, false otherwise.

    • equals

      public boolean equals(BodyMagneticFluxDensity other)
      Checks if provided instance has exactly the same contents as this instance.
      Parameters:
      other - instance to be compared.
      Returns:
      true if both instances are considered to be equal, false otherwise.

    • equals

      public boolean equals(BodyMagneticFluxDensity other, double threshold)
      Checks if provided instance has contents similar to this instance up to provided threshold value.
      Parameters:
      other - instance to be compared.
      threshold - maximum allowed difference between gravity coordinates.
      Returns:
      true if both instances are considered to be equal (up to provided threshold), false otherwise.

    • clone

      protected Object clone() throws CloneNotSupportedException
      Makes a copy of this instance.
      Overrides:
      clone in class Object
      Returns:
      a copy of this instance.
      Throws:
      CloneNotSupportedException - if clone fails for same reason.

    • convertMagneticFluxDensity

      private double convertMagneticFluxDensity(com.irurueta.units.MagneticFluxDensity b)
      Converts magnetic flux density to Teslas.
      Parameters:
      b - magnetic flux density to be converted.
      Returns:
      converted value.

    • convertMagneticFluxDensity

      private double convertMagneticFluxDensity(double value, com.irurueta.units.MagneticFluxDensityUnit unit)
      Converts magnetic flux density to Teslas.
      Parameters:
      value - value to be converted.
      unit - unit of value to be converted
      Returns:
      converted value.