Package org.orekit.propagation.relative

Class AbstractRelativeProvider

java.lang.Object

org.orekit.propagation.relative.AbstractRelativeProvider

All Implemented Interfaces:

AdditionalDataProvider<double[]>, RelativeProvider

Direct Known Subclasses:

ClohessyWiltshireProvider, YamanakaAnkersenProvider

public abstract class AbstractRelativeProvider
extends Object
implements RelativeProvider

Abstraction class for RelativeProvider.

Since:

14.0

Author:

Romain Cuvillon

Constructor Summary

Constructors

Constructor	Description
AbstractRelativeProvider(Orbit targetOrbit, String additionalEquationsName, LOF lof)	Builds a new RelativeProvider object from the target orbit and additionalEquationsName.
AbstractRelativeProvider(Orbit targetOrbit, TimeStampedPVCoordinates initialChaserPVTLof, String additionalEquationsName, LOF lof)	Builds a new RelativeProvider object from the target orbit and an initial PVT of the chaser.
AbstractRelativeProvider(Orbit targetOrbit, TimeStampedPVCoordinates initialChaserPVT, Frame inputPVTFrame, String additionalEquationsName, LOF lof)	Builds a new RelativeProvider object from the target orbit and an initial PVT of the chaser expressed in the given input frame.

Method Summary

Modifier and Type	Method	Description
TimeStampedPVCoordinates	getInitialChaserPVTLof()	Get the initial TimeStampedPVCoordinates of the chaser in the Local Orbital Frame of the target.
LOF	getLof()	Returns the LOF used by the provider.
String	getName()	Get the name of the additional data.
Orbit	getTargetOrbit()	Get orbit of the target.
void	setInitialChaserPVTLof(TimeStampedPVCoordinates initialChaserPVTLof)	Set the initial TimeStampedPVCoordinates of the chaser in the Local Orbital Frame of the target.
void	setTargetOrbit(Orbit targetOrbit)	Set orbit of the target.

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.AdditionalDataProvider

init, update, yields

Methods inherited from interface org.orekit.propagation.relative.RelativeProvider

extractChaserPVT, extractChaserPVT, getAdditionalData, setTargetTrueAnomaly

Constructor Details

AbstractRelativeProvider

public AbstractRelativeProvider(Orbit targetOrbit,
 TimeStampedPVCoordinates initialChaserPVTLof,
 String additionalEquationsName,
 LOF lof)

Builds a new RelativeProvider object from the target orbit and an initial PVT of the chaser.

Parameters:

targetOrbit - Target orbit

initialChaserPVTLof - Chaser PVT in the target's local orbital frame

additionalEquationsName - Additional equations name

lof - Local Orbital Frame

AbstractRelativeProvider

public AbstractRelativeProvider(Orbit targetOrbit,
 String additionalEquationsName,
 LOF lof)

Builds a new RelativeProvider object from the target orbit and additionalEquationsName.

Parameters:

targetOrbit - Target orbit

additionalEquationsName - Additional equations name

lof - Local Orbital Frame

AbstractRelativeProvider

public AbstractRelativeProvider(Orbit targetOrbit,
 TimeStampedPVCoordinates initialChaserPVT,
 Frame inputPVTFrame,
 String additionalEquationsName,
 LOF lof)

Builds a new RelativeProvider object from the target orbit and an initial PVT of the chaser expressed in the given input frame.

Parameters:

targetOrbit - Target orbit

initialChaserPVT - Chaser PVT in the input Frame

inputPVTFrame - Input frame for the initial chaser PVT

additionalEquationsName - Additional equations name

lof - Local Orbital Frame

Method Details

getLof

public LOF getLof()

Returns the LOF used by the provider..

Specified by:

getLof in interface RelativeProvider

Returns:

the LOF used by the provider

setInitialChaserPVTLof

public void setInitialChaserPVTLof(TimeStampedPVCoordinates initialChaserPVTLof)

Set the initial TimeStampedPVCoordinates of the chaser in the Local Orbital Frame of the target..

Specified by:

setInitialChaserPVTLof in interface RelativeProvider

Parameters:

initialChaserPVTLof - initial TimeStampedPVCoordinates of the chaser in target's LOF

getInitialChaserPVTLof

public TimeStampedPVCoordinates getInitialChaserPVTLof()

Description copied from interface: RelativeProvider

Get the initial TimeStampedPVCoordinates of the chaser in the Local Orbital Frame of the target.

Specified by:

getInitialChaserPVTLof in interface RelativeProvider

Returns:

initial TimeStampedPVCoordinates of the chaser in target's LOF

getName

public String getName()

Description copied from interface: AdditionalDataProvider

Get the name of the additional data.

If a provider just modifies one of the basic elements (orbit, attitude or mass) without adding any new data, it should return the empty string as its name.

Specified by:

getName in interface AdditionalDataProvider<double[]>

Returns:

name of the additional data (names containing "orekit" with any case are reserved for the library internal use)

getTargetOrbit

public Orbit getTargetOrbit()

Get orbit of the target..

Specified by:

getTargetOrbit in interface RelativeProvider

Returns:

orbit of the target

setTargetOrbit

public void setTargetOrbit(Orbit targetOrbit)

Set orbit of the target..

Specified by:

setTargetOrbit in interface RelativeProvider

Parameters:

targetOrbit - orbit of the target