agi.foundation

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

Interface IDateMotionCollection1<T>

Type Parameters:

T - The type of motion that this collection contains. For example, if T is Cartesian, then this is collection holds Motion1.

All Known Implementing Classes:

DateMotionCollection1

public interface IDateMotionCollection1<T>

An interface to a collection of Motion1, each of which is associated with a particular JulianDate. Each Motion1 instance is required to have the same Order (get).

Method Summary

Modifier and Type	Method and Description
void	add(JulianDate date, Motion1<T> motion) Adds an item to the collection.
void	add(JulianDate date, T... values) Adds an item to the collection.
void	add(JulianDate date, T value) Adds an item to the collection.
void	add(JulianDate date, T value, T firstDerivative) Adds an item to the collection.
void	add(JulianDate date, T value, T firstDerivative, T secondDerivative) Adds an item to the collection.
List<T>	get(int index) Gets the list of the specified derivative.
int	getCount() Gets the number of items in this collection.
List<JulianDate>	getDates() Gets the list of dates in this collection.
List<T>	getFirstDerivatives() Gets the list of first derivatives in the collection.
List<Motion1<T>>	getMotions() Gets the list of motion instances in this collection.
int	getOrder() Gets the number of derivatives in this collection.
List<T>	getSecondDerivatives() Gets the list of second derivatives in the collection.
List<T>	getValues() Gets the list of values in the collection.
void	setItem(int index, JulianDate date, Motion1<T> motion) Sets an item at a particular index.
void	setItem(int index, JulianDate date, T... values) Sets an item at a particular index.
void	setItem(int index, JulianDate date, T value) Sets an item at a particular index.
void	setItem(int index, JulianDate date, T value, T firstDerivative) Sets an item at a particular index.
void	setItem(int index, JulianDate date, T value, T firstDerivative, T secondDerivative) Sets an item at a particular index.

Method Detail

add

void add(@Nonnull
         JulianDate date,
         T value,
         T firstDerivative)

Adds an item to the collection.

Parameters:

date - The date associated with the item.

value - The value to add.

firstDerivative - The first derivative to add.

add

void add(@Nonnull
         JulianDate date,
         T value)

Adds an item to the collection.

Parameters:

date - The date associated with the item.

value - The value to add.

add

void add(@Nonnull
         JulianDate date,
         T value,
         T firstDerivative,
         T secondDerivative)

Adds an item to the collection.

Parameters:

date - The date associated with the item.

value - The value to add.

firstDerivative - The first derivative to add.

secondDerivative - The second derivative to add.

add

void add(@Nonnull
         JulianDate date,
         @Nonnull
         Motion1<T> motion)

Adds an item to the collection.

Parameters:

date - The date associated with the item.

motion - The item to add.

add

void add(@Nonnull
         JulianDate date,
         T... values)

Adds an item to the collection.

Parameters:

date - The date associated with the item.

values - The values to add. The first item in the array is the value, the second item is the first derivative, and so on.

getCount

int getCount()

Gets the number of items in this collection.

getDates

@Nonnull
List<JulianDate> getDates()

Gets the list of dates in this collection.

getMotions

@Nonnull
List<Motion1<T>> getMotions()

Gets the list of motion instances in this collection. Consider using Values (get), FirstDerivatives (get), SecondDerivatives (get), etc. to get all of the corresponding data as a single list. This is more efficient than requesting a list of motion instances.

getOrder

int getOrder()

Gets the number of derivatives in this collection.

setItem

void setItem(int index,
             @Nonnull
             JulianDate date,
             T value,
             T firstDerivative,
             T secondDerivative)

Sets an item at a particular index.

Parameters:

index - The index of the item to set.

date - The new date for the item.

value - The new value for the item.

firstDerivative - The new first derivative for the item.

secondDerivative - The new second derivative for the item.

setItem

void setItem(int index,
             @Nonnull
             JulianDate date,
             @Nonnull
             Motion1<T> motion)

Sets an item at a particular index.

Parameters:

index - The index of the item to set.

date - The new date for the item.

motion - The new item.

setItem

void setItem(int index,
             @Nonnull
             JulianDate date,
             T... values)

Sets an item at a particular index.

Parameters:

index - The index of the item to set.

date - The new date for the item.

values - The new values for the item.

setItem

void setItem(int index,
             @Nonnull
             JulianDate date,
             T value,
             T firstDerivative)

Sets an item at a particular index.

Parameters:

index - The index of the item to set.

date - The new date for the item.

value - The new value for the item.

firstDerivative - The new first derivative for the item.

setItem

void setItem(int index,
             @Nonnull
             JulianDate date,
             T value)

Sets an item at a particular index.

Parameters:

index - The index of the item to set.

date - The new date for the item.

value - The new value for the item.

get

@Nonnull
List<T> get(int index)

Gets the list of the specified derivative.

Specifying an index of 0 retrieves a list of all values in the collection. Specifying 1 retrieves a list of all first derivatives. Specifying 2 retrieves a list of all second derivatives. And so on.

Parameters:

index - The derivative list of retrieve.

Returns:

The requested list.

getValues

@Nonnull
List<T> getValues()

Gets the list of values in the collection.

getFirstDerivatives

@Nonnull
List<T> getFirstDerivatives()

Gets the list of first derivatives in the collection.

getSecondDerivatives

@Nonnull
List<T> getSecondDerivatives()

Gets the list of second derivatives in the collection.