agi.foundation.propagators

(agi.foundation.orbitpropagation-2023r2.jar)

Class OrbitLifetimeResults

java.lang.Object

agi.foundation.propagators.OrbitLifetimeResults

public class OrbitLifetimeResults
extends Object

A set of results indicating the time at which an orbit is expected to decay and the time history of the mean elements. Note that these results may not always indicate a decayed orbit. Check the Status (get / set) to see whether one of the limit conditions was met before finishing the calculation. In that case, the DateOfDecay (get / set) will be equal to the ReferenceEpoch (get / set), indicating an unknown decay date.

Constructor Summary

Constructors

Constructor and Description
OrbitLifetimeResults()

Method Summary

Modifier and Type	Method and Description
JulianDate	getDateOfDecay() Gets the expected date after which the satellite is expected to permanently decay, or in the case that the Status (get / set) indicates an incomplete calculation this will be equal to the ReferenceEpoch (get / set) indicating an unknown decay date.
List<LifetimeElements>	getElements() Gets the list of mean element sets for the successive orbit passes.
ReferenceFrame	getPropagationFrame() Gets the frame in which the time history of the orbit was propagated.
JulianDate	getReferenceEpoch() Gets the reference time at which the orbit lifetime calculation started.
int	getRevolutionCount() Gets the number of orbits between the ReferenceEpoch (get / set) and the DateOfDecay (get / set).
LifetimeCalculationStatus	getStatus() Gets the status indicating whether the orbit has decayed or whether the calculation finished without finding any decay.
void	setDateOfDecay(JulianDate value) Sets the expected date after which the satellite is expected to permanently decay, or in the case that the Status (get / set) indicates an incomplete calculation this will be equal to the ReferenceEpoch (get / set) indicating an unknown decay date.
void	setElements(List<LifetimeElements> value) Sets the list of mean element sets for the successive orbit passes.
void	setPropagationFrame(ReferenceFrame value) Sets the frame in which the time history of the orbit was propagated.
void	setReferenceEpoch(JulianDate value) Sets the reference time at which the orbit lifetime calculation started.
void	setRevolutionCount(int value) Sets the number of orbits between the ReferenceEpoch (get / set) and the DateOfDecay (get / set).
void	setStatus(LifetimeCalculationStatus value) Sets the status indicating whether the orbit has decayed or whether the calculation finished without finding any decay.

Methods inherited from class java.lang.Object

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

Constructor Detail

OrbitLifetimeResults

public OrbitLifetimeResults()

Method Detail

getStatus

@Nonnull
public final LifetimeCalculationStatus getStatus()

Gets the status indicating whether the orbit has decayed or whether the calculation finished without finding any decay.

setStatus

public final void setStatus(@Nonnull
                            LifetimeCalculationStatus value)

Sets the status indicating whether the orbit has decayed or whether the calculation finished without finding any decay.

getRevolutionCount

public final int getRevolutionCount()

Gets the number of orbits between the ReferenceEpoch (get / set) and the DateOfDecay (get / set).

setRevolutionCount

public final void setRevolutionCount(int value)

Sets the number of orbits between the ReferenceEpoch (get / set) and the DateOfDecay (get / set).

getReferenceEpoch

@Nonnull
public final JulianDate getReferenceEpoch()

Gets the reference time at which the orbit lifetime calculation started.

setReferenceEpoch

public final void setReferenceEpoch(@Nonnull
                                    JulianDate value)

Sets the reference time at which the orbit lifetime calculation started.

getDateOfDecay

@Nonnull
public final JulianDate getDateOfDecay()

Gets the expected date after which the satellite is expected to permanently decay, or in the case that the Status (get / set) indicates an incomplete calculation this will be equal to the ReferenceEpoch (get / set) indicating an unknown decay date.

setDateOfDecay

public final void setDateOfDecay(@Nonnull
                                 JulianDate value)

Sets the expected date after which the satellite is expected to permanently decay, or in the case that the Status (get / set) indicates an incomplete calculation this will be equal to the ReferenceEpoch (get / set) indicating an unknown decay date.

getPropagationFrame

public final ReferenceFrame getPropagationFrame()

Gets the frame in which the time history of the orbit was propagated.

setPropagationFrame

public final void setPropagationFrame(ReferenceFrame value)

Sets the frame in which the time history of the orbit was propagated.

getElements

public final List<LifetimeElements> getElements()

Gets the list of mean element sets for the successive orbit passes.

setElements

public final void setElements(List<LifetimeElements> value)

Sets the list of mean element sets for the successive orbit passes.