fr.cnes.sirius.patrius.progmission

Class EventUtils.GMEclipseResults

java.lang.Object

fr.cnes.sirius.patrius.progmission.EventUtils.GMEclipseResults

Enclosing class:

EventUtils

public static class EventUtils.GMEclipseResults
extends Object

Container class for the results of the computeGMEclipse methods.
If no eclipse interval was found, null values will be assigned to the orbit and intervals.

Constructor Summary

Constructors

Constructor and Description
GMEclipseResults(AbsoluteDateInterval eclipseInterval, KeplerianOrbit initialOrbit, ConstantVectorDirection sunVect) Constructor of the class.

Method Summary

Modifier and Type	Method and Description
double	getEclipsedArcAngle() Return the angle of the orbit arc that is covered by the eclipse interval.
double	getEclipseDuration() Return the duration of the eclipse interval.
AbsoluteDateInterval	getEclipseInterval() Return the eclipse interval computed by computeGMEclipse.
Orbit	getOrbitEclipseEnd() Return the orbit corresponding to the end of the eclipse interval.
Orbit	getOrbitEclipseStart() Return the orbit corresponding to the start of the eclipse interval.
Frame	getOrbitFrame() Return the orbit frame defined as follows: Origin: The orbit center X-axis: Towards the ascending node Z-axis: Same direction as the angular momentum vector Y-axis: Such that the frame is direct
Vector3D	getSunDirectionInOrbitFrame() Return the direction of the sun in the orbit frame defined as follows: Origin: The orbit center X-axis: Towards the ascending node Z-axis: Same direction as the angular momentum vector Y-axis: Such that the frame is direct.

Methods inherited from class java.lang.Object

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

Constructor Detail

GMEclipseResults

public GMEclipseResults(AbsoluteDateInterval eclipseInterval,
                        KeplerianOrbit initialOrbit,
                        ConstantVectorDirection sunVect)
                 throws PatriusException

Constructor of the class.
Computes the eclipsed orbit arc given the eclipse interval and the sun direction in the local QSW frame corresponding to the provided initial orbit.

Parameters:

eclipseInterval - Eclipse interval for the provided orbit. If null, stored orbits will be null and eclipse duration / arc values will be set to 0

initialOrbit - Initial orbit that has been considered for the eclipse interval computation

sunVect - Direction of the in the ITRF frame used to compute the eclipse interval

Throws:

PatriusException - if an error in Patrius configuration

Method Detail

getEclipseInterval

public AbsoluteDateInterval getEclipseInterval()

Return the eclipse interval computed by computeGMEclipse.

Returns:

the stored eclipse interval

getOrbitEclipseStart

public Orbit getOrbitEclipseStart()

Return the orbit corresponding to the start of the eclipse interval.

Returns:

the stored orbit

getOrbitEclipseEnd

public Orbit getOrbitEclipseEnd()

Return the orbit corresponding to the end of the eclipse interval.

Returns:

the stored orbit

getSunDirectionInOrbitFrame

public Vector3D getSunDirectionInOrbitFrame()

Return the direction of the sun in the orbit frame defined as follows:

• Origin: The orbit center
• X-axis: Towards the ascending node
• Z-axis: Same direction as the angular momentum vector
• Y-axis: Such that the frame is direct.

Returns:

the stored sun direction

getEclipseDuration

public double getEclipseDuration()

Return the duration of the eclipse interval.

Returns:

the stored eclipse duration

getEclipsedArcAngle

public double getEclipsedArcAngle()

Return the angle of the orbit arc that is covered by the eclipse interval.

Returns:

the stored angle

getOrbitFrame

public Frame getOrbitFrame()

Return the orbit frame defined as follows:

• Origin: The orbit center
• X-axis: Towards the ascending node
• Z-axis: Same direction as the angular momentum vector
• Y-axis: Such that the frame is direct

Returns:

the stored orbit frame