Package org.orekit.files.ccsds.ndm.odm.ocm

Class OrbitManeuverHistoryMetadata

  • All Implemented Interfaces:
    Section
    public class OrbitManeuverHistoryMetadata
extends CommentsContainer
    Metadata for maneuver history.
    Since:
    11.0
    Author:
    Luc Maisonobe

    • Field Detail

      • DEFAULT_DC_TYPE

        public static final DutyCycleType DEFAULT_DC_TYPE
        Default duty cycle type.
        Since:
        12.0

    • Constructor Detail

      • OrbitManeuverHistoryMetadata

        public OrbitManeuverHistoryMetadata​(AbsoluteDate epochT0)
        Simple constructor.
        Parameters:
        epochT0 - T0 epoch from file metadata

    • Method Detail

      • 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

      • getManID

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

      • setManID

        public void setManID​(String manID)
        Set maneuver identification number.
        Parameters:
        manID - maneuver identification number

      • getManPrevID

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

      • setManPrevID

        public void setManPrevID​(String manPrevID)
        Set identification number of previous maneuver.
        Parameters:
        manPrevID - identification number of previous maneuver

      • getManNextID

        public String getManNextID()
        Get identification number of next maneuver.
        Returns:
        identification number of next maneuver

      • setManNextID

        public void setManNextID​(String manNextID)
        Set identification number of next maneuver.
        Parameters:
        manNextID - identification number of next maneuver

      • getManBasis

        public ManBasis getManBasis()
        Get basis of this maneuver history data.
        Returns:
        basis of this maneuver history data

      • setManBasis

        public void setManBasis​(ManBasis manBasis)
        Set basis of this maneuver history data.
        Parameters:
        manBasis - basis of this maneuver history data

      • getManBasisID

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

      • setManBasisID

        public void setManBasisID​(String manBasisID)
        Set identification number of the orbit determination or simulation upon which this maneuver is based.
        Parameters:
        manBasisID - identification number of the orbit determination or simulation upon which this maneuver is based

      • getManDeviceID

        public String getManDeviceID()
        Get identifier of the device used for this maneuver.
        Returns:
        identifier of the device used for this maneuver

      • setManDeviceID

        public void setManDeviceID​(String manDeviceID)
        Set identifier of the device used for this maneuver.
        Parameters:
        manDeviceID - identifier of the device used for this maneuver

      • getManPrevEpoch

        public AbsoluteDate getManPrevEpoch()
        Get completion time of previous maneuver.
        Returns:
        completion time of previous maneuver

      • setManPrevEpoch

        public void setManPrevEpoch​(AbsoluteDate manPrevEpoch)
        Set completion time of previous maneuver.
        Parameters:
        manPrevEpoch - completion time of previous maneuver

      • getManNextEpoch

        public AbsoluteDate getManNextEpoch()
        Get start time of next maneuver.
        Returns:
        start time of next maneuver

      • setManNextEpoch

        public void setManNextEpoch​(AbsoluteDate manNextEpoch)
        Set start time of next maneuver.
        Parameters:
        manNextEpoch - start time of next maneuver

      • getManPurpose

        public List<String> getManPurpose()
        Get the purposes of the maneuver.
        Returns:
        purposes of the maneuver

      • setManPurpose

        public void setManPurpose​(List<String> manPurpose)
        Set the purposes of the maneuver.
        Parameters:
        manPurpose - purposes of the maneuver

      • getManPredSource

        public String getManPredSource()
        Get prediction source on which this maneuver is based.
        Returns:
        prediction source on which this maneuver is based

      • setManPredSource

        public void setManPredSource​(String manPredSource)
        Set prediction source on which this maneuver is based.
        Parameters:
        manPredSource - prediction source on which this maneuver is based

      • getManReferenceFrame

        public FrameFacade getManReferenceFrame()
        Get reference frame of the maneuver.
        Returns:
        reference frame of the maneuver

      • setManReferenceFrame

        public void setManReferenceFrame​(FrameFacade manReferenceFrame)
        Set reference frame of the maneuver.
        Parameters:
        manReferenceFrame - the reference frame to be set

      • getGravitationalAssist

        public BodyFacade getGravitationalAssist()
        Get the origin of gravitational assist.
        Returns:
        the origin of gravitational assist.

      • setGravitationalAssist

        public void setGravitationalAssist​(BodyFacade gravitationalAssist)
        Set the origin of gravitational assist.
        Parameters:
        gravitationalAssist - origin of gravitational assist to be set

      • getDcType

        public DutyCycleType getDcType()
        Get type of duty cycle.
        Returns:
        type of duty cycle

      • setDcType

        public void setDcType​(DutyCycleType dcType)
        Set type of duty cycle.
        Parameters:
        dcType - type of duty cycle

      • getDcWindowOpen

        public AbsoluteDate getDcWindowOpen()
        Get the start time of duty cycle-based maneuver window.
        Returns:
        start time of duty cycle-based maneuver window

      • setDcWindowOpen

        public void setDcWindowOpen​(AbsoluteDate dcWindowOpen)
        Set the start time of duty cycle-based maneuver window.
        Parameters:
        dcWindowOpen - start time of duty cycle-based maneuver window

      • getDcWindowClose

        public AbsoluteDate getDcWindowClose()
        Get the end time of duty cycle-based maneuver window.
        Returns:
        end time of duty cycle-based maneuver window

      • setDcWindowClose

        public void setDcWindowClose​(AbsoluteDate dcWindowClose)
        Set the end time of duty cycle-based maneuver window.
        Parameters:
        dcWindowClose - end time of duty cycle-based maneuver window

      • getDcMinCycles

        public int getDcMinCycles()
        Get the minimum number of "ON" duty cycles.
        Returns:
        minimum number of "ON" duty cycles (-1 if not set)

      • setDcMinCycles

        public void setDcMinCycles​(int dcMinCycles)
        Set the minimum number of "ON" duty cycles.
        Parameters:
        dcMinCycles - minimum number of "ON" duty cycles

      • getDcMaxCycles

        public int getDcMaxCycles()
        Get the maximum number of "ON" duty cycles.
        Returns:
        maximum number of "ON" duty cycles (-1 if not set)

      • setDcMaxCycles

        public void setDcMaxCycles​(int dcMaxCycles)
        Set the maximum number of "ON" duty cycles.
        Parameters:
        dcMaxCycles - maximum number of "ON" duty cycles

      • getDcExecStart

        public AbsoluteDate getDcExecStart()
        Get the start time of initial duty cycle-based maneuver execution.
        Returns:
        start time of initial duty cycle-based maneuver execution

      • setDcExecStart

        public void setDcExecStart​(AbsoluteDate dcExecStart)
        Set the start time of initial duty cycle-based maneuver execution.
        Parameters:
        dcExecStart - start time of initial duty cycle-based maneuver execution

      • getDcExecStop

        public AbsoluteDate getDcExecStop()
        Get the end time of final duty cycle-based maneuver execution.
        Returns:
        end time of final duty cycle-based maneuver execution

      • setDcExecStop

        public void setDcExecStop​(AbsoluteDate dcExecStop)
        Set the end time of final duty cycle-based maneuver execution.
        Parameters:
        dcExecStop - end time of final duty cycle-based maneuver execution

      • getDcRefTime

        public AbsoluteDate getDcRefTime()
        Get duty cycle thrust reference time.
        Returns:
        duty cycle thrust reference time

      • setDcRefTime

        public void setDcRefTime​(AbsoluteDate dcRefTime)
        Set duty cycle thrust reference time.
        Parameters:
        dcRefTime - duty cycle thrust reference time

      • getDcTimePulseDuration

        public double getDcTimePulseDuration()
        Get duty cycle pulse "ON" duration.
        Returns:
        duty cycle pulse "ON" duration

      • setDcTimePulseDuration

        public void setDcTimePulseDuration​(double dcTimePulseDuration)
        Set duty cycle pulse "ON" duration.
        Parameters:
        dcTimePulseDuration - duty cycle pulse "ON" duration

      • getDcTimePulsePeriod

        public double getDcTimePulsePeriod()
        Get duty cycle elapsed time between start of a pulse and start of next pulse.
        Returns:
        duty cycle elapsed time between start of a pulse and start of next pulse

      • setDcTimePulsePeriod

        public void setDcTimePulsePeriod​(double dcTimePulsePeriod)
        Set duty cycle elapsed time between start of a pulse and start of next pulse.
        Parameters:
        dcTimePulsePeriod - duty cycle elapsed time between start of a pulse and start of next pulse

      • getDcRefDir

        public Vector3D getDcRefDir()
        Get reference direction for triggering duty cycle.
        Returns:
        reference direction for triggering duty cycle

      • setDcRefDir

        public void setDcRefDir​(Vector3D dcRefDir)
        Set reference direction for triggering duty cycle.
        Parameters:
        dcRefDir - reference direction for triggering duty cycle

      • getDcBodyTrigger

        public Vector3D getDcBodyTrigger()
        Get direction in body frame for triggering duty cycle.
        Returns:
        direction in body frame for triggering duty cycle

      • setDcBodyTrigger

        public void setDcBodyTrigger​(Vector3D dcBodyTrigger)
        Set direction in body frame for triggering duty cycle.
        Parameters:
        dcBodyTrigger - direction in body frame for triggering duty cycle

      • getDcPhaseStartAngle

        public double getDcPhaseStartAngle()
        Get phase angle of pulse start.
        Returns:
        phase angle of pulse start

      • setDcPhaseStartAngle

        public void setDcPhaseStartAngle​(double dcPhaseStartAngle)
        Set phase angle of pulse start.
        Parameters:
        dcPhaseStartAngle - phase angle of pulse start

      • getDcPhaseStopAngle

        public double getDcPhaseStopAngle()
        Get phase angle of pulse stop.
        Returns:
        phase angle of pulse stop

      • setDcPhaseStopAngle

        public void setDcPhaseStopAngle​(double dcPhaseStopAngle)
        Set phase angle of pulse stop.
        Parameters:
        dcPhaseStopAngle - phase angle of pulse stop

      • getManComposition

        public List<ManeuverFieldType> getManComposition()
        Get maneuver elements of information.
        Returns:
        maneuver element of information

      • setManComposition

        public void setManComposition​(List<ManeuverFieldType> manComposition)
        Set maneuver element of information.
        Parameters:
        manComposition - maneuver element of information

      • getManUnits

        public List<Unit> getManUnits()
        Get maneuver elements of information units.
        Returns:
        maneuver element of information units

      • setManUnits

        public void setManUnits​(List<Unit> manUnits)
        Set maneuver element of information units.
        Parameters:
        manUnits - maneuver element of information units