Class NEDVelocity

java.lang.Object
com.irurueta.navigation.frames.NEDVelocity
All Implemented Interfaces:
Serializable, Cloneable

public class NEDVelocity extends Object implements Serializable, Cloneable
Contains body velocity with respect Earth, resolved about north, east and down an expressed in meters per second (m/s).
See Also:
  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    private double
    Coordinate of velocity of body frame expressed in meters per second (m/s) with respect ECEF frame and resolved along Down axis.
    private double
    Coordinate of velocity of body frame expressed in meters per second (m/s) with respect ECEF frame and resolved along East axis.
    private double
    Coordinate of velocity of body frame expressed in meters per second (m/s) with respect ECEF frame and resolved along North axis.
  • Constructor Summary

    Constructors
    Constructor
    Description
    Constructor.
    NEDVelocity(double vn, double ve, double vd)
    Constructor.
    Constructor.
    NEDVelocity(com.irurueta.units.Speed vn, com.irurueta.units.Speed ve, com.irurueta.units.Speed vd)
    Constructor.
  • Method Summary

    Modifier and Type
    Method
    Description
    protected Object
    Makes a copy of this instance.
    void
    Copies data of provided instance into this instance.
    void
    Copies this instance data into provided instance.
    boolean
    Checks if provided instance has exactly the same contents as this instance.
    boolean
    equals(NEDVelocity other, double threshold)
    Checks if provided instance has contents similar to this instance up to provided threshold value.
    boolean
    Checks if provided object is a BodyVelocity having exactly the same contents as this instance.
    double
    Gets norm of velocity expressed in meters per second (m/s), which represents the speed of the body.
    com.irurueta.units.Speed
    Gets norm of velocity, which represents the speed of the body.
    void
    getNormAsSpeed(com.irurueta.units.Speed result)
    Gets norm of velocity, which represents the speed of the body.
    com.irurueta.units.Speed
    Gets coordinate of velocity of body frame with respect ECEF frame and resolved along Down axis.
    void
    getSpeedD(com.irurueta.units.Speed result)
    Gets coordinate of velocity of body frame with respect ECEF frame and resolved along Down axis.
    com.irurueta.units.Speed
    Gets coordinate of velocity of body frame with respect ECEF frame and resolved along East axis.
    void
    getSpeedE(com.irurueta.units.Speed result)
    Gets coordinate of velocity of body frame with respect ECEF frame and resolved along East axis.
    com.irurueta.units.Speed
    Gets coordinate of velocity of body frame with respect ECEF frame and resolved along North axis.
    void
    getSpeedN(com.irurueta.units.Speed result)
    Gets coordinate of velocity of body frame with respect ECEF frame and resolved along North axis.
    double
    Gets coordinate of velocity of body frame expressed in meters per second (m/s) with respect ECEF frame and resolved along Down axis.
    double
    Gets coordinate of velocity of body frame expressed in meters per second (m/s) with respect ECEF frame and resolved along East axis.
    double
    Gets coordinate of velocity of body frame expressed in meters per second (m/s) with respect ECEF frame and resolved along North axis.
    int
    Computes and returns hash code for this instance.
    void
    setCoordinates(double vn, double ve, double vd)
    Sets velocity coordinates of body frame expressed in meters per second (m/s) resolved along North, East, Down axes.
    void
    setCoordinates(com.irurueta.units.Speed speedN, com.irurueta.units.Speed speedE, com.irurueta.units.Speed speedD)
    Sets velocity coordinates of body frame resolved along North, East, Down axes.
    void
    setSpeedD(com.irurueta.units.Speed speedD)
    Sets coordinate of velocity of body frame with respect ECEF frame and resolved along Down axis.
    void
    setSpeedE(com.irurueta.units.Speed speedE)
    Sets coordinate of velocity of body frame with respect ECEF frame and resolved along East axis.
    void
    setSpeedN(com.irurueta.units.Speed speedN)
    Sets coordinate of velocity of body frame with respect ECEF frame and resolved along North axis.
    void
    setVd(double vd)
    Sets coordinate of velocity of body frame expressed in meters per second (m/s) with respect ECEF frame and resolved along Down axis.
    void
    setVe(double ve)
    Sets coordinate of velocity of body frame expressed in meters per second (m/s) with respect ECEF frame and resolved along East axis.
    void
    setVn(double vn)
    Sets coordinate of velocity of body frame expressed in meters per second (m/s) with respect ECEF frame and resolved along North axis.

    Methods inherited from class java.lang.Object

    finalize, getClass, notify, notifyAll, toString, wait, wait, wait
  • Field Details

    • vn

      private double vn
      Coordinate of velocity of body frame expressed in meters per second (m/s) with respect ECEF frame and resolved along North axis.
    • ve

      private double ve
      Coordinate of velocity of body frame expressed in meters per second (m/s) with respect ECEF frame and resolved along East axis.
    • vd

      private double vd
      Coordinate of velocity of body frame expressed in meters per second (m/s) with respect ECEF frame and resolved along Down axis.
  • Constructor Details

    • NEDVelocity

      public NEDVelocity()
      Constructor.
    • NEDVelocity

      public NEDVelocity(double vn, double ve, double vd)
      Constructor.
      Parameters:
      vn - North velocity coordinate value expressed in meters per second (m/s).
      ve - East velocity coordinate value expressed in meters per second (m/s).
      vd - Down velocity coordinate value expressed in meters per second (m/s).
    • NEDVelocity

      public NEDVelocity(com.irurueta.units.Speed vn, com.irurueta.units.Speed ve, com.irurueta.units.Speed vd)
      Constructor.
      Parameters:
      vn - North velocity coordinate value.
      ve - East velocity coordinate value.
      vd - Down velocity coordinate value.
    • NEDVelocity

      public NEDVelocity(NEDVelocity input)
      Constructor.
      Parameters:
      input - Body velocity to copy data from.
  • Method Details

    • getVn

      public double getVn()
      Gets coordinate of velocity of body frame expressed in meters per second (m/s) with respect ECEF frame and resolved along North axis.
      Returns:
      North velocity coordinate value.
    • setVn

      public void setVn(double vn)
      Sets coordinate of velocity of body frame expressed in meters per second (m/s) with respect ECEF frame and resolved along North axis.
      Parameters:
      vn - North velocity coordinate value.
    • getVe

      public double getVe()
      Gets coordinate of velocity of body frame expressed in meters per second (m/s) with respect ECEF frame and resolved along East axis.
      Returns:
      East velocity coordinate value.
    • setVe

      public void setVe(double ve)
      Sets coordinate of velocity of body frame expressed in meters per second (m/s) with respect ECEF frame and resolved along East axis.
      Parameters:
      ve - East velocity coordinate value.
    • getVd

      public double getVd()
      Gets coordinate of velocity of body frame expressed in meters per second (m/s) with respect ECEF frame and resolved along Down axis.
      Returns:
      Down velocity coordinate value.
    • setVd

      public void setVd(double vd)
      Sets coordinate of velocity of body frame expressed in meters per second (m/s) with respect ECEF frame and resolved along Down axis.
      Parameters:
      vd - Down velocity coordinate value.
    • setCoordinates

      public void setCoordinates(double vn, double ve, double vd)
      Sets velocity coordinates of body frame expressed in meters per second (m/s) resolved along North, East, Down axes.
      Parameters:
      vn - North velocity coordinate value.
      ve - East velocity coordinate value.
      vd - Down velocity coordinate value.
    • getNorm

      public double getNorm()
      Gets norm of velocity expressed in meters per second (m/s), which represents the speed of the body.
      Returns:
      norm of velocity expressed in meters per second (m/s).
    • getNormAsSpeed

      public void getNormAsSpeed(com.irurueta.units.Speed result)
      Gets norm of velocity, which represents the speed of the body.
      Parameters:
      result - velocity norm.
    • getNormAsSpeed

      public com.irurueta.units.Speed getNormAsSpeed()
      Gets norm of velocity, which represents the speed of the body.
      Returns:
      velocity norm.
    • getSpeedN

      public void getSpeedN(com.irurueta.units.Speed result)
      Gets coordinate of velocity of body frame with respect ECEF frame and resolved along North axis.
      Parameters:
      result - instance where North velocity coordinate will be stored.
    • getSpeedN

      public com.irurueta.units.Speed getSpeedN()
      Gets coordinate of velocity of body frame with respect ECEF frame and resolved along North axis.
      Returns:
      North velocity coordinate.
    • setSpeedN

      public void setSpeedN(com.irurueta.units.Speed speedN)
      Sets coordinate of velocity of body frame with respect ECEF frame and resolved along North axis.
      Parameters:
      speedN - North velocity coordinate to be set.
    • getSpeedE

      public void getSpeedE(com.irurueta.units.Speed result)
      Gets coordinate of velocity of body frame with respect ECEF frame and resolved along East axis.
      Parameters:
      result - instance where East velocity coordinate will be stored.
    • getSpeedE

      public com.irurueta.units.Speed getSpeedE()
      Gets coordinate of velocity of body frame with respect ECEF frame and resolved along East axis.
      Returns:
      East velocity coordinate.
    • setSpeedE

      public void setSpeedE(com.irurueta.units.Speed speedE)
      Sets coordinate of velocity of body frame with respect ECEF frame and resolved along East axis.
      Parameters:
      speedE - East velocity coordinate to be set.
    • getSpeedD

      public void getSpeedD(com.irurueta.units.Speed result)
      Gets coordinate of velocity of body frame with respect ECEF frame and resolved along Down axis.
      Parameters:
      result - instance where Down velocity coordinate will be stored.
    • getSpeedD

      public com.irurueta.units.Speed getSpeedD()
      Gets coordinate of velocity of body frame with respect ECEF frame and resolved along Down axis.
      Returns:
      Down velocity coordinate.
    • setSpeedD

      public void setSpeedD(com.irurueta.units.Speed speedD)
      Sets coordinate of velocity of body frame with respect ECEF frame and resolved along Down axis.
      Parameters:
      speedD - Down velocity coordinate to be set.
    • setCoordinates

      public void setCoordinates(com.irurueta.units.Speed speedN, com.irurueta.units.Speed speedE, com.irurueta.units.Speed speedD)
      Sets velocity coordinates of body frame resolved along North, East, Down axes.
      Parameters:
      speedN - North velocity coordinate.
      speedE - East velocity coordinate.
      speedD - Down velocity coordinate.
    • copyTo

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

      public void copyFrom(NEDVelocity input)
      Copies data of provided instance into this instance.
      Parameters:
      input - instance to copy data from.
    • 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)
      Checks if provided object is a BodyVelocity 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(NEDVelocity 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(NEDVelocity 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 difference allowed between velocity 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 some reason.