Package org.orekit.orbits

Record Class FieldKeplerianParameters<T extends CalculusFieldElement<T>>

java.lang.Object
java.lang.Record
org.orekit.orbits.FieldKeplerianParameters<T>
Record Components:
a - semi-major axis
e - eccentricity
i - inclination
pa - position angle
raan - right ascension of ascending node
anomaly - anomaly corresponding to angle type
positionAngleType - angle type
public record FieldKeplerianParameters<T extends CalculusFieldElement<T>>(T extends CalculusFieldElement<T> a, T extends CalculusFieldElement<T> e, T extends CalculusFieldElement<T> i, T extends CalculusFieldElement<T> pa, T extends CalculusFieldElement<T> raan, T extends CalculusFieldElement<T> anomaly, PositionAngleType positionAngleType) extends Record
Data container for Keplerian orbital elements (Field version).
Since:
14.0
Author:
Romain Serra
See Also:

  • Constructor Details

    • FieldKeplerianParameters

      public FieldKeplerianParameters(Field<T> field, KeplerianParameters elements)
      Constructor from non-Field.
      Parameters:
      field - field
      elements - Keplerian elements

    • FieldKeplerianParameters

      public FieldKeplerianParameters(T a, T e, T i, T pa, T raan, T anomaly, PositionAngleType positionAngleType)
      Creates an instance of a FieldKeplerianParameters record class.
      Parameters:
      a - the value for the a record component
      e - the value for the e record component
      i - the value for the i record component
      pa - the value for the pa record component
      raan - the value for the raan record component
      anomaly - the value for the anomaly record component
      positionAngleType - the value for the positionAngleType record component

  • Method Details

    • withPositionAngleType

      public FieldKeplerianParameters<T> withPositionAngleType(PositionAngleType angleType)
      Builds a new instance with the specified position angle type.
      Parameters:
      angleType - angle type for the output
      Returns:
      Keplerian elements with the specified position angle type

    • toKeplerianElements

      public KeplerianParameters toKeplerianElements()
      Convert Field elements to non-Field ones.
      Returns:
      Keplerian elements

    • 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. All components in this record class are compared with Objects::equals(Object,Object).
      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 T a()
      Returns the value of the a record component.
      Returns:
      the value of the a record component

    • e

      public T e()
      Returns the value of the e record component.
      Returns:
      the value of the e record component

    • i

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

    • pa

      public T pa()
      Returns the value of the pa record component.
      Returns:
      the value of the pa record component

    • raan

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

    • anomaly

      public T anomaly()
      Returns the value of the anomaly record component.
      Returns:
      the value of the anomaly record component

    • positionAngleType

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