Package org.orekit.orbits

Class AbstractOrbitalParameterFactory<P extends OrbitalParameters>

java.lang.Object

org.orekit.orbits.AbstractOrbitalParameterFactory<P>

Type Parameters:

P - type of the orbital parameters

All Implemented Interfaces:

Cloneable, OrbitalParameterFactory<P>

Direct Known Subclasses:

AbstractOrbitFactory, GNSSOrbitalElementsFactory, TleGenerationAlgorithm

public abstract class AbstractOrbitalParameterFactory<P extends OrbitalParameters>
extends Object
implements OrbitalParameterFactory<P>

Factory for orbital parameters.

Since:

14.0

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractOrbitalParameterFactory(OrbitType orbitType, ParameterDriversList orbitalDrivers, Frame frame, PositionAngleType positionAngleType, AbsoluteDate date, double mu)	Simple constructor.

Method Summary

Modifier and Type	Method	Description
AbstractOrbitalParameterFactory<P>	clone()
AbsoluteDate	getDate()	Get the date of the orbital parameters.
Frame	getFrame()	Get the frame in which the orbit is propagated.
RealMatrix	getJacobianWrtCartesian()	Get the Jacobian of the orbital parameters with respect to the Cartesian coordinates.
double	getMu()	Get the central attraction coefficient (µ - m³/s²) value.
ParameterDriversList	getNonKeplerianParametersDrivers()	Get the drivers for additional drivers for non-Keplerian motion.
ParameterDriversList	getOrbitalParametersDrivers()	Get the drivers for orbital parameters.
OrbitType	getOrbitType()	Get the orbit type to use.
PositionAngleType	getPositionAngleType()	Get the position angle type to use.
void	reset(Orbit orbit)	Reset the drivers to match specified orbit.
void	setDate(AbsoluteDate date)	Set the date of the orbital parameters.
void	setFrame(Frame frame)	Set the frame in which the orbit is propagated.
void	setMu(double mu)	Set the central attraction coefficient (µ - m³/s²) value.
void	setPositionAngleType(PositionAngleType positionAngleType)	Set the position angle type to use.
protected abstract double[]	toArray(Orbit orbit)	Convert an input into an array suitable to feed orbital parameters drivers.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.orekit.orbits.OrbitalParameterFactory

createFromDrivers, getJacobianWrtParameters

Constructor Details

AbstractOrbitalParameterFactory

protected AbstractOrbitalParameterFactory(OrbitType orbitType,
 ParameterDriversList orbitalDrivers,
 Frame frame,
 PositionAngleType positionAngleType,
 AbsoluteDate date,
 double mu)

Simple constructor.

Parameters:

orbitType - orbit type

orbitalDrivers - drivers for orbital parameters

frame - frame in which the orbital parameters are defined

positionAngleType - position angle type to use

date - date of the orbital parameters

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

Method Details

getOrbitType

public OrbitType getOrbitType()

Get the orbit type to use.

Specified by:

getOrbitType in interface OrbitalParameterFactory<P extends OrbitalParameters>

Returns:

orbit type to use

getOrbitalParametersDrivers

public ParameterDriversList getOrbitalParametersDrivers()

Get the drivers for orbital parameters.

There are always exactly 6 drivers for orbital parameters that correspond to Keplerian motion. Some orbital parameters have additional drivers for non-Keplerian motion (TLE has a M2 parameter, GNSS orbital elements have Δa, iDot…) These additional drivers are not included here, they are provided by OrbitalParameterFactory.getNonKeplerianParametersDrivers().

Specified by:

getOrbitalParametersDrivers in interface OrbitalParameterFactory<P extends OrbitalParameters>

Returns:

drivers for orbital parameters

getNonKeplerianParametersDrivers

public ParameterDriversList getNonKeplerianParametersDrivers()

Get the drivers for additional drivers for non-Keplerian motion.

Specified by:

getNonKeplerianParametersDrivers in interface OrbitalParameterFactory<P extends OrbitalParameters>

Returns:

drivers for non-Keplerian motion

getDate

public AbsoluteDate getDate()

Get the date of the orbital parameters.

Specified by:

getDate in interface OrbitalParameterFactory<P extends OrbitalParameters>

Returns:

date of the orbital parameters

setDate

public void setDate(AbsoluteDate date)

Set the date of the orbital parameters.

Specified by:

setDate in interface OrbitalParameterFactory<P extends OrbitalParameters>

Parameters:

date - date of the orbital parameters

getFrame

public Frame getFrame()

Get the frame in which the orbit is propagated.

Specified by:

getFrame in interface OrbitalParameterFactory<P extends OrbitalParameters>

Returns:

frame in which the orbit is propagated

setFrame

public void setFrame(Frame frame)

Set the frame in which the orbit is propagated.

Specified by:

setFrame in interface OrbitalParameterFactory<P extends OrbitalParameters>

Parameters:

frame - frame in which the orbit is propagated

getPositionAngleType

public PositionAngleType getPositionAngleType()

Get the position angle type to use.

Specified by:

getPositionAngleType in interface OrbitalParameterFactory<P extends OrbitalParameters>

Returns:

position angle type to use

setPositionAngleType

public void setPositionAngleType(PositionAngleType positionAngleType)

Set the position angle type to use.

Specified by:

setPositionAngleType in interface OrbitalParameterFactory<P extends OrbitalParameters>

Parameters:

positionAngleType - position angle type to use

getMu

public double getMu()

Get the central attraction coefficient (µ - m³/s²) value.

Specified by:

getMu in interface OrbitalParameterFactory<P extends OrbitalParameters>

Returns:

the central attraction coefficient (µ - m³/s²) value

setMu

public void setMu(double mu)

Set the central attraction coefficient (µ - m³/s²) value.

Specified by:

setMu in interface OrbitalParameterFactory<P extends OrbitalParameters>

Parameters:

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

reset

public void reset(Orbit orbit)

Reset the drivers to match specified orbit.

All of date, mu, and drivers values will be reset, but neither the frame nor the type of orbital parameters generated by OrbitalParameterFactory.createFromDrivers() will be reset.

The specified orbit does not need to match the type of orbital parameters managed by the factory. Conversion will be applied if needed.

Specified by:

reset in interface OrbitalParameterFactory<P extends OrbitalParameters>

Parameters:

orbit - orbit to be matched

getJacobianWrtCartesian

public RealMatrix getJacobianWrtCartesian()

Get the Jacobian of the orbital parameters with respect to the Cartesian coordinates.

This is the inverse of OrbitalParameterFactory.getJacobianWrtParameters(), and it is evaluated under the very same conditions..

This implementation inverts OrbitalParameterFactory.getJacobianWrtParameters() numerically, using the same decomposition as Orbit does for its own Jacobian matrices.

Specified by:

getJacobianWrtCartesian in interface OrbitalParameterFactory<P extends OrbitalParameters>

Returns:

jacobian matrix dB/dC, where B are the orbital parameters this factory is built upon and C the Cartesian coordinates

toArray

protected abstract double[] toArray(Orbit orbit)

Convert an input into an array suitable to feed orbital parameters drivers.

Parameters:

orbit - orbit to convert

Returns:

arrays corresponding to orbit

clone

public AbstractOrbitalParameterFactory<P> clone()

Overrides:

clone in class Object