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

Class AttitudeManeuver

java.lang.Object
org.orekit.files.ccsds.section.CommentsContainer
org.orekit.files.ccsds.ndm.adm.acm.AttitudeManeuver
All Implemented Interfaces:
Section
public class AttitudeManeuver extends CommentsContainer
Maneuver entry.

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

    • AttitudeManeuver

      public AttitudeManeuver()
      Build an uninitialized maneuver.

  • 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

    • getID

      public String getID()
      Get maneuver identification number.
      Returns:
      maneuver identification number

    • setID

      public void setID(String manId)
      Set maneuver identification number.
      Parameters:
      manId - maneuver identification number

    • getPrevID

      public String getPrevID()
      Get identification number of previous maneuver.
      Returns:
      identification number of previous maneuver

    • setPrevID

      public void setPrevID(String prevID)
      Set identification number of previous maneuver.
      Parameters:
      prevID - identification number of previous maneuver

    • getManPurpose

      public String getManPurpose()
      Get purpose of maneuver.
      Returns:
      purpose of maneuver

    • setManPurpose

      public void setManPurpose(String manPurpose)
      Set purpose of maneuver.
      Parameters:
      manPurpose - purpose of maneuver

    • getBeginTime

      public double getBeginTime()
      Get start time of actual maneuver, relative to t₀.
      Returns:
      start time of actual maneuver, relative to t₀

    • setBeginTime

      public void setBeginTime(double beginTime)
      Set start time of actual maneuver, relative to t₀.
      Parameters:
      beginTime - start time of actual maneuver, relative to t₀

    • getEndTime

      public double getEndTime()
      Get end time of actual maneuver, relative to t₀.
      Returns:
      end time of actual maneuver, relative to t₀

    • setEndTime

      public void setEndTime(double endTime)
      Set end time of actual maneuver, relative to t₀.
      Parameters:
      endTime - end time of actual maneuver, relative to t₀

    • getDuration

      public double getDuration()
      Get duration.
      Returns:
      duration

    • setDuration

      public void setDuration(double duration)
      Set duration.
      Parameters:
      duration - duration

    • getActuatorUsed

      public String getActuatorUsed()
      Get the actuator used.
      Returns:
      actuator used

    • setActuatorUsed

      public void setActuatorUsed(String actuatorUsed)
      Set actuator used.
      Parameters:
      actuatorUsed - actuator used

    • getTargetMomentum

      public Vector3D getTargetMomentum()
      Get target momentum (if purpose is momentum desaturation).
      Returns:
      target momentum

    • setTargetMomentum

      public void setTargetMomentum(Vector3D targetMomentum)
      Set target momentum (if purpose is momentum desaturation).
      Parameters:
      targetMomentum - target momentum

    • getTargetMomFrame

      public FrameFacade getTargetMomFrame()
      Get reference frame for getTargetMomentum().
      Returns:
      reference frame for getTargetMomentum()

    • setTargetMomFrame

      public void setTargetMomFrame(FrameFacade targetMomFrame)
      Set reference frame for getTargetMomentum().
      Parameters:
      targetMomFrame - reference frame for getTargetMomentum()

    • getTargetAttitude

      public Rotation getTargetAttitude()
      Get target attitude (if purpose is attitude adjustment).
      Returns:
      target attitude

    • setTargetAttitude

      public void setTargetAttitude(Rotation targetAttitude)
      Set target attitude (if purpose is attitude adjustment).
      Parameters:
      targetAttitude - target attitude

    • getTargetSpinRate

      public double getTargetSpinRate()
      Get target spin rate (if purpose is spin rate adjustment).
      Returns:
      target spin rate

    • setTargetSpinRate

      public void setTargetSpinRate(double targetSpinRate)
      Set target spin rate (if purpose is spin rate adjustment).
      Parameters:
      targetSpinRate - target spin rate