Package org.orekit.propagation

Class AbstractStateModifier

java.lang.Object

org.orekit.propagation.AbstractStateModifier

All Implemented Interfaces:

AdditionalDataProvider<double[]>

public abstract class AbstractStateModifier
extends Object
implements AdditionalDataProvider<double[]>

Abstract base class for modifying state during propagation.

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

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

Constructor Summary

Constructors

Constructor	Description
AbstractStateModifier()

Method Summary

Modifier and Type	Method	Description
abstract SpacecraftState	change(SpacecraftState state)	Change main state.
double[]	getAdditionalData(SpacecraftState state)	Get the additional data.
String	getName()	Get the name of the additional data.
SpacecraftState	update(SpacecraftState 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.AdditionalDataProvider

init, yields

Constructor Details

AbstractStateModifier

public AbstractStateModifier()

Method Details

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 AdditionalDataProvider<double[]>

Returns:

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

getAdditionalData

public double[] getAdditionalData(SpacecraftState state)

Get the additional data.

Specified by:

getAdditionalData in interface AdditionalDataProvider<double[]>

Parameters:

state - spacecraft state to which additional data should correspond

Returns:

additional state corresponding to spacecraft state

update

public SpacecraftState update(SpacecraftState state)

Update a state.

Specified by:

update in interface AdditionalDataProvider<double[]>

Parameters:

state - spacecraft state to update

Returns:

updated state

change

public abstract SpacecraftState change(SpacecraftState state)

Change main state.

Parameters:

state - spacecraft state to change

Returns:

changed state