Package org.orekit.propagation.relative

Class FieldAbstractRelativeProvider<T extends CalculusFieldElement<T>>

java.lang.Object

org.orekit.propagation.relative.FieldAbstractRelativeProvider<T>

Type Parameters:

T - Any scalar field.

All Implemented Interfaces:

FieldAdditionalDataProvider<T[],T>, FieldRelativeProvider<T>

Direct Known Subclasses:

FieldClohessyWiltshireProvider, FieldYamanakaAnkersenProvider

public abstract class FieldAbstractRelativeProvider<T extends CalculusFieldElement<T>>
extends Object
implements FieldRelativeProvider<T>

Abstraction class for Field RelativeProvider.

Since:

14.0

Author:

Romain Cuvillon

Constructor Summary

Constructors

Constructor	Description
FieldAbstractRelativeProvider(FieldOrbit<T> targetOrbit, TimeStampedFieldPVCoordinates<T> initialChaserPVTLof, String additionalEquationsName, LOF lof)	Builds a new RelativeProvider object from the target orbit and an initial PVT of the chaser.
FieldAbstractRelativeProvider(FieldOrbit<T> targetOrbit, TimeStampedFieldPVCoordinates<T> 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
TimeStampedFieldPVCoordinates<T>	getInitialChaserPVTLof()	Get the initial TimeStampedPVCoordinates of the chaser in the Local Orbital Frame of the target.
LOF	getLof()	Returns the LOF type used by the provider.
String	getName()	Get the name of the additional data.
FieldOrbit<T>	getTargetOrbit()	Get the target Orbit.
void	setInitialChaserPVTLof(TimeStampedFieldPVCoordinates<T> initialChaserPVTLof)	Set the initial TimeStampedPVCoordinates of the chaser in the Local Orbital Frame of the target.
void	setTargetOrbit(FieldOrbit<T> targetOrbit)	Set the target orbit.

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

init, update, yields

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

extractChaserPVT, extractChaserPVT, getAdditionalData, setTargetTrueAnomaly

Constructor Details

FieldAbstractRelativeProvider

public FieldAbstractRelativeProvider(FieldOrbit<T> targetOrbit,
 TimeStampedFieldPVCoordinates<T> 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

FieldAbstractRelativeProvider

public FieldAbstractRelativeProvider(FieldOrbit<T> targetOrbit,
 TimeStampedFieldPVCoordinates<T> 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. Should be circular for better results

initialChaserPVT - Chaser PVT in given 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 type used by the provider..

Specified by:

getLof in interface FieldRelativeProvider<T extends CalculusFieldElement<T>>

Returns:

the LOF used by the provider.

setInitialChaserPVTLof

public void setInitialChaserPVTLof(TimeStampedFieldPVCoordinates<T> initialChaserPVTLof)

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

Specified by:

setInitialChaserPVTLof in interface FieldRelativeProvider<T extends CalculusFieldElement<T>>

Parameters:

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

getInitialChaserPVTLof

public TimeStampedFieldPVCoordinates<T> getInitialChaserPVTLof()

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

Specified by:

getInitialChaserPVTLof in interface FieldRelativeProvider<T extends CalculusFieldElement<T>>

Returns:

initial TimeStampedPVCoordinates of the chaser in target's LOF

getName

public String getName()

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 FieldAdditionalDataProvider<T extends CalculusFieldElement<T>[],T extends CalculusFieldElement<T>>

Returns:

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

getTargetOrbit

public FieldOrbit<T> getTargetOrbit()

Get the target Orbit..

Specified by:

getTargetOrbit in interface FieldRelativeProvider<T extends CalculusFieldElement<T>>

Returns:

orbit of the target

setTargetOrbit

public void setTargetOrbit(FieldOrbit<T> targetOrbit)

Set the target orbit..

Specified by:

setTargetOrbit in interface FieldRelativeProvider<T extends CalculusFieldElement<T>>

Parameters:

targetOrbit - orbit of the target