Package org.orekit.orbits

Record Class EquinoctialParameters

java.lang.Object
java.lang.Record
org.orekit.orbits.EquinoctialParameters
Record Components:
a - semi-major axis
ex - first component of the eccentricity vector
ey - second component of the eccentricity vector
hx - first component of the inclination vector
hy - second component of the inclination vector
longitudeArgument - argument of longitude corresponding to angle type
positionAngleType - angle type
public record EquinoctialParameters(double a, double ex, double ey, double hx, double hy, double longitudeArgument, PositionAngleType positionAngleType) extends Record
Data container for equinoctial orbital elements.
Since:
14.0
Author:
Romain Serra
See Also:

  • Constructor Details

    • EquinoctialParameters

      public EquinoctialParameters(double a, double ex, double ey, double hx, double hy, double longitudeArgument, PositionAngleType positionAngleType)
      Creates an instance of a EquinoctialParameters record class.
      Parameters:
      a - the value for the a record component
      ex - the value for the ex record component
      ey - the value for the ey record component
      hx - the value for the hx record component
      hy - the value for the hy record component
      longitudeArgument - the value for the longitudeArgument record component
      positionAngleType - the value for the positionAngleType record component

  • Method Details

    • withPositionAngleType

      public EquinoctialParameters withPositionAngleType(PositionAngleType angleType)
      Builds a new instance with the specified position angle type.
      Parameters:
      angleType - angle type for the output
      Returns:
      equinoctial elements with the specified position angle type

    • 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 '=='.
      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.

    • a

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

    • ex

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

    • ey

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

    • hx

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

    • hy

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

    • longitudeArgument

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

    • positionAngleType

      public PositionAngleType positionAngleType()
      Returns the value of the positionAngleType record component.
      Returns:
      the value of the positionAngleType record component