agi.foundation

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

Class DateMotionCollection1<T>

java.lang.Object

agi.foundation.DateMotionCollection1<T>

Type Parameters:

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

All Implemented Interfaces:

IDateMotionCollection1<T>

public class DateMotionCollection1<T>
extends Object
implements IDateMotionCollection1<T>

A collection of Motion1, each of which is associated with a particular JulianDate. This is a convenient and efficient way to store time-varying position and velocity, etc. Each Motion1 instance is required to have the same Order (get).

Constructor Summary

Constructors

Constructor and Description
DateMotionCollection1() Initializes a new instance.
DateMotionCollection1(int size, int order) Initializes a new instance with a particular size and order.

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.
void	addRange(DateMotionCollection1<T> collection) Adds the elements of the specified collection to the end of this collection.
ImmutableDateMotionCollection1<T>	createImmutableView() Creates a view of this instance that is guaranteed not to change.
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	insertItem(int index, JulianDate date, Motion1<T> motion) Inserts an item at a particular index.
void	insertItem(int index, JulianDate date, T... values) Inserts an item at a particular index.
void	insertItem(int index, JulianDate date, T value) Inserts an item at a particular index.
void	insertItem(int index, JulianDate date, T value, T firstDerivative) Inserts an item at a particular index.
void	insertItem(int index, JulianDate date, T value, T firstDerivative, T secondDerivative) Inserts an item at a particular index.
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.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DateMotionCollection1

public DateMotionCollection1()

Initializes a new instance. The order of the collection will be determined by the first item added to it.

DateMotionCollection1

public DateMotionCollection1(int size,
                             int order)

Initializes a new instance with a particular size and order.

After constructing a new instance with this constructor, the Count (get) property will return size and DateMotionCollection1.setItem(int,JulianDate,Object) can be used to set the value at a particular index. Also, the Order (get) property will return order.

Parameters:

size - The number of items in the collection.

order - The number of derivatives that the collection should store.

Method Detail

getCount

public final int getCount()

Gets the number of items in this collection.

Specified by:

getCount in interface IDateMotionCollection1<T>

getOrder

public final int getOrder()

Gets the number of derivatives in this collection.

Specified by:

getOrder in interface IDateMotionCollection1<T>

getDates

public final List<JulianDate> getDates()

Gets the list of dates in this collection.

Specified by:

getDates in interface IDateMotionCollection1<T>

getMotions

public final 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.

Specified by:

getMotions in interface IDateMotionCollection1<T>

get

public final 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.

Specified by:

get in interface IDateMotionCollection1<T>

Parameters:

index - The derivative list to retrieve.

Returns:

The requested list.

getValues

public final List<T> getValues()

Gets the list of values in the collection.

Specified by:

getValues in interface IDateMotionCollection1<T>

getFirstDerivatives

public final List<T> getFirstDerivatives()

Gets the list of first derivatives in the collection.

Specified by:

getFirstDerivatives in interface IDateMotionCollection1<T>

getSecondDerivatives

public final List<T> getSecondDerivatives()

Gets the list of second derivatives in the collection.

Specified by:

getSecondDerivatives in interface IDateMotionCollection1<T>

add

public final void add(@Nonnull
                      JulianDate date,
                      T value)

Adds an item to the collection.

Specified by:

add in interface IDateMotionCollection1<T>

Parameters:

date - The date associated with the item.

value - The value to add.

add

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

Adds an item to the collection.

Specified by:

add in interface IDateMotionCollection1<T>

Parameters:

date - The date associated with the item.

value - The value to add.

firstDerivative - The first derivative to add.

add

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

Adds an item to the collection.

Specified by:

add in interface IDateMotionCollection1<T>

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

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

Adds an item to the collection.

Specified by:

add in interface IDateMotionCollection1<T>

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.

add

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

Adds an item to the collection.

Specified by:

add in interface IDateMotionCollection1<T>

Parameters:

date - The date associated with the item.

motion - The item to add.

setItem

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

Sets an item at a particular index.

Specified by:

setItem in interface IDateMotionCollection1<T>

Parameters:

index - The index of the item to set.

date - The new date for the item.

value - The new value for the item.

setItem

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

Sets an item at a particular index.

Specified by:

setItem in interface IDateMotionCollection1<T>

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

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

Sets an item at a particular index.

Specified by:

setItem in interface IDateMotionCollection1<T>

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

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

Sets an item at a particular index.

Specified by:

setItem in interface IDateMotionCollection1<T>

Parameters:

index - The index of the item to set.

date - The new date for the item.

values - The new values for the item.

setItem

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

Sets an item at a particular index.

Specified by:

setItem in interface IDateMotionCollection1<T>

Parameters:

index - The index of the item to set.

date - The new date for the item.

motion - The new item.

insertItem

public final void insertItem(int index,
                             @Nonnull
                             JulianDate date,
                             T value)

Inserts an item at a particular index.

Parameters:

index - The index of the item to insert.

date - The date for the item.

value - The value for the item.

insertItem

public final void insertItem(int index,
                             @Nonnull
                             JulianDate date,
                             T value,
                             T firstDerivative)

Inserts an item at a particular index.

Parameters:

index - The index of the item to insert.

date - The date for the item.

value - The value for the item.

firstDerivative - The first derivative for the item.

insertItem

public final void insertItem(int index,
                             @Nonnull
                             JulianDate date,
                             T value,
                             T firstDerivative,
                             T secondDerivative)

Inserts an item at a particular index.

Parameters:

index - The index of the item to insert.

date - The date for the item.

value - The value for the item.

firstDerivative - The first derivative for the item.

secondDerivative - The second derivative for the item.

insertItem

public final void insertItem(int index,
                             @Nonnull
                             JulianDate date,
                             T... values)

Inserts an item at a particular index.

Parameters:

index - The index of the item to insert.

date - The date for the item.

values - The values for the item.

insertItem

public final void insertItem(int index,
                             @Nonnull
                             JulianDate date,
                             @Nonnull
                             Motion1<T> motion)

Inserts an item at a particular index.

Parameters:

index - The index of the item to insert.

date - The date for the item.

motion - The item.

addRange

public final void addRange(@Nonnull
                           DateMotionCollection1<T> collection)

Adds the elements of the specified collection to the end of this collection.

Parameters:

collection - The collection whose elements should be added to the end of this collection. The input collection must have an Order (get) equal to or greater than the Order of this collection.

Throws:

ArgumentException - Thrown when the Order (get) of the parameter collection is lower than the Order (get) of this object.

ArgumentNullException - Thrown when collection is null.

createImmutableView

@Nonnull
public final ImmutableDateMotionCollection1<T> createImmutableView()

Creates a view of this instance that is guaranteed not to change.

After calling this method to create an immutable view of this collection:

• Elements added to the end of this collection will be ignored by the immutable view.
• Changes to existing items in this collection will trigger a copy of this collection such that the immutable view will be unaffected.

Returns:

A view of this instance that is guaranteed not to change.