org.orekit.propagation.conversion

Class AbstractPropagatorBuilder

java.lang.Object

org.orekit.propagation.conversion.AbstractPropagatorBuilder

All Implemented Interfaces:

PropagatorBuilder

Direct Known Subclasses:

EcksteinHechlerPropagatorBuilder, KeplerianPropagatorBuilder, NumericalPropagatorBuilder, TLEPropagatorBuilder

public abstract class AbstractPropagatorBuilder
extends Object
implements PropagatorBuilder

Base class for propagator builders.

Since:

7.1

Author:

Pascal Parraud

Constructor Summary

Constructors

Constructor and Description
AbstractPropagatorBuilder(Frame frame, double mu, OrbitType orbitType, PositionAngle positionAngle) Build a new instance.

Method Summary

Methods

Modifier and Type	Method and Description
protected void	addSupportedParameter(String name) Add a supported parameter name.
protected void	checkParameters(double[] parameters) Check the size of the parameters array.
protected Orbit	createInitialOrbit(AbsoluteDate date, double[] parameters) Crate the orbit for the first 6 parameters.
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 PropagatorBuilder.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 PropagatorBuilder.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.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.orekit.propagation.conversion.PropagatorBuilder

buildPropagator

Constructor Detail

AbstractPropagatorBuilder

public AbstractPropagatorBuilder(Frame frame,
                         double mu,
                         OrbitType orbitType,
                         PositionAngle positionAngle)

Build a new instance.

Parameters:

frame - the frame in which the orbit is propagated (must be a pseudo-inertial frame)

mu - central attraction coefficient (m³/s²)

orbitType - orbit type to use

positionAngle - position angle type to use

Since:

7.1

Method Detail

getOrbitType

public OrbitType getOrbitType()

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

Specified by:

getOrbitType in interface PropagatorBuilder

Returns:

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

See Also:

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

getPositionAngle

public PositionAngle getPositionAngle()

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

Specified by:

getPositionAngle in interface PropagatorBuilder

Returns:

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

See Also:

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

getFrame

public Frame getFrame()

Get the frame in which the orbit is propagated.

Specified by:

getFrame in interface PropagatorBuilder

Returns:

frame in which the orbit is propagated

getSupportedParameters

public List<String> getSupportedParameters()

Get the names of the supported parameters.

Specified by:

getSupportedParameters in interface PropagatorBuilder

Returns:

parameters names

setFreeParameters

public 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 PropagatorBuilder.getSupportedParameters()

Specified by:

setFreeParameters in interface PropagatorBuilder

Parameters:

parameters - free parameters to set when building the propagator

Throws:

OrekitIllegalArgumentException - if one of the parameters is not supported

getFreeParameters

public List<String> getFreeParameters()

Get the free parameters used to build the propagator.

Specified by:

getFreeParameters in interface PropagatorBuilder

Returns:

free parameters used when building the propagator

getParameter

public double getParameter(String name)
                    throws OrekitIllegalArgumentException

Get parameter value from its name.

The abstract base class only supports NewtonianAttraction.CENTRAL_ATTRACTION_COEFFICIENT, specialized propagator builders may support more parameters.

Specified by:

getParameter in interface PropagatorBuilder

Parameters:

name - parameter name

Returns:

parameter value

Throws:

OrekitIllegalArgumentException - if parameter is not supported

setParameter

public void setParameter(String name,
                double value)
                  throws OrekitIllegalArgumentException

Set parameter value from its name.

The abstract base class only supports NewtonianAttraction.CENTRAL_ATTRACTION_COEFFICIENT, specialized propagator builders may support more parameters.

Specified by:

setParameter in interface PropagatorBuilder

Parameters:

name - parameter name

value - parameter value

Throws:

OrekitIllegalArgumentException - if parameter is not supported

checkParameters

protected void checkParameters(double[] parameters)
                        throws OrekitIllegalArgumentException

Check the size of the parameters array.

Parameters:

parameters - to configure the propagator

Throws:

OrekitIllegalArgumentException - if the number of parameters is not 6 (for initial state) plus the number of free parameters

createInitialOrbit

protected Orbit createInitialOrbit(AbsoluteDate date,
                       double[] parameters)

Crate the orbit for the first 6 parameters.

Parameters:

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

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

Returns:

initial orbit

addSupportedParameter

protected void addSupportedParameter(String name)
                              throws OrekitIllegalArgumentException

Add a supported parameter name.

Parameters:

name - name of a supported parameter

Throws:

OrekitIllegalArgumentException - if the name is already supported