Package org.orekit.files.sinex.orbex

Record Class Description

java.lang.Object
java.lang.Record
org.orekit.files.sinex.orbex.Description
Record Components:
description - description
createdBy - name of agency which created the file
inputData - input used to generate this file
contact - E-mail address of the relevant contact person
timeSystem - time system
epochInterval - number of seconds between each epoch (NaN if irregular)
coordinateSystem - name of reference frame
frameType - frame type
orbitType - orbit type
recordTypes - recordTypes
orbitReference - orbit reference
positionUnit - unit for position
velocityUnit - unit for velocity
clockCorrectionUnit - unit for clock correction
clockRateUnit - unit for clock rate
public record Description(String description, String createdBy, String inputData, String contact, TimeSystem timeSystem, double epochInterval, Frame coordinateSystem, String frameType, String orbitType, List<org.orekit.files.sinex.orbex.EphemerisDataPredicate> recordTypes, String orbitReference, Unit positionUnit, Unit velocityUnit, Unit clockCorrectionUnit, Unit clockRateUnit) extends Record
Container for ORBEX file description block.
Since:
14.0
Author:
Luc Maisonobe

  • Constructor Details

    • Description

      public Description(String description, String createdBy, String inputData, String contact, TimeSystem timeSystem, double epochInterval, Frame coordinateSystem, String frameType, String orbitType, List<org.orekit.files.sinex.orbex.EphemerisDataPredicate> recordTypes, String orbitReference, Unit positionUnit, Unit velocityUnit, Unit clockCorrectionUnit, Unit clockRateUnit)
      Creates an instance of a Description record class.
      Parameters:
      description - the value for the description record component
      createdBy - the value for the createdBy record component
      inputData - the value for the inputData record component
      contact - the value for the contact record component
      timeSystem - the value for the timeSystem record component
      epochInterval - the value for the epochInterval record component
      coordinateSystem - the value for the coordinateSystem record component
      frameType - the value for the frameType record component
      orbitType - the value for the orbitType record component
      recordTypes - the value for the recordTypes record component
      orbitReference - the value for the orbitReference record component
      positionUnit - the value for the positionUnit record component
      velocityUnit - the value for the velocityUnit record component
      clockCorrectionUnit - the value for the clockCorrectionUnit record component
      clockRateUnit - the value for the clockRateUnit record component

  • Method Details

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

    • description

      public String description()
      Returns the value of the description record component.
      Returns:
      the value of the description record component

    • createdBy

      public String createdBy()
      Returns the value of the createdBy record component.
      Returns:
      the value of the createdBy record component

    • inputData

      public String inputData()
      Returns the value of the inputData record component.
      Returns:
      the value of the inputData record component

    • contact

      public String contact()
      Returns the value of the contact record component.
      Returns:
      the value of the contact record component

    • timeSystem

      public TimeSystem timeSystem()
      Returns the value of the timeSystem record component.
      Returns:
      the value of the timeSystem record component

    • epochInterval

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

    • coordinateSystem

      public Frame coordinateSystem()
      Returns the value of the coordinateSystem record component.
      Returns:
      the value of the coordinateSystem record component

    • frameType

      public String frameType()
      Returns the value of the frameType record component.
      Returns:
      the value of the frameType record component

    • orbitType

      public String orbitType()
      Returns the value of the orbitType record component.
      Returns:
      the value of the orbitType record component

    • recordTypes

      public List<org.orekit.files.sinex.orbex.EphemerisDataPredicate> recordTypes()
      Returns the value of the recordTypes record component.
      Returns:
      the value of the recordTypes record component

    • orbitReference

      public String orbitReference()
      Returns the value of the orbitReference record component.
      Returns:
      the value of the orbitReference record component

    • positionUnit

      public Unit positionUnit()
      Returns the value of the positionUnit record component.
      Returns:
      the value of the positionUnit record component

    • velocityUnit

      public Unit velocityUnit()
      Returns the value of the velocityUnit record component.
      Returns:
      the value of the velocityUnit record component

    • clockCorrectionUnit

      public Unit clockCorrectionUnit()
      Returns the value of the clockCorrectionUnit record component.
      Returns:
      the value of the clockCorrectionUnit record component

    • clockRateUnit

      public Unit clockRateUnit()
      Returns the value of the clockRateUnit record component.
      Returns:
      the value of the clockRateUnit record component