org.orekit.propagation.conversion

Class NumericalPropagatorBuilder

java.lang.Object

org.orekit.propagation.conversion.NumericalPropagatorBuilder

All Implemented Interfaces:

Parameterizable, ParameterizedODE, PropagatorBuilder

public class NumericalPropagatorBuilder
extends Object
implements PropagatorBuilder

Builder for numerical propagator.

Since:

6.0

Author:

Pascal Parraud

Constructor Summary

Constructors

Constructor and Description
NumericalPropagatorBuilder(double mu, Frame frame, FirstOrderIntegratorBuilder builder) Build a new instance.

Method Summary

Methods

Modifier and Type	Method and Description
void	addForceModel(ForceModel model) Add a force model to the global perturbation model.
NumericalPropagator	buildPropagator(AbsoluteDate date, double[] parameters) Build a propagator.
Frame	getFrame() Get the frame in which the orbit is propagated.
double	getParameter(String name)
Collection<String>	getParametersNames()
boolean	isSupported(String name)
void	setAttitudeProvider(AttitudeProvider attitudeProvider) Set the attitude provider.
void	setFreeParameters(Collection<String> parameters) Set the free parameters in order to build the propagator.
void	setMass(double mass) Set the initial mass.
void	setParameter(String name, double value)

Methods inherited from class java.lang.Object

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

Constructor Detail

NumericalPropagatorBuilder

public NumericalPropagatorBuilder(double mu,
                          Frame frame,
                          FirstOrderIntegratorBuilder builder)

Build a new instance.

Parameters:

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

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

builder - first order integrator builder

Method Detail

setAttitudeProvider

public void setAttitudeProvider(AttitudeProvider attitudeProvider)

Set the attitude provider.

Parameters:

attitudeProvider - attitude provider

setMass

public void setMass(double mass)

Set the initial mass.

Parameters:

mass - the mass (kg)

addForceModel

public void addForceModel(ForceModel model)

Add a force model to the global perturbation model.

If this method is not called at all, the integrated orbit will follow a keplerian evolution only.

Parameters:

model - perturbing ForceModel to add

buildPropagator

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

Build a propagator.

Specified by:

buildPropagator in interface PropagatorBuilder

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

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

setFreeParameters

public void setFreeParameters(Collection<String> parameters)
                       throws IllegalArgumentException

Set the free parameters in order to build the propagator.

The parameters must belong to the list returned by Parameterizable.getParametersNames()

Specified by:

setFreeParameters in interface PropagatorBuilder

Parameters:

parameters - free parameters to set when building the propagator

Throws:

IllegalArgumentException

getParametersNames

public Collection<String> getParametersNames()

Specified by:

getParametersNames in interface Parameterizable

isSupported

public boolean isSupported(String name)

Specified by:

isSupported in interface Parameterizable

getParameter

public double getParameter(String name)
                    throws IllegalArgumentException

Specified by:

getParameter in interface ParameterizedODE

Throws:

IllegalArgumentException

setParameter

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

Specified by:

setParameter in interface ParameterizedODE

Throws:

IllegalArgumentException