Class BodyKinematicsAndMagneticFluxDensity

java.lang.Object
com.irurueta.navigation.inertial.BodyKinematicsAndMagneticFluxDensity
All Implemented Interfaces:
Serializable, Cloneable
Direct Known Subclasses:
TimedBodyKinematicsAndMagneticFluxDensity

public class BodyKinematicsAndMagneticFluxDensity extends Object implements Serializable, Cloneable
Contains body kinematics describing the forces and angular rate applied to a body, along with the sensed magnetic flux density resolved around body coordinates.
See Also:
  • Field Details

    • serialVersionUID

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

      private BodyKinematics kinematics
      Body kinematics containing sensed specific force and angular rate.
    • magneticFluxDensity

      private BodyMagneticFluxDensity magneticFluxDensity
      Body magnetic flux density.
  • Constructor Details

    • BodyKinematicsAndMagneticFluxDensity

      public BodyKinematicsAndMagneticFluxDensity()
      Constructor.
    • BodyKinematicsAndMagneticFluxDensity

      public BodyKinematicsAndMagneticFluxDensity(BodyKinematics kinematics)
      Constructor.
      Parameters:
      kinematics - body kinematics containing sensed specific force and angular rate.
    • BodyKinematicsAndMagneticFluxDensity

      public BodyKinematicsAndMagneticFluxDensity(BodyMagneticFluxDensity magneticFluxDensity)
      Constructor.
      Parameters:
      magneticFluxDensity - body magnetic flux density.
    • BodyKinematicsAndMagneticFluxDensity

      public BodyKinematicsAndMagneticFluxDensity(BodyKinematics kinematics, BodyMagneticFluxDensity magneticFluxDensity)
      Constructor.
      Parameters:
      kinematics - body kinematics containing sensed specific force and angular rate.
      magneticFluxDensity - body magnetic flux density.
    • BodyKinematicsAndMagneticFluxDensity

      public BodyKinematicsAndMagneticFluxDensity(BodyKinematicsAndMagneticFluxDensity input)
      Constructor.
      Parameters:
      input - instance to copy data from.
  • Method Details

    • getKinematics

      public BodyKinematics getKinematics()
      Gets body kinematics containing sensed specific force and angular rate.
      Returns:
      body kinematics containing sensed specific force and angular rate.
    • setKinematics

      public void setKinematics(BodyKinematics kinematics)
      Sets body kinematics containing sensed specific force and angular rate.
      Parameters:
      kinematics - body kinematics containing sensed specific force and angular rate.
    • getMagneticFluxDensity

      public BodyMagneticFluxDensity getMagneticFluxDensity()
      Gets body magnetic flux density.
      Returns:
      body magnetic flux density.
    • setMagneticFluxDensity

      public void setMagneticFluxDensity(BodyMagneticFluxDensity magneticFluxDensity)
      Sets body magnetic flux density.
      Parameters:
      magneticFluxDensity - body magnetic flux density.
    • copyFrom

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

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

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

      public boolean equals(BodyKinematicsAndMagneticFluxDensity 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(BodyKinematicsAndMagneticFluxDensity 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 contents.
      Returns:
      true if both instances are considered to be equal (up to provided threshold), false otherwise.
    • equals

      public boolean equals(Object obj)
      Checks if provided object is a BodyKinematicsAndMagneticFluxDensity 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.
    • 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 some reason.