FieldSpacecraftState (ORbit Extrapolation KIT 11.1.2 API)

java.lang.Object
- org.orekit.propagation.FieldSpacecraftState<T>

All Implemented Interfaces:

FieldTimeInterpolable<FieldSpacecraftState<T>,T>, FieldTimeShiftable<FieldSpacecraftState<T>,T>, FieldTimeStamped<T>
```
public class FieldSpacecraftState<T extends CalculusFieldElement<T>>
extends Object
implements FieldTimeStamped<T>, FieldTimeShiftable<FieldSpacecraftState<T>,T>, FieldTimeInterpolable<FieldSpacecraftState<T>,T>
```
This class is the representation of a complete state holding orbit, attitude and mass information at a given date.
It contains an orbital state at a current FieldAbsoluteDate both handled by an FieldOrbit, plus the current mass and attitude. FieldOrbit and state are guaranteed to be consistent in terms of date and reference frame. The spacecraft state may also contain additional states, which are simply named double arrays which can hold any user-defined data.

The state can be slightly shifted to close dates. This shift is based on a simple Keplerian model for orbit, a linear extrapolation for attitude taking the spin rate into account and no mass change. It is not intended as a replacement for proper orbit and attitude propagation but should be sufficient for either small time shifts or coarse accuracy.

The instance FieldSpacecraftState is guaranteed to be immutable.

Author:

Fabien Maussion, Véronique Pommier-Maurussane, Luc Maisonobe, Vincent Mouraux

See Also:

NumericalPropagator

Constructor Summary

Constructors
Constructor and Description
`FieldSpacecraftState(Field<T> field, SpacecraftState state)` Convert a `FieldSpacecraftState`.
`FieldSpacecraftState(FieldAbsolutePVCoordinates<T> absPva)` Build a spacecraft state from orbit only.
`FieldSpacecraftState(FieldAbsolutePVCoordinates<T> absPva, FieldArrayDictionary<T> additional)` Build a spacecraft state from orbit only.
`FieldSpacecraftState(FieldAbsolutePVCoordinates<T> absPva, FieldAttitude<T> attitude)` Build a spacecraft state from orbit and attitude.
`FieldSpacecraftState(FieldAbsolutePVCoordinates<T> absPva, FieldAttitude<T> attitude, FieldArrayDictionary<T> additional)` Build a spacecraft state from orbit and attitude.
`FieldSpacecraftState(FieldAbsolutePVCoordinates<T> absPva, FieldAttitude<T> attitude, Map<String,T[]> additional)` Deprecated. as of 11.1, replaced by `FieldSpacecraftState(FieldAbsolutePVCoordinates, FieldAttitude, FieldArrayDictionary)`
`FieldSpacecraftState(FieldAbsolutePVCoordinates<T> absPva, FieldAttitude<T> attitude, T mass)` Build a spacecraft state from orbit, attitude and mass.
`FieldSpacecraftState(FieldAbsolutePVCoordinates<T> absPva, FieldAttitude<T> attitude, T mass, FieldArrayDictionary<T> additional)` Build a spacecraft state from orbit, attitude and mass.
`FieldSpacecraftState(FieldAbsolutePVCoordinates<T> absPva, FieldAttitude<T> attitude, T mass, FieldArrayDictionary<T> additional, FieldArrayDictionary<T> additionalDot)` Build a spacecraft state from orbit, attitude and mass.
`FieldSpacecraftState(FieldAbsolutePVCoordinates<T> absPva, FieldAttitude<T> attitude, T mass, Map<String,T[]> additional)` Deprecated. as of 11.1, replaced by `FieldSpacecraftState(FieldAbsolutePVCoordinates, FieldAttitude, CalculusFieldElement, FieldArrayDictionary)`
`FieldSpacecraftState(FieldAbsolutePVCoordinates<T> absPva, Map<String,T[]> additional)` Deprecated. as of 11.1, replaced by `FieldSpacecraftState(FieldAbsolutePVCoordinates, FieldArrayDictionary)`
`FieldSpacecraftState(FieldAbsolutePVCoordinates<T> absPva, T mass)` Create a new instance from orbit and mass.
`FieldSpacecraftState(FieldAbsolutePVCoordinates<T> absPva, T mass, FieldArrayDictionary<T> additional)` Create a new instance from orbit and mass.
`FieldSpacecraftState(FieldAbsolutePVCoordinates<T> absPva, T mass, Map<String,T[]> additional)` Deprecated. as of 11.1, replaced by `FieldSpacecraftState(FieldAbsolutePVCoordinates, CalculusFieldElement, FieldArrayDictionary)`
`FieldSpacecraftState(FieldOrbit<T> orbit)` Build a spacecraft state from orbit only.
`FieldSpacecraftState(FieldOrbit<T> orbit, FieldArrayDictionary<T> additional)` Build a spacecraft state from orbit and additional states.
`FieldSpacecraftState(FieldOrbit<T> orbit, FieldAttitude<T> attitude)` Build a spacecraft state from orbit and attitude.
`FieldSpacecraftState(FieldOrbit<T> orbit, FieldAttitude<T> attitude, FieldArrayDictionary<T> additional)` Build a spacecraft state from orbit attitude and additional states.
`FieldSpacecraftState(FieldOrbit<T> orbit, FieldAttitude<T> attitude, Map<String,T[]> additional)` Deprecated. as of 11.1, replaced by `FieldSpacecraftState(FieldOrbit, FieldAttitude, FieldArrayDictionary)`
`FieldSpacecraftState(FieldOrbit<T> orbit, FieldAttitude<T> attitude, T mass)` Build a spacecraft state from orbit, attitude and mass.
`FieldSpacecraftState(FieldOrbit<T> orbit, FieldAttitude<T> attitude, T mass, FieldArrayDictionary<T> additional)` Build a spacecraft state from orbit, attitude, mass and additional states.
`FieldSpacecraftState(FieldOrbit<T> orbit, FieldAttitude<T> attitude, T mass, FieldArrayDictionary<T> additional, FieldArrayDictionary<T> additionalDot)` Build a spacecraft state from orbit, attitude, mass, additional states and derivatives.
`FieldSpacecraftState(FieldOrbit<T> orbit, FieldAttitude<T> attitude, T mass, Map<String,T[]> additional)` Deprecated. as of 11.1, replaced by `FieldSpacecraftState(FieldOrbit, FieldAttitude, CalculusFieldElement, FieldArrayDictionary)`
`FieldSpacecraftState(FieldOrbit<T> orbit, Map<String,T[]> additional)` Deprecated. as of 11.1, replacezd by `FieldSpacecraftState(FieldOrbit, FieldArrayDictionary)`
`FieldSpacecraftState(FieldOrbit<T> orbit, T mass)` Create a new instance from orbit and mass.
`FieldSpacecraftState(FieldOrbit<T> orbit, T mass, FieldArrayDictionary<T> additional)` Create a new instance from orbit, mass and additional states.
`FieldSpacecraftState(FieldOrbit<T> orbit, T mass, Map<String,T[]> additional)` Deprecated. as of 11.1, replaced by `FieldSpacecraftState(FieldOrbit, CalculusFieldElement, FieldArrayDictionary)`

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`FieldSpacecraftState<T>`	`addAdditionalState(String name, T... value)` Add an additional state.
`FieldSpacecraftState<T>`	`addAdditionalStateDerivative(String name, T... value)` Add an additional state derivative.
`void`	`ensureCompatibleAdditionalStates(FieldSpacecraftState<T> state)` Check if two instances have the same set of additional states available.
`T`	`getA()` Get the semi-major axis.
`FieldAbsolutePVCoordinates<T>`	`getAbsPVA()` Get the absolute position-velocity-acceleration.
`T[]`	`getAdditionalState(String name)` Get an additional state.
`T[]`	`getAdditionalStateDerivative(String name)` Get an additional state derivative.
`Map<String,T[]>`	`getAdditionalStates()` Deprecated. as of 11.1, replaced by `getAdditionalStatesValues()`
`FieldArrayDictionary<T>`	`getAdditionalStatesDerivatives()` Get an unmodifiable map of additional states derivatives.
`FieldArrayDictionary<T>`	`getAdditionalStatesValues()` Get an unmodifiable map of additional states.
`FieldAttitude<T>`	`getAttitude()` Get the attitude.
`FieldAbsoluteDate<T>`	`getDate()` Get the date.
`T`	`getE()` Get the eccentricity.
`T`	`getEquinoctialEx()` Get the first component of the eccentricity vector (as per equinoctial parameters).
`T`	`getEquinoctialEy()` Get the second component of the eccentricity vector (as per equinoctial parameters).
`Frame`	`getFrame()` Get the defining frame.
`T`	`getHx()` Get the first component of the inclination vector (as per equinoctial parameters).
`T`	`getHy()` Get the second component of the inclination vector (as per equinoctial parameters).
`T`	`getI()` Get the inclination.
`T`	`getKeplerianMeanMotion()` Get the Keplerian mean motion.
`T`	`getKeplerianPeriod()` Get the Keplerian period.
`T`	`getLE()` Get the eccentric latitude argument (as per equinoctial parameters).
`T`	`getLM()` Get the mean longitude argument (as per equinoctial parameters).
`T`	`getLv()` Get the true latitude argument (as per equinoctial parameters).
`T`	`getMass()` Gets the current mass.
`T`	`getMu()` Get the central attraction coefficient.
`FieldOrbit<T>`	`getOrbit()` Get the current orbit.
`TimeStampedFieldPVCoordinates<T>`	`getPVCoordinates()` Get the `TimeStampedFieldPVCoordinates` in orbit definition frame.
`TimeStampedFieldPVCoordinates<T>`	`getPVCoordinates(Frame outputFrame)` Get the `TimeStampedFieldPVCoordinates` in given output frame.
`boolean`	`hasAdditionalState(String name)` Check if an additional state is available.
`boolean`	`hasAdditionalStateDerivative(String name)` Check if an additional state derivative is available.
`FieldSpacecraftState<T>`	`interpolate(FieldAbsoluteDate<T> date, Stream<FieldSpacecraftState<T>> sample)` Get an interpolated instance.
`boolean`	`isOrbitDefined()` Check if the state contains an orbit part.
`FieldSpacecraftState<T>`	`shiftedBy(double dt)` Get a time-shifted state.
`FieldSpacecraftState<T>`	`shiftedBy(T dt)` Get a time-shifted state.
`SpacecraftState`	`toSpacecraftState()` To convert a FieldSpacecraftState instance into a SpacecraftState instance.
`String`	`toString()`
`FieldTransform<T>`	`toTransform()` Compute the transform from state defining frame to spacecraft frame.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.orekit.time.FieldTimeInterpolable
interpolate

- Constructor Detail
  - FieldSpacecraftState
```
public FieldSpacecraftState(FieldOrbit<T> orbit)
```
    Build a spacecraft state from orbit only.
    FieldAttitude and mass are set to unspecified non-null arbitrary values.
    
    Parameters:
    
    orbit - the orbit
  - FieldSpacecraftState
```
public FieldSpacecraftState(FieldOrbit<T> orbit,
                            FieldAttitude<T> attitude)
                     throws IllegalArgumentException
```
    Build a spacecraft state from orbit and attitude.
    Mass is set to an unspecified non-null arbitrary value.
    
    Parameters:
    
    orbit - the orbit
    
    attitude - attitude
    
    Throws:
    
    IllegalArgumentException - if orbit and attitude dates or frames are not equal
  - FieldSpacecraftState
```
public FieldSpacecraftState(FieldOrbit<T> orbit,
                            T mass)
```
    Create a new instance from orbit and mass.
    FieldAttitude law is set to an unspecified default attitude.
    
    Parameters:
    
    orbit - the orbit
    
    mass - the mass (kg)
  - FieldSpacecraftState
```
public FieldSpacecraftState(FieldOrbit<T> orbit,
                            FieldAttitude<T> attitude,
                            T mass)
                     throws IllegalArgumentException
```
    Build a spacecraft state from orbit, attitude and mass.
    
    Parameters:
    
    orbit - the orbit
    
    attitude - attitude
    
    mass - the mass (kg)
    
    Throws:
    
    IllegalArgumentException - if orbit and attitude dates or frames are not equal
  - FieldSpacecraftState
```
@Deprecated
public FieldSpacecraftState(FieldOrbit<T> orbit,
                                        Map<String,T[]> additional)
```
    Deprecated. as of 11.1, replacezd by FieldSpacecraftState(FieldOrbit, FieldArrayDictionary)
    
    Build a spacecraft state from orbit and additional states.
    FieldAttitude and mass are set to unspecified non-null arbitrary values.
    
    Parameters:
    
    orbit - the orbit
    
    additional - additional states
  - FieldSpacecraftState
```
public FieldSpacecraftState(FieldOrbit<T> orbit,
                            FieldArrayDictionary<T> additional)
```
    Build a spacecraft state from orbit and additional states.
    FieldAttitude and mass are set to unspecified non-null arbitrary values.
    
    Parameters:
    
    orbit - the orbit
    
    additional - additional states
    
    Since:
    
    11.1
  - FieldSpacecraftState
```
@Deprecated
public FieldSpacecraftState(FieldOrbit<T> orbit,
                                        FieldAttitude<T> attitude,
                                        Map<String,T[]> additional)
                                 throws IllegalArgumentException
```
    Deprecated. as of 11.1, replaced by FieldSpacecraftState(FieldOrbit, FieldAttitude, FieldArrayDictionary)
    
    Build a spacecraft state from orbit attitude and additional states.
    Mass is set to an unspecified non-null arbitrary value.
    
    Parameters:
    
    orbit - the orbit
    
    attitude - attitude
    
    additional - additional states
    
    Throws:
    
    IllegalArgumentException - if orbit and attitude dates or frames are not equal
  - FieldSpacecraftState
```
public FieldSpacecraftState(FieldOrbit<T> orbit,
                            FieldAttitude<T> attitude,
                            FieldArrayDictionary<T> additional)
                     throws IllegalArgumentException
```
    Build a spacecraft state from orbit attitude and additional states.
    Mass is set to an unspecified non-null arbitrary value.
    
    Parameters:
    
    orbit - the orbit
    
    attitude - attitude
    
    additional - additional states
    
    Throws:
    
    IllegalArgumentException - if orbit and attitude dates or frames are not equal
    
    Since:
    
    11.1
  - FieldSpacecraftState
```
@Deprecated
public FieldSpacecraftState(FieldOrbit<T> orbit,
                                        T mass,
                                        Map<String,T[]> additional)
```
    Deprecated. as of 11.1, replaced by FieldSpacecraftState(FieldOrbit, CalculusFieldElement, FieldArrayDictionary)
    
    Create a new instance from orbit, mass and additional states.
    FieldAttitude law is set to an unspecified default attitude.
    
    Parameters:
    
    orbit - the orbit
    
    mass - the mass (kg)
    
    additional - additional states
  - FieldSpacecraftState
```
public FieldSpacecraftState(FieldOrbit<T> orbit,
                            T mass,
                            FieldArrayDictionary<T> additional)
```
    Create a new instance from orbit, mass and additional states.
    FieldAttitude law is set to an unspecified default attitude.
    
    Parameters:
    
    orbit - the orbit
    
    mass - the mass (kg)
    
    additional - additional states
    
    Since:
    
    11.1
  - FieldSpacecraftState
```
@Deprecated
public FieldSpacecraftState(FieldOrbit<T> orbit,
                                        FieldAttitude<T> attitude,
                                        T mass,
                                        Map<String,T[]> additional)
```
    Deprecated. as of 11.1, replaced by FieldSpacecraftState(FieldOrbit, FieldAttitude, CalculusFieldElement, FieldArrayDictionary)
    
    Build a spacecraft state from orbit, attitude, mass and additional states.
    
    Parameters:
    
    orbit - the orbit
    
    attitude - attitude
    
    mass - the mass (kg)
    
    additional - additional states (may be null if no additional states are available)
  - FieldSpacecraftState
```
public FieldSpacecraftState(FieldOrbit<T> orbit,
                            FieldAttitude<T> attitude,
                            T mass,
                            FieldArrayDictionary<T> additional)
```
    Build a spacecraft state from orbit, attitude, mass and additional states.
    
    Parameters:
    
    orbit - the orbit
    
    attitude - attitude
    
    mass - the mass (kg)
    
    additional - additional states (may be null if no additional states are available)
    
    Since:
    
    11.1
  - FieldSpacecraftState
```
public FieldSpacecraftState(FieldOrbit<T> orbit,
                            FieldAttitude<T> attitude,
                            T mass,
                            FieldArrayDictionary<T> additional,
                            FieldArrayDictionary<T> additionalDot)
                     throws IllegalArgumentException
```
    Build a spacecraft state from orbit, attitude, mass, additional states and derivatives.
    
    Parameters:
    
    orbit - the orbit
    
    attitude - attitude
    
    mass - the mass (kg)
    
    additional - additional states (may be null if no additional states are available)
    
    additionalDot - additional states derivatives(may be null if no additional states derivative sare available)
    
    Throws:
    
    IllegalArgumentException - if orbit and attitude dates or frames are not equal
    
    Since:
    
    11.1
  - FieldSpacecraftState
```
public FieldSpacecraftState(Field<T> field,
                            SpacecraftState state)
```
    Convert a FieldSpacecraftState.
    
    Parameters:
    
    field - field to which the elements belong
    
    state - state to convert
  - FieldSpacecraftState
```
public FieldSpacecraftState(FieldAbsolutePVCoordinates<T> absPva)
```
    Build a spacecraft state from orbit only.
    Attitude and mass are set to unspecified non-null arbitrary values.
    
    Parameters:
    
    absPva - position-velocity-acceleration
  - FieldSpacecraftState
```
public FieldSpacecraftState(FieldAbsolutePVCoordinates<T> absPva,
                            FieldAttitude<T> attitude)
                     throws IllegalArgumentException
```
    Build a spacecraft state from orbit and attitude.
    Mass is set to an unspecified non-null arbitrary value.
    
    Parameters:
    
    absPva - position-velocity-acceleration
    
    attitude - attitude
    
    Throws:
    
    IllegalArgumentException - if orbit and attitude dates or frames are not equal
  - FieldSpacecraftState
```
public FieldSpacecraftState(FieldAbsolutePVCoordinates<T> absPva,
                            T mass)
```
    Create a new instance from orbit and mass.
    Attitude law is set to an unspecified default attitude.
    
    Parameters:
    
    absPva - position-velocity-acceleration
    
    mass - the mass (kg)
  - FieldSpacecraftState
```
public FieldSpacecraftState(FieldAbsolutePVCoordinates<T> absPva,
                            FieldAttitude<T> attitude,
                            T mass)
                     throws IllegalArgumentException
```
    Build a spacecraft state from orbit, attitude and mass.
    
    Parameters:
    
    absPva - position-velocity-acceleration
    
    attitude - attitude
    
    mass - the mass (kg)
    
    Throws:
    
    IllegalArgumentException - if orbit and attitude dates or frames are not equal
  - FieldSpacecraftState
```
@Deprecated
public FieldSpacecraftState(FieldAbsolutePVCoordinates<T> absPva,
                                        Map<String,T[]> additional)
```
    Deprecated. as of 11.1, replaced by FieldSpacecraftState(FieldAbsolutePVCoordinates, FieldArrayDictionary)
    
    Build a spacecraft state from orbit only.
    Attitude and mass are set to unspecified non-null arbitrary values.
    
    Parameters:
    
    absPva - position-velocity-acceleration
    
    additional - additional states
  - FieldSpacecraftState
```
public FieldSpacecraftState(FieldAbsolutePVCoordinates<T> absPva,
                            FieldArrayDictionary<T> additional)
```
    Build a spacecraft state from orbit only.
    Attitude and mass are set to unspecified non-null arbitrary values.
    
    Parameters:
    
    absPva - position-velocity-acceleration
    
    additional - additional states
    
    Since:
    
    11.1
  - FieldSpacecraftState
```
@Deprecated
public FieldSpacecraftState(FieldAbsolutePVCoordinates<T> absPva,
                                        FieldAttitude<T> attitude,
                                        Map<String,T[]> additional)
                                 throws IllegalArgumentException
```
    Deprecated. as of 11.1, replaced by FieldSpacecraftState(FieldAbsolutePVCoordinates, FieldAttitude, FieldArrayDictionary)
    
    Build a spacecraft state from orbit and attitude.
    Mass is set to an unspecified non-null arbitrary value.
    
    Parameters:
    
    absPva - position-velocity-acceleration
    
    attitude - attitude
    
    additional - additional states
    
    Throws:
    
    IllegalArgumentException - if orbit and attitude dates or frames are not equal
  - FieldSpacecraftState
```
public FieldSpacecraftState(FieldAbsolutePVCoordinates<T> absPva,
                            FieldAttitude<T> attitude,
                            FieldArrayDictionary<T> additional)
                     throws IllegalArgumentException
```
    Build a spacecraft state from orbit and attitude.
    Mass is set to an unspecified non-null arbitrary value.
    
    Parameters:
    
    absPva - position-velocity-acceleration
    
    attitude - attitude
    
    additional - additional states
    
    Throws:
    
    IllegalArgumentException - if orbit and attitude dates or frames are not equal
    
    Since:
    
    11.1
  - FieldSpacecraftState
```
@Deprecated
public FieldSpacecraftState(FieldAbsolutePVCoordinates<T> absPva,
                                        T mass,
                                        Map<String,T[]> additional)
```
    Deprecated. as of 11.1, replaced by FieldSpacecraftState(FieldAbsolutePVCoordinates, CalculusFieldElement, FieldArrayDictionary)
    
    Create a new instance from orbit and mass.
    Attitude law is set to an unspecified default attitude.
    
    Parameters:
    
    absPva - position-velocity-acceleration
    
    mass - the mass (kg)
    
    additional - additional states
  - FieldSpacecraftState
```
public FieldSpacecraftState(FieldAbsolutePVCoordinates<T> absPva,
                            T mass,
                            FieldArrayDictionary<T> additional)
```
    Create a new instance from orbit and mass.
    Attitude law is set to an unspecified default attitude.
    
    Parameters:
    
    absPva - position-velocity-acceleration
    
    mass - the mass (kg)
    
    additional - additional states
    
    Since:
    
    11.1
  - FieldSpacecraftState
```
@Deprecated
public FieldSpacecraftState(FieldAbsolutePVCoordinates<T> absPva,
                                        FieldAttitude<T> attitude,
                                        T mass,
                                        Map<String,T[]> additional)
```
    Deprecated. as of 11.1, replaced by FieldSpacecraftState(FieldAbsolutePVCoordinates, FieldAttitude, CalculusFieldElement, FieldArrayDictionary)
    
    Build a spacecraft state from orbit, attitude and mass.
    
    Parameters:
    
    absPva - position-velocity-acceleration
    
    attitude - attitude
    
    mass - the mass (kg)
    
    additional - additional states (may be null if no additional states are available)
  - FieldSpacecraftState
```
public FieldSpacecraftState(FieldAbsolutePVCoordinates<T> absPva,
                            FieldAttitude<T> attitude,
                            T mass,
                            FieldArrayDictionary<T> additional)
```
    Build a spacecraft state from orbit, attitude and mass.
    
    Parameters:
    
    absPva - position-velocity-acceleration
    
    attitude - attitude
    
    mass - the mass (kg)
    
    additional - additional states (may be null if no additional states are available)
    
    Since:
    
    11.1
  - FieldSpacecraftState
```
public FieldSpacecraftState(FieldAbsolutePVCoordinates<T> absPva,
                            FieldAttitude<T> attitude,
                            T mass,
                            FieldArrayDictionary<T> additional,
                            FieldArrayDictionary<T> additionalDot)
                     throws IllegalArgumentException
```
    Build a spacecraft state from orbit, attitude and mass.
    
    Parameters:
    
    absPva - position-velocity-acceleration
    
    attitude - attitude
    
    mass - the mass (kg)
    
    additional - additional states (may be null if no additional states are available)
    
    additionalDot - additional states derivatives(may be null if no additional states derivatives are available)
    
    Throws:
    
    IllegalArgumentException - if orbit and attitude dates or frames are not equal
    
    Since:
    
    11.1
- Method Detail
  - addAdditionalState
```
@SafeVarargs
public final FieldSpacecraftState<T> addAdditionalState(String name,
                                                                     T... value)
```
    Add an additional state.
    SpacecraftState instances are immutable, so this method does not change the instance, but rather creates a new instance, which has the same orbit, attitude, mass and additional states as the original instance, except it also has the specified state. If the original instance already had an additional state with the same name, it will be overridden. If it did not have any additional state with that name, the new instance will have one more additional state than the original instance.
    
    Parameters:
    
    name - name of the additional state
    
    value - value of the additional state
    
    Returns:
    
    a new instance, with the additional state added
    
    See Also:
    
    hasAdditionalState(String), getAdditionalState(String), getAdditionalStates()
  - addAdditionalStateDerivative
```
@SafeVarargs
public final FieldSpacecraftState<T> addAdditionalStateDerivative(String name,
                                                                               T... value)
```
    Add an additional state derivative. FieldSpacecraftState instances are immutable, so this method does not change the instance, but rather creates a new instance, which has the same components as the original instance, except it also has the specified state derivative. If the original instance already had an additional state derivative with the same name, it will be overridden. If it did not have any additional state derivative with that name, the new instance will have one more additional state derivative than the original instance.
    
    Parameters:
    
    name - name of the additional state derivative
    
    value - value of the additional state derivative
    
    Returns:
    
    a new instance, with the additional state derivative added
    
    See Also:
    
    hasAdditionalStateDerivative(String), getAdditionalStateDerivative(String), getAdditionalStatesDerivatives()
  - isOrbitDefined
```
public boolean isOrbitDefined()
```
    Check if the state contains an orbit part.
    A state contains either an absolute position-velocity-acceleration or an orbit.
    
    Returns:
    
    true if state contains an orbit (in which case getOrbit() will not throw an exception), or false if the state contains an absolut position-velocity-acceleration (in which case getAbsPVA() will not throw an exception)
  - shiftedBy
```
public FieldSpacecraftState<T> shiftedBy(double dt)
```
    Get a time-shifted state.
    The state can be slightly shifted to close dates. This shift is based on a simple Keplerian model for orbit, a linear extrapolation for attitude taking the spin rate into account and neither mass nor additional states changes. It is not intended as a replacement for proper orbit and attitude propagation but should be sufficient for small time shifts or coarse accuracy.
    
    As a rough order of magnitude, the following table shows the extrapolation errors obtained between this simple shift method and an numerical propagator for a low Earth Sun Synchronous Orbit, with a 20x20 gravity field, Sun and Moon third bodies attractions, drag and solar radiation pressure. Beware that these results will be different for other orbits.
    
    Extrapolation Error
    interpolation time (s) position error without derivatives (m) position error with derivatives (m)
    
    60 18 1.1
    
    120 72 9.1
    
    300 447 140
    
    600 1601 1067
    
    900 3141 3307
    
    Specified by:
    
    shiftedBy in interface FieldTimeShiftable<FieldSpacecraftState<T extends CalculusFieldElement<T>>,T extends CalculusFieldElement<T>>
    
    Parameters:
    
    dt - time shift in seconds
    
    Returns:
    
    a new state, shifted with respect to the instance (which is immutable) except for the mass which stay unchanged
  - shiftedBy
```
public FieldSpacecraftState<T> shiftedBy(T dt)
```
    Get a time-shifted state.
    The state can be slightly shifted to close dates. This shift is based on a simple Keplerian model for orbit, a linear extrapolation for attitude taking the spin rate into account and neither mass nor additional states changes. It is not intended as a replacement for proper orbit and attitude propagation but should be sufficient for small time shifts or coarse accuracy.
    
    As a rough order of magnitude, the following table shows the extrapolation errors obtained between this simple shift method and an numerical propagator for a low Earth Sun Synchronous Orbit, with a 20x20 gravity field, Sun and Moon third bodies attractions, drag and solar radiation pressure. Beware that these results will be different for other orbits.
    
    Extrapolation Error
    interpolation time (s) position error without derivatives (m) position error with derivatives (m)
    
    60 18 1.1
    
    120 72 9.1
    
    300 447 140
    
    600 1601 1067
    
    900 3141 3307
    
    Specified by:
    
    shiftedBy in interface FieldTimeShiftable<FieldSpacecraftState<T extends CalculusFieldElement<T>>,T extends CalculusFieldElement<T>>
    
    Parameters:
    
    dt - time shift in seconds
    
    Returns:
    
    a new state, shifted with respect to the instance (which is immutable) except for the mass which stay unchanged
  - interpolate
```
public FieldSpacecraftState<T> interpolate(FieldAbsoluteDate<T> date,
                                           Stream<FieldSpacecraftState<T>> sample)
```
    Get an interpolated instance.
    Note that the state of the current instance may not be used in the interpolation process, only its type and non interpolable fields are used (for example central attraction coefficient or frame when interpolating orbits). The interpolable fields taken into account are taken only from the states of the sample points. So if the state of the instance must be used, the instance should be included in the sample points.
    
    Note that this method is designed for small samples only (say up to about 10-20 points) so it can be implemented using polynomial interpolation (typically Hermite interpolation). Using too much points may induce Runge's phenomenon and numerical problems (including NaN appearing).
    
    The additional states that are interpolated are the ones already present in the instance. The sample instances must therefore have at least the same additional states has the instance. They may have more additional states, but the extra ones will be ignored.
    
    The instance and all the sample instances must be based on similar trajectory data, i.e. they must either all be based on orbits or all be based on absolute position-velocity-acceleration. Any inconsistency will trigger an OrekitIllegalStateException.
    
    As this implementation of interpolation is polynomial, it should be used only with small samples (about 10-20 points) in order to avoid Runge's phenomenon and numerical problems (including NaN appearing).
    
    Specified by:
    
    interpolate in interface FieldTimeInterpolable<FieldSpacecraftState<T extends CalculusFieldElement<T>>,T extends CalculusFieldElement<T>>
    
    Parameters:
    
    date - interpolation date
    
    sample - sample points on which interpolation should be done
    
    Returns:
    
    a new instance, interpolated at specified date
    
    Throws:
    
    OrekitIllegalStateException - if some instances are not based on similar trajectory data
  - getAbsPVA
```
public FieldAbsolutePVCoordinates<T> getAbsPVA()
                                        throws OrekitIllegalStateException
```
    Get the absolute position-velocity-acceleration.
    A state contains either an absolute position-velocity-acceleration or an orbit. Which one is present can be checked using isOrbitDefined().
    
    Returns:
    
    absolute position-velocity-acceleration
    
    Throws:
    
    OrekitIllegalStateException - if position-velocity-acceleration is null, which mean the state rather contains an FieldOrbit
    
    See Also:
    
    isOrbitDefined(), getOrbit()
  - getOrbit
```
public FieldOrbit<T> getOrbit()
                       throws OrekitIllegalStateException
```
    Get the current orbit.
    A state contains either an absolute position-velocity-acceleration or an orbit. Which one is present can be checked using isOrbitDefined().
    
    Returns:
    
    the orbit
    
    Throws:
    
    OrekitIllegalStateException - if orbit is null, which means the state rather contains an absolute position-velocity-acceleration
    
    See Also:
    
    isOrbitDefined(), getAbsPVA()
  - getDate
```
public FieldAbsoluteDate<T> getDate()
```
    Get the date.
    
    Specified by:
    
    getDate in interface FieldTimeStamped<T extends CalculusFieldElement<T>>
    
    Returns:
    
    date
  - getFrame
```
public Frame getFrame()
```
    Get the defining frame.
    
    Returns:
    
    the frame in which state is defined
  - hasAdditionalState
```
public boolean hasAdditionalState(String name)
```
    Check if an additional state is available.
    
    Parameters:
    
    name - name of the additional state
    
    Returns:
    
    true if the additional state is available
    
    See Also:
    
    addAdditionalState(String, CalculusFieldElement...), getAdditionalState(String), getAdditionalStates()
  - hasAdditionalStateDerivative
```
public boolean hasAdditionalStateDerivative(String name)
```
    Check if an additional state derivative is available.
    
    Parameters:
    
    name - name of the additional state derivative
    
    Returns:
    
    true if the additional state derivative is available
    
    See Also:
    
    addAdditionalStateDerivative(String, CalculusFieldElement...), getAdditionalStateDerivative(String), getAdditionalStatesDerivatives()
  - ensureCompatibleAdditionalStates
```
public void ensureCompatibleAdditionalStates(FieldSpacecraftState<T> state)
                                      throws MathIllegalArgumentException
```
    Check if two instances have the same set of additional states available.
    Only the names and dimensions of the additional states are compared, not their values.
    
    Parameters:
    
    state - state to compare to instance
    
    Throws:
    
    MathIllegalArgumentException - if an additional state does not have the same dimension in both states
  - getAdditionalState
```
public T[] getAdditionalState(String name)
```
    Get an additional state.
    
    Parameters:
    
    name - name of the additional state
    
    Returns:
    
    value of the additional state
    
    See Also:
    
    addAdditionalState(String, CalculusFieldElement...), hasAdditionalState(String), getAdditionalStates()
  - getAdditionalStateDerivative
```
public T[] getAdditionalStateDerivative(String name)
```
    Get an additional state derivative.
    
    Parameters:
    
    name - name of the additional state derivative
    
    Returns:
    
    value of the additional state derivative
    
    Since:
    
    11.1
    
    See Also:
    
    addAdditionalStateDerivative(String, CalculusFieldElement...), hasAdditionalStateDerivative(String), getAdditionalStatesDerivatives()
  - getAdditionalStates
```
@Deprecated
public Map<String,T[]> getAdditionalStates()
```
    Deprecated. as of 11.1, replaced by getAdditionalStatesValues()
    
    Get an unmodifiable map of additional states.
    
    Returns:
    
    unmodifiable map of additional states
    
    See Also:
    
    addAdditionalState(String, CalculusFieldElement...), hasAdditionalState(String), getAdditionalState(String)
  - getAdditionalStatesValues
```
public FieldArrayDictionary<T> getAdditionalStatesValues()
```
    Get an unmodifiable map of additional states.
    
    Returns:
    
    unmodifiable map of additional states
    
    Since:
    
    11.1
    
    See Also:
    
    addAdditionalState(String, CalculusFieldElement...), hasAdditionalState(String), getAdditionalState(String)
  - getAdditionalStatesDerivatives
```
public FieldArrayDictionary<T> getAdditionalStatesDerivatives()
```
    Get an unmodifiable map of additional states derivatives.
    
    Returns:
    
    unmodifiable map of additional states derivatives
    
    Since:
    
    11.1
    
    See Also:
    
    addAdditionalStateDerivative(String, CalculusFieldElement...), hasAdditionalStateDerivative(String), getAdditionalStateDerivative(String)
  - toTransform
```
public FieldTransform<T> toTransform()
```
    Compute the transform from state defining frame to spacecraft frame.
    The spacecraft frame origin is at the point defined by the orbit, and its orientation is defined by the attitude.
    
    Returns:
    
    transform from specified frame to current spacecraft frame
  - getMu
```
public T getMu()
```
    Get the central attraction coefficient.
    
    Returns:
    
    mu central attraction coefficient (m^3/s^2), or {code Double.NaN} if the state is contains an absolute position-velocity-acceleration rather than an orbit
  - getKeplerianPeriod
```
public T getKeplerianPeriod()
```
    Get the Keplerian period.
    The Keplerian period is computed directly from semi major axis and central acceleration constant.
    
    Returns:
    
    keplerian period in seconds, or {code Double.NaN} if the state is contains an absolute position-velocity-acceleration rather than an orbit
  - getKeplerianMeanMotion
```
public T getKeplerianMeanMotion()
```
    Get the Keplerian mean motion.
    The Keplerian mean motion is computed directly from semi major axis and central acceleration constant.
    
    Returns:
    
    keplerian mean motion in radians per second, or {code Double.NaN} if the state is contains an absolute position-velocity-acceleration rather than an orbit
  - getA
```
public T getA()
```
    Get the semi-major axis.
    
    Returns:
    
    semi-major axis (m), or {code Double.NaN} if the state is contains an absolute position-velocity-acceleration rather than an orbit
  - getEquinoctialEx
```
public T getEquinoctialEx()
```
    Get the first component of the eccentricity vector (as per equinoctial parameters).
    
    Returns:
    
    e cos(ω + Ω), first component of eccentricity vector, or {code Double.NaN} if the state is contains an absolute position-velocity-acceleration rather than an orbit
    
    See Also:
    
    getE()
  - getEquinoctialEy
```
public T getEquinoctialEy()
```
    Get the second component of the eccentricity vector (as per equinoctial parameters).
    
    Returns:
    
    e sin(ω + Ω), second component of the eccentricity vector, or {code Double.NaN} if the state is contains an absolute position-velocity-acceleration rather than an orbit
    
    See Also:
    
    getE()
  - getHx
```
public T getHx()
```
    Get the first component of the inclination vector (as per equinoctial parameters).
    
    Returns:
    
    tan(i/2) cos(Ω), first component of the inclination vector, or {code Double.NaN} if the state is contains an absolute position-velocity-acceleration rather than an orbit
    
    See Also:
    
    getI()
  - getHy
```
public T getHy()
```
    Get the second component of the inclination vector (as per equinoctial parameters).
    
    Returns:
    
    tan(i/2) sin(Ω), second component of the inclination vector, or {code Double.NaN} if the state is contains an absolute position-velocity-acceleration rather than an orbit
    
    See Also:
    
    getI()
  - getLv
```
public T getLv()
```
    Get the true latitude argument (as per equinoctial parameters).
    
    Returns:
    
    v + ω + Ω true longitude argument (rad), or {code Double.NaN} if the state is contains an absolute position-velocity-acceleration rather than an orbit
    
    See Also:
    
    getLE(), getLM()
  - getLE
```
public T getLE()
```
    Get the eccentric latitude argument (as per equinoctial parameters).
    
    Returns:
    
    E + ω + Ω eccentric longitude argument (rad), or {code Double.NaN} if the state is contains an absolute position-velocity-acceleration rather than an orbit
    
    See Also:
    
    getLv(), getLM()
  - getLM
```
public T getLM()
```
    Get the mean longitude argument (as per equinoctial parameters).
    
    Returns:
    
    M + ω + Ω mean latitude argument (rad), or {code Double.NaN} if the state is contains an absolute position-velocity-acceleration rather than an orbit
    
    See Also:
    
    getLv(), getLE()
  - getE
```
public T getE()
```
    Get the eccentricity.
    
    Returns:
    
    eccentricity, or {code Double.NaN} if the state is contains an absolute position-velocity-acceleration rather than an orbit
    
    See Also:
    
    getEquinoctialEx(), getEquinoctialEy()
  - getI
```
public T getI()
```
    Get the inclination.
    
    Returns:
    
    inclination (rad)
    
    See Also:
    
    getHx(), getHy()
  - getPVCoordinates
```
public TimeStampedFieldPVCoordinates<T> getPVCoordinates()
```
    Get the TimeStampedFieldPVCoordinates in orbit definition frame.
    Compute the position and velocity of the satellite. This method caches its results, and recompute them only when the method is called with a new value for mu. The result is provided as a reference to the internally cached TimeStampedFieldPVCoordinates, so the caller is responsible to copy it in a separate TimeStampedFieldPVCoordinates if it needs to keep the value for a while.
    
    Returns:
    
    pvCoordinates in orbit definition frame
  - getPVCoordinates
```
public TimeStampedFieldPVCoordinates<T> getPVCoordinates(Frame outputFrame)
```
    Get the TimeStampedFieldPVCoordinates in given output frame.
    Compute the position and velocity of the satellite. This method caches its results, and recompute them only when the method is called with a new value for mu. The result is provided as a reference to the internally cached TimeStampedFieldPVCoordinates, so the caller is responsible to copy it in a separate TimeStampedFieldPVCoordinates if it needs to keep the value for a while.
    
    Parameters:
    
    outputFrame - frame in which coordinates should be defined
    
    Returns:
    
    pvCoordinates in orbit definition frame
  - getAttitude
```
public FieldAttitude<T> getAttitude()
```
    Get the attitude.
    
    Returns:
    
    the attitude.
  - getMass
```
public T getMass()
```
    Gets the current mass.
    
    Returns:
    
    the mass (kg)
  - toSpacecraftState
```
public SpacecraftState toSpacecraftState()
```
    To convert a FieldSpacecraftState instance into a SpacecraftState instance.
    
    Returns:
    
    SpacecraftState instance with the same properties
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Extrapolation Error
interpolation time (s)	position error without derivatives (m)	position error with derivatives (m)
60	18	1.1
120	72	9.1
300	447	140
600	1601	1067
900	3141	3307

Extrapolation Error
interpolation time (s)	position error without derivatives (m)	position error with derivatives (m)
60	18	1.1
120	72	9.1
300	447	140
600	1601	1067
900	3141	3307

Class FieldSpacecraftState<T extends CalculusFieldElement<T>>

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface org.orekit.time.FieldTimeInterpolable

Constructor Detail

FieldSpacecraftState

FieldSpacecraftState

FieldSpacecraftState

FieldSpacecraftState

FieldSpacecraftState

FieldSpacecraftState

FieldSpacecraftState

FieldSpacecraftState

FieldSpacecraftState

FieldSpacecraftState

FieldSpacecraftState

FieldSpacecraftState

FieldSpacecraftState

FieldSpacecraftState

FieldSpacecraftState

FieldSpacecraftState

FieldSpacecraftState

FieldSpacecraftState

FieldSpacecraftState

FieldSpacecraftState

FieldSpacecraftState

FieldSpacecraftState

FieldSpacecraftState

FieldSpacecraftState

FieldSpacecraftState

FieldSpacecraftState

FieldSpacecraftState

Method Detail

addAdditionalState

addAdditionalStateDerivative

isOrbitDefined

shiftedBy

shiftedBy

interpolate

getAbsPVA

getOrbit

getDate

getFrame

hasAdditionalState

hasAdditionalStateDerivative

ensureCompatibleAdditionalStates

getAdditionalState

getAdditionalStateDerivative

getAdditionalStates

getAdditionalStatesValues

getAdditionalStatesDerivatives

toTransform

getMu

getKeplerianPeriod

getKeplerianMeanMotion

getA

getEquinoctialEx

getEquinoctialEy

getHx

getHy

getLv

getLE

getLM

getE

getI

getPVCoordinates

getPVCoordinates

getAttitude

getMass

toSpacecraftState

toString