Package org.orekit.orbits

Record Class CircularParameters

java.lang.Object
java.lang.Record
org.orekit.orbits.CircularParameters
Record Components:
a - semi-major axis
ex - first component of the eccentricity vector
ey - second component of the eccentricity vector
i - inclination
raan - right ascension of ascending node
latitudeArgument - argument of latitude corresponding to angle type
positionAngleType - angle type
public record CircularParameters(double a, double ex, double ey, double i, double raan, double latitudeArgument, PositionAngleType positionAngleType) extends Record
Data container for circular orbital elements.
Since:
14.0
Author:
Romain Serra
See Also:

  • Constructor Details

    • CircularParameters

      public CircularParameters(double a, double ex, double ey, double i, double raan, double latitudeArgument, PositionAngleType positionAngleType)
      Creates an instance of a CircularParameters 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
      i - the value for the i record component
      raan - the value for the raan record component
      latitudeArgument - the value for the latitudeArgument record component
      positionAngleType - the value for the positionAngleType record component

  • Method Details

    • withPositionAngleType

      public CircularParameters withPositionAngleType(PositionAngleType angleType)
      Builds a new instance with the specified position angle type.
      Parameters:
      angleType - angle type for the output
      Returns:
      circular 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

    • i

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

    • raan

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

    • latitudeArgument

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

    • positionAngleType

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