agi.foundation.segmentpropagation

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

Class StateElementAdapterHelpers

java.lang.Object

agi.foundation.segmentpropagation.StateElementAdapterHelpers

public final class StateElementAdapterHelpers
extends Object

A set of helper methods for working with StateElementAdapters.

Method Summary

Modifier and Type	Method and Description
static ArrayList<ITimeBasedState>	adaptEphemeris(List<ITimeBasedState> ephemeris, List<StateElementAdapter> adapters, CopyContext context) Adapts the ephemeris using the adapters provided.
static void	adaptState(ITimeBasedState initialState, ITimeBasedState finalState, List<StateElementAdapter> adapters) A helper method to perform the default state adaptation.
static StateElementAdapter	createAdapterBetweenSegments(String element, SegmentDefinition from, SegmentDefinition to, EvaluatorGroup group) A helper method to create a StateElementAdapter from one segment to another.

Methods inherited from class java.lang.Object

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

Method Detail

createAdapterBetweenSegments

@Nullable
public static StateElementAdapter createAdapterBetweenSegments(String element,
                                                                          @Nonnull
                                                                          SegmentDefinition from,
                                                                          @Nonnull
                                                                          SegmentDefinition to,
                                                                          @Nonnull
                                                                          EvaluatorGroup group)

A helper method to create a StateElementAdapter from one segment to another.

Parameters:

element - The string identification of the element being adapted.

from - The segment to adapt the element from.

to - The segment to adapt the element to.

group - The EvaluatorGroup to use to create the adapter.

Returns:

The StateElementAdapter going between the two segments, or null if one or both of the segments does not contain that element.

Throws:

ArgumentNullException - Thrown when from, to, or group is null.

adaptState

public static void adaptState(@Nonnull
                              ITimeBasedState initialState,
                              @Nonnull
                              ITimeBasedState finalState,
                              @Nullable
                              List<StateElementAdapter> adapters)

A helper method to perform the default state adaptation. Note that initialState and finalState can be the same instance.

Parameters:

initialState - The old state whose adapted data will be put into finalState.

finalState - The state to edit with the adapted data from initialState.

adapters - The StateElementAdapters to use to adapt the data in the states.

Throws:

ArgumentNullException - Thrown when initialState or finalState is null.

adaptEphemeris

@Nonnull
public static ArrayList<ITimeBasedState> adaptEphemeris(@Nonnull
                                                                  List<ITimeBasedState> ephemeris,
                                                                  @Nullable
                                                                  List<StateElementAdapter> adapters,
                                                                  @Nonnull
                                                                  CopyContext context)

Adapts the ephemeris using the adapters provided. A new list of ITimeBasedStates will be returned. The states will have been cloned using the context and those clones adapted, leaving the original states alone.

Parameters:

ephemeris - The ephemeris to be adapted.

adapters - The adapters to adapt the ephemeris.

context - The context to use to clone the states in the ephemeris.

Returns:

A new list of cloned and adapted states.

Throws:

ArgumentNullException - Thrown when ephemeris or context is null.