agi.foundation.coordinates

(agi.foundation.core-2024r2.jar)

Interface ITimeBasedState

All Superinterfaces:

ICloneWithContext, IThreadAware

All Known Subinterfaces:

IAdjustableState

All Known Implementing Classes:

BasicState, NumericalPropagatorState

public interface ITimeBasedState
extends IThreadAware

A general state that stores raw values. The state can represent anything you would like it to be, however every element must have a name that is used to retrieve and modify its values. This state has a time and motions.

Method Summary

Modifier and Type	Method and Description
List<String>	getAvailableElements() Gets the names of all of the elements in this state.
JulianDate	getCurrentDate() Gets the JulianDate that this state is valid.
<T> Motion1<T>	getMotion(String elementIdentification) Returns the Motion1 of the requested elementIdentification.
<T> T	getValue(String elementIdentification) Returns the requested value of the requested element.
<T> void	modifyMotion(String elementIdentification, Motion1<T> newValue) Modifies this instance of ITimeBasedState with the Motion1 of the specified elementIdentification updated.
<T> void	modifyValue(String elementIdentification, T newValue) Modifies the elementIdentification in this instance of ITimeBasedState with the newValue.
void	setCurrentDate(JulianDate value) Sets the JulianDate that this state is valid.

Methods inherited from interface agi.foundation.infrastructure.IThreadAware

getIsThreadSafe

Methods inherited from interface agi.foundation.infrastructure.ICloneWithContext

clone

Method Detail

getValue

<T> T getValue(String elementIdentification)

Returns the requested value of the requested element.

Type Parameters:

T - The type of the motion that the elementIdentification is (Cartesian, double, etc...).

Parameters:

elementIdentification - The name of the element.

Returns:

The value of the elementIdentification.

modifyValue

<T> void modifyValue(String elementIdentification,
                     T newValue)

Modifies the elementIdentification in this instance of ITimeBasedState with the newValue.

Type Parameters:

T - The type that the value described by the elementIdentification is.

Parameters:

elementIdentification - The name of the element to change.

newValue - The new value for the elementIdentification.

getAvailableElements

@Nonnull
List<String> getAvailableElements()

Gets the names of all of the elements in this state.

getMotion

@Nonnull
<T> Motion1<T> getMotion(String elementIdentification)

Returns the Motion1 of the requested elementIdentification.

Type Parameters:

T - The type of the Motion1 that the elementIdentification is (Cartesian, double, etc...).

Parameters:

elementIdentification - The name of the element.

Returns:

The Motion1 of the elementIdentification.

modifyMotion

<T> void modifyMotion(String elementIdentification,
                      @Nonnull
                      Motion1<T> newValue)

Modifies this instance of ITimeBasedState with the Motion1 of the specified elementIdentification updated.

Type Parameters:

T - The type that the Motion1 described by the elementIdentification is.

Parameters:

elementIdentification - The name of the element to change.

newValue - The new values for the elementIdentification.

getCurrentDate

@Nonnull
JulianDate getCurrentDate()

Gets the JulianDate that this state is valid.

setCurrentDate

void setCurrentDate(@Nonnull
                    JulianDate value)

Sets the JulianDate that this state is valid.