fr.cnes.sirius.patrius.stela.orbits

Class OrbitNatureConverter

java.lang.Object

fr.cnes.sirius.patrius.stela.orbits.OrbitNatureConverter

All Implemented Interfaces:

Serializable

public final class OrbitNatureConverter
extends Object
implements Serializable

Converts a StelaEquinoctialOrbit from mean to osculating parameters, and reverse. Since the StelaEquinoctialOrbit does not contain a "mean" or "osculating" information flag, it is the user's responsibility to ensure a coherent use of this converter.

Since:

1.3

Version:

$Id$

Author:

cardosop

See Also:

Serialized Form

Use sample :

final OrbitNatureConverter obc = new OrbitNatureConverter();
final StelaEquinoctialOrbit meanOrbit = obc.toMean(osculatingOrbit,...);

Concurrency :

not thread-safe

Concurrency comment :

instances are mutable

Constructor Summary

Constructors

Constructor and Description
OrbitNatureConverter(List<StelaForceModel> inForceModels) Default constructor.

Method Summary

Modifier and Type	Method and Description
List<StelaForceModel>	getForceModels() Returns the force model taken into account in the converter.
static void	setThreshold(double newThreshold) Setter for osculating to mean conversion relative convergence threshold.
static void	setThresholdDegraded(double newThreshold) Setter for osculating to mean conversion second relative convergence threshold.
StelaEquinoctialOrbit	toMean(StelaEquinoctialOrbit oscOrbit) Converts an osculating StelaEquinoctialOrbit to a mean one.
StelaEquinoctialOrbit	toOsculating(StelaEquinoctialOrbit meanOrbit) Converts a mean StelaEquinoctialOrbit to an osculating one.

Methods inherited from class java.lang.Object

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

Constructor Detail

OrbitNatureConverter

public OrbitNatureConverter(List<StelaForceModel> inForceModels)

Default constructor.

Parameters:

inForceModels - list of force models used for conversion

Method Detail

toMean

public StelaEquinoctialOrbit toMean(StelaEquinoctialOrbit oscOrbit)
                             throws PatriusException

Converts an osculating StelaEquinoctialOrbit to a mean one.

Parameters:

oscOrbit - input osculating orbit

Returns:

a mean orbit equivalent to the osculating input orbit

Throws:

PatriusException - if a position computation fails

toOsculating

public StelaEquinoctialOrbit toOsculating(StelaEquinoctialOrbit meanOrbit)
                                   throws PatriusException

Converts a mean StelaEquinoctialOrbit to an osculating one.

Parameters:

meanOrbit - input mean orbit

Returns:

an osculating orbit equivalent to the mean input orbit

Throws:

PatriusException - if a position computation fails

setThreshold

public static void setThreshold(double newThreshold)

Setter for osculating to mean conversion relative convergence threshold. Default value for this threshold is DEFAULT_THRESHOLD.

Parameters:

newThreshold - new threshold to set

setThresholdDegraded

public static void setThresholdDegraded(double newThreshold)

Setter for osculating to mean conversion second relative convergence threshold. This threshold is used only if convergence has not been reached within maximum number of iterations. If convergence is reached with this threshold, then last bulletin is returned, otherwise an exception is thrown. Default value for this threshold is DEFAULT_THRESHOLD.

Parameters:

newThreshold - new threshold to set

getForceModels

public List<StelaForceModel> getForceModels()

Returns the force model taken into account in the converter.

Returns:

the force model taken into account in the converter