fr.cnes.dynvol.psimu.calc.integrator

Class PsimuPropagationData

java.lang.Object

fr.cnes.dynvol.psimu.calc.integrator.PsimuPropagationData

public class PsimuPropagationData
extends Object

Class containing the propagation data.

Author:

sumelzi

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PsimuPropagationData.AltitudeType Altitude type.

Constructor Summary

Constructors

Constructor and Description
PsimuPropagationData(fr.cnes.sirius.patrius.time.AbsoluteDate finalDate, fr.cnes.sirius.patrius.frames.Frame propagationFrame, double stopAltitude) Creates a new instance defined by final date.
PsimuPropagationData(fr.cnes.sirius.patrius.time.AbsoluteDate finalDate, fr.cnes.sirius.patrius.frames.Frame propagationFrame, double stopAltitude, PsimuPropagationData.AltitudeType stopAltitudeType) Creates a new instance defined by final date.
PsimuPropagationData(double duration, fr.cnes.sirius.patrius.frames.Frame propagationFrame, double stopAltitude) Creates a new instance defined by duration.
PsimuPropagationData(double duration, fr.cnes.sirius.patrius.frames.Frame propagationFrame, double stopAltitude, PsimuPropagationData.AltitudeType stopAltitudeType) Creates a new instance defined by duration.

Method Summary

Modifier and Type	Method and Description
double	getDuration() Return the propagation duration.
EndPropagationEnum	getEndPropagationType() Return the end propagation type.
fr.cnes.sirius.patrius.time.AbsoluteDate	getPropagationFinalDate(fr.cnes.sirius.patrius.time.AbsoluteDate date0) Get final propagation date.
fr.cnes.sirius.patrius.frames.Frame	getPropagationFrame() Get the propagation frame.
double	getStopAltitude() Get the stop altitude.
PsimuPropagationData.AltitudeType	getStopAltitudeType() Get the stop altitude.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

PsimuPropagationData

public PsimuPropagationData(double duration,
                            fr.cnes.sirius.patrius.frames.Frame propagationFrame,
                            double stopAltitude)
                     throws PsimuException

Creates a new instance defined by duration. Stop altitude is geodetic.

Parameters:

duration - propagation duration

propagationFrame - propagation frame

stopAltitude - the propagation is stopped when this altitude is reached (m)

Throws:

PsimuException - if propagation frame is not given

PsimuPropagationData

public PsimuPropagationData(fr.cnes.sirius.patrius.time.AbsoluteDate finalDate,
                            fr.cnes.sirius.patrius.frames.Frame propagationFrame,
                            double stopAltitude)
                     throws PsimuException

Creates a new instance defined by final date. Stop altitude is geodetic.

Parameters:

finalDate - the final date

propagationFrame - propagation frame

stopAltitude - the propagation is stopped when this altitude is reached (m)

Throws:

PsimuException - if inputs are wrongly given

PsimuPropagationData

public PsimuPropagationData(double duration,
                            fr.cnes.sirius.patrius.frames.Frame propagationFrame,
                            double stopAltitude,
                            PsimuPropagationData.AltitudeType stopAltitudeType)
                     throws PsimuException

Creates a new instance defined by duration.

Parameters:

duration - propagation duration

propagationFrame - propagation frame

stopAltitude - the propagation is stopped when this altitude is reached (m)

stopAltitudeType - stop altitude type

Throws:

PsimuException - if propagation frame is not given

PsimuPropagationData

public PsimuPropagationData(fr.cnes.sirius.patrius.time.AbsoluteDate finalDate,
                            fr.cnes.sirius.patrius.frames.Frame propagationFrame,
                            double stopAltitude,
                            PsimuPropagationData.AltitudeType stopAltitudeType)
                     throws PsimuException

Creates a new instance defined by final date.

Parameters:

finalDate - the final date

propagationFrame - propagation frame

stopAltitude - the propagation is stopped when this altitude is reached (m)

stopAltitudeType - stop altitude type

Throws:

PsimuException - if inputs are wrongly given

Method Detail

getPropagationFinalDate

public fr.cnes.sirius.patrius.time.AbsoluteDate getPropagationFinalDate(fr.cnes.sirius.patrius.time.AbsoluteDate date0)
                                                                 throws PsimuException

Get final propagation date.

Parameters:

date0 - the initial date (it might be null if propagation is defined by final date)

Returns:

the final propagation date

Throws:

PsimuException - psimu exception

getPropagationFrame

public fr.cnes.sirius.patrius.frames.Frame getPropagationFrame()

Get the propagation frame.

Returns:

the propagation frame

getStopAltitude

public double getStopAltitude()

Get the stop altitude.

Returns:

the stop altitude

getStopAltitudeType

public PsimuPropagationData.AltitudeType getStopAltitudeType()

Get the stop altitude.

Returns:

the stop altitude

getEndPropagationType

public EndPropagationEnum getEndPropagationType()

Return the end propagation type.

Returns:

the end propagation type

getDuration

public double getDuration()

Return the propagation duration.

Returns:

the propagation duration