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

Class ApmQuaternion

java.lang.Object
org.orekit.files.ccsds.section.CommentsContainer
org.orekit.files.ccsds.ndm.adm.apm.ApmQuaternion
All Implemented Interfaces:
Section
public class ApmQuaternion extends CommentsContainer
Container for Attitude Parameter Message quaternion logical block.

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:
10.2
Author:
Bryan Cazabonne

  • Constructor Details

    • ApmQuaternion

      public ApmQuaternion(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

    • getQuaternion

      public Quaternion getQuaternion()
      Get the quaternion.
      Returns:
      quaternion

    • setQ

      public void setQ(int index, double value)
      Set quaternion component.
      Parameters:
      index - component index (0 is scalar part)
      value - quaternion component

    • getQuaternionDot

      public Quaternion getQuaternionDot()
      Get the quaternion derivative.
      Returns:
      quaternion derivative

    • setQDot

      public void setQDot(int index, double derivative)
      Set quaternion derivative component.
      Parameters:
      index - component index (0 is scalar part)
      derivative - quaternion derivative component

    • hasRates

      public boolean hasRates()
      Check if the logical block includes rates.
      Returns:
      true if logical block includes rates