org.orekit.propagation.conversion

Interface PropagatorBuilder

All Known Implementing Classes:

AbstractPropagatorBuilder, EcksteinHechlerPropagatorBuilder, KeplerianPropagatorBuilder, NumericalPropagatorBuilder, TLEPropagatorBuilder

public interface PropagatorBuilder

This interface is the top-level abstraction to build propagators for conversion.

Since:

6.0

Author:

Pascal Parraud

Method Summary

Methods

Modifier and Type	Method and Description
Propagator	buildPropagator(AbsoluteDate date, double[] parameters) Build a propagator.
Frame	getFrame() Get the frame in which the orbit is propagated.
List<String>	getFreeParameters() Get the free parameters used to build the propagator.
OrbitType	getOrbitType() Get the orbit type expected for the 6 first parameters in buildPropagator(AbsoluteDate, double[]).
double	getParameter(String name) Get parameter value from its name.
PositionAngle	getPositionAngle() Get the position angle type expected for the 6 first parameters in buildPropagator(AbsoluteDate, double[]).
List<String>	getSupportedParameters() Get the names of the supported parameters.
void	setFreeParameters(List<String> parameters) Set the free parameters in order to build the propagator.
void	setParameter(String name, double value) Set parameter value from its name.

Method Detail

buildPropagator

Propagator buildPropagator(AbsoluteDate date,
                         double[] parameters)
                           throws OrekitException

Build a propagator.

Parameters:

date - date associated to the parameters to configure the initial state

parameters - set of position/velocity(/free) parameters to configure the propagator

Returns:

an initialized propagator

Throws:

OrekitException - if propagator cannot be build

getOrbitType

OrbitType getOrbitType()

Get the orbit type expected for the 6 first parameters in buildPropagator(AbsoluteDate, double[]).

Returns:

orbit type to use in buildPropagator(AbsoluteDate, double[])

Since:

7.1

See Also:

buildPropagator(AbsoluteDate, double[]), getPositionAngle()

getPositionAngle

PositionAngle getPositionAngle()

Get the position angle type expected for the 6 first parameters in buildPropagator(AbsoluteDate, double[]).

Returns:

position angle type to use in buildPropagator(AbsoluteDate, double[])

Since:

7.1

See Also:

buildPropagator(AbsoluteDate, double[]), getOrbitType()

getFrame

Frame getFrame()

Get the frame in which the orbit is propagated.

Returns:

frame in which the orbit is propagated

setFreeParameters

void setFreeParameters(List<String> parameters)
                       throws OrekitIllegalArgumentException

Set the free parameters in order to build the propagator.

The parameters must belong to the list returned by getSupportedParameters()

Parameters:

parameters - free parameters to set when building the propagator

Throws:

OrekitIllegalArgumentException - if one of the parameters is not supported

getSupportedParameters

List<String> getSupportedParameters()

Get the names of the supported parameters.

Returns:

parameters names

Since:

7.1

getFreeParameters

List<String> getFreeParameters()

Get the free parameters used to build the propagator.

Returns:

free parameters used when building the propagator

Since:

7.1

getParameter

double getParameter(String name)
                    throws OrekitIllegalArgumentException

Get parameter value from its name.

Parameters:

name - parameter name

Returns:

parameter value

Throws:

OrekitIllegalArgumentException - if parameter is not supported

setParameter

void setParameter(String name,
                double value)
                  throws OrekitIllegalArgumentException

Set parameter value from its name.

Parameters:

name - parameter name

value - parameter value

Throws:

OrekitIllegalArgumentException - if parameter is not supported