agi.foundation.propagators

Class LambertOrbitSolver.FailedToConvergeEventArgs

java.lang.Object

agi.foundation.compatibility.EventArgs

agi.foundation.propagators.LambertOrbitSolver.FailedToConvergeEventArgs

Enclosing class:

LambertOrbitSolver

public static class LambertOrbitSolver.FailedToConvergeEventArgs
extends EventArgs

Holds details of the FailedToConvergeEvent (add / remove) event.

Field Summary

Fields inherited from class agi.foundation.compatibility.EventArgs

Empty

Constructor Summary

Constructors

Constructor and Description
FailedToConvergeEventArgs(int finalIteration, double finalEpsilon, int revolutionCount, LambertPathType pathType, OrbitDirectionType directionOfFlight) Initializes a new instance.

Method Summary

Modifier and Type	Method and Description
OrbitDirectionType	getDirectionOfFlight() Gets the rotation sense of the Lambert path.
double	getFinalEpsilon() Gets the final error that the solver achieved.
int	getFinalIteration() Gets the final iteration number that the solver reached.
LambertPathType	getPathType() Gets whether this path was the small or large semi major axis.
int	getRevolutionCount() Gets the number of revolutions in this transfer orbit.

Methods inherited from class java.lang.Object

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

Constructor Detail

FailedToConvergeEventArgs

public FailedToConvergeEventArgs(int finalIteration,
                                 double finalEpsilon,
                                 int revolutionCount,
                                 @Nonnull
                                 LambertPathType pathType,
                                 @Nonnull
                                 OrbitDirectionType directionOfFlight)

Initializes a new instance.

Parameters:

finalIteration - The final iteration number that the solver reached.

finalEpsilon - The final error that the solver achieved.

revolutionCount - The number of revolutions in this orbit.

pathType - Whether the path is large or small semi major axis.

directionOfFlight - The rotation sense of the Lambert transfer orbit.

Method Detail

getFinalEpsilon

public final double getFinalEpsilon()

Gets the final error that the solver achieved.

getFinalIteration

public final int getFinalIteration()

Gets the final iteration number that the solver reached.

getRevolutionCount

public final int getRevolutionCount()

Gets the number of revolutions in this transfer orbit.

getDirectionOfFlight

@Nonnull
public final OrbitDirectionType getDirectionOfFlight()

Gets the rotation sense of the Lambert path.

getPathType

@Nonnull
public final LambertPathType getPathType()

Gets whether this path was the small or large semi major axis.