Package org.orekit.files.ccsds.ndm.adm.acm

Class AttitudeStateHistoryMetadata

java.lang.Object
org.orekit.files.ccsds.section.CommentsContainer
org.orekit.files.ccsds.ndm.adm.acm.AttitudeStateHistoryMetadata
All Implemented Interfaces:
Section
public class AttitudeStateHistoryMetadata extends CommentsContainer
Metadata for attitude state history.

Beware that the Orekit getters and setters all rely on SI units. The parsers and writers take care of converting these SI units into CCSDS mandatory units. The Unit class provides useful fromSi and toSI methods in case the callers already use CCSDS units instead of the API SI units. The general-purpose Unit class (without an 's') and the CCSDS-specific Units class (with an 's') also provide some predefined units. These predefined units and the fromSi and toSI conversion methods are indeed what the parsers and writers use for the conversions.

Since:
12.0
Author:
Luc Maisonobe

  • Constructor Details

    • AttitudeStateHistoryMetadata

      public AttitudeStateHistoryMetadata(CcsdsFrameMapper frameMapper)
      Simple constructor.
      Parameters:
      frameMapper - for creating a Frame.
      Since:
      13.1.5

  • Method Details

    • validate

      public void validate(double version)
      Check is all mandatory entries have been initialized.

      This method should throw an exception if some mandatory entries are missing or not compatible with version number.

      Specified by:
      validate in interface Section
      Overrides:
      validate in class CommentsContainer
      Parameters:
      version - format version

    • getEndpoints

      public AttitudeEndpoints getEndpoints()
      Get the endpoints (i.e. frames A, B and their relationship).
      Returns:
      endpoints

    • getAttID

      public String getAttID()
      Get attitude identification number.
      Returns:
      attitude identification number

    • setAttID

      public void setAttID(String attID)
      Set attitude identification number.
      Parameters:
      attID - attitude identification number

    • getAttPrevID

      public String getAttPrevID()
      Get identification number of previous attitude.
      Returns:
      identification number of previous attitude

    • setAttPrevID

      public void setAttPrevID(String attPrevID)
      Set identification number of previous attitude.
      Parameters:
      attPrevID - identification number of previous attitude

    • getAttBasis

      public String getAttBasis()
      Get basis of this attitude state time history data.
      Returns:
      basis of this attitude state time history data

    • setAttBasis

      public void setAttBasis(String attBasis)
      Set basis of this attitude state time history data.
      Parameters:
      attBasis - basis of this attitude state time history data

    • getAttBasisID

      public String getAttBasisID()
      Get identification number of the orbit determination or simulation upon which this attitude is based.
      Returns:
      identification number of the orbit determination or simulation upon which this attitude is based

    • setAttBasisID

      public void setAttBasisID(String attBasisID)
      Set identification number of the orbit determination or simulation upon which this attitude is based.
      Parameters:
      attBasisID - identification number of the orbit determination or simulation upon which this attitude is based

    • getEulerRotSeq

      public RotationOrder getEulerRotSeq()
      Get the rotation order for Euler angles.
      Returns:
      rotation order for Euler angles

    • setEulerRotSeq

      public void setEulerRotSeq(RotationOrder eulerRotSeq)
      Set the rotation order for Euler angles.
      Parameters:
      eulerRotSeq - rotation order for Euler angles

    • getNbStates

      public int getNbStates()
      Get the number of data states included (attitude components plus rates components).
      Returns:
      number of data states included (attitude components plus rates components)

    • setNbStates

      public void setNbStates(int nbStates)
      Set the number of data states included (attitude components plus rates components).
      Parameters:
      nbStates - number of data states included (attitude components plus rates components)

    • getAttitudeType

      public AttitudeElementsType getAttitudeType()
      Get attitude element set type.
      Returns:
      attitude element set type

    • setAttitudeType

      public void setAttitudeType(AttitudeElementsType attitudeType)
      Set attitude element set type.
      Parameters:
      attitudeType - attitude element set type

    • getRateType

      public RateElementsType getRateType()
      Get attitude rate element set type.
      Returns:
      attitude rate element set type

    • setRateType

      public void setRateType(RateElementsType rateType)
      Set attitude rate element set type.
      Parameters:
      rateType - attitude rate element set type