Package org.orekit.propagation

Class FieldAbstractStateModifier<T extends CalculusFieldElement<T>>

java.lang.Object

org.orekit.propagation.FieldAbstractStateModifier<T>

Type Parameters:

T - type of the field elements

All Implemented Interfaces:

FieldAdditionalDataProvider<T[],T>

public abstract class FieldAbstractStateModifier<T extends CalculusFieldElement<T>>
extends Object
implements FieldAdditionalDataProvider<T[],T>

Abstract base class for modifying state during propagation.

This class is a specialized implementation of FieldAdditionalDataProvider with a name set to the empty string and returning a null additional data.

Beware that changing the state undercover from the propagator may have many side effects. Using this class should therefore be done cautiously.

Since:

12.1

Author:

Luc Maisonobe

See Also:

Propagator, FieldAdditionalDataProvider

Constructor Summary

Constructors

Constructor	Description
FieldAbstractStateModifier()

Method Summary

Modifier and Type	Method	Description
abstract FieldSpacecraftState<T>	change(FieldSpacecraftState<T> state)	Change main state.
T[]	getAdditionalData(FieldSpacecraftState<T> state)	Get the additional data.
String	getName()	Get the name of the additional data.
FieldSpacecraftState<T>	update(FieldSpacecraftState<T> state)	Update a state.

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, yields

Constructor Detail

FieldAbstractStateModifier

public FieldAbstractStateModifier()

Method Detail

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)

getAdditionalData

public T[] getAdditionalData(FieldSpacecraftState<T> state)

Get the additional data.

Specified by:

getAdditionalData in interface FieldAdditionalDataProvider<T extends CalculusFieldElement<T>[],T extends CalculusFieldElement<T>>

Parameters:

state - spacecraft state to which additional data should correspond

Returns:

additional data corresponding to spacecraft state

update

public FieldSpacecraftState<T> update(FieldSpacecraftState<T> state)

Update a state.

Specified by:

update in interface FieldAdditionalDataProvider<T extends CalculusFieldElement<T>[],T extends CalculusFieldElement<T>>

Parameters:

state - spacecraft state to update

Returns:

updated state

change

public abstract FieldSpacecraftState<T> change(FieldSpacecraftState<T> state)

Change main state.

Parameters:

state - spacecraft state to change

Returns:

changed state