agi.foundation.coordinates

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

Interface IAdjustableState

All Superinterfaces:

ICloneWithContext, IThreadAware, ITimeBasedState

All Known Implementing Classes:

BasicState

public interface IAdjustableState
extends ITimeBasedState

A state that can have elements added and removed.

Method Summary

Modifier and Type	Method and Description
<T> void	addStateElementMotion(String elementIdentification, Motion1<T> motion) Adds a Motion{T} element to this state.
<T> void	addStateElementValue(String elementIdentification, T value) Adds an element to this state.
boolean	removeStateElement(String elementIdentification) Removes the specified element and its data from this state.

Methods inherited from interface agi.foundation.coordinates.ITimeBasedState

getAvailableElements, getCurrentDate, getMotion, getValue, modifyMotion, modifyValue, setCurrentDate

Methods inherited from interface agi.foundation.infrastructure.IThreadAware

getIsThreadSafe

Methods inherited from interface agi.foundation.infrastructure.ICloneWithContext

clone

Method Detail

addStateElementValue

<T> void addStateElementValue(String elementIdentification,
                              T value)

Adds an element to this state. Calling code is responsible for ensuring that the value is of a type that this state can store.

Type Parameters:

T - The type of the element being added to the state.

Parameters:

elementIdentification - The name of the new element.

value - The value of the new element.

addStateElementMotion

<T> void addStateElementMotion(String elementIdentification,
                               @Nonnull
                               Motion1<T> motion)

Adds a Motion{T} element to this state. Calling code is responsible for ensuring that the motion is of a type that this state can store.

Type Parameters:

T - The type of the Motion being added to the state.

Parameters:

elementIdentification - The name of the new element.

motion - The Motion{T} of the new element.

removeStateElement

boolean removeStateElement(String elementIdentification)

Removes the specified element and its data from this state.

Parameters:

elementIdentification - The name of the element to be removed.

Returns:

true if the element was removed successfully; otherwise false.