public class BasicState extends Object implements IAdjustableState
IAdjustableState that can hold any data type or motions.
This type will directly cast the stored items to the type requested, which can cause exceptions to be
thrown. Creating your own specialized ITimeBasedState for your needs will avoid that,
as well as may result in better performance and flexibility.| Modifier | Constructor and Description |
|---|---|
|
BasicState()
Initializes a new instance.
|
protected |
BasicState(BasicState existingInstance,
CopyContext context)
Initializes a new instance as a copy of an existing instance.
|
| 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.
|
Object |
clone(CopyContext context)
Clones this object using the specified context.
|
List<String> |
getAvailableElements()
Gets the names of all of the elements in this state.
|
JulianDate |
getCurrentDate()
Gets the
JulianDate that this state is valid. |
boolean |
getIsThreadSafe()
Gets a value indicating whether the methods on this instance are safe to call from
multiple threads simultaneously.
|
<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)
|
boolean |
removeStateElement(String elementIdentification)
Removes the specified element and its data from this state.
|
void |
setCurrentDate(JulianDate value)
Sets the
JulianDate that this state is valid. |
public BasicState()
protected BasicState(@Nonnull BasicState existingInstance, @Nonnull CopyContext context)
See ICloneWithContext.clone(CopyContext) for more information about how to implement this constructor
in a derived class.
existingInstance - The existing instance to copy.context - A CopyContext that controls the depth of the copy.ArgumentNullException - Thrown when existingInstance or context is null.public final Object clone(CopyContext context)
This method should be implemented to call a copy constructor on the class of the
object being cloned. The copy constructor should take the CopyContext as a parameter
in addition to the existing instance to copy. The copy constructor should first call
CopyContext.addObjectMapping(T, T) to identify the newly constructed instance
as a copy of the existing instance. It should then copy all fields, using
CopyContext.updateReference(T) to copy any reference fields.
A typical implementation of ICloneWithContext:
public static class MyClass implements ICloneWithContext {
public MyClass(MyClass existingInstance, CopyContext context) {
context.addObjectMapping(existingInstance, this);
someReference = context.updateReference(existingInstance.someReference);
}
@Override
public final Object clone(CopyContext context) {
return new MyClass(this, context);
}
private Object someReference;
}
In general, all fields that are reference types should be copied with a call to
CopyContext.updateReference(T). There are a couple of exceptions:
If one of these exceptions applies, the CopyContext should be given an opportunity
to update the reference before the reference is copied explicitly. Use
CopyContext.updateReference(T) to update the reference. If CopyContext.updateReference(T) returns
the original object, indicating that the context does not have a replacement registered,
then copy the object manually by invoking a Clone method, a copy constructor, or by manually
constructing a new instance and copying the values.
alwaysCopy = context.updateReference(existingInstance.alwaysCopy);
if (existingInstance.alwaysCopy != null && alwaysCopy == existingInstance.alwaysCopy) {
alwaysCopy = (AlwaysCopy) existingInstance.alwaysCopy.clone(context);
}
If you are implementing an evaluator (a class that implements IEvaluator), the
IEvaluator.updateEvaluatorReferences(agi.foundation.infrastructure.CopyContext) method shares some responsibilities with the
copy context constructor. Code duplication can be avoided by doing the following:
CopyContext.updateReference(T). You should still call CopyContext.updateReference(T) on any references to
non-evaluators.
IEvaluator.updateEvaluatorReferences(agi.foundation.infrastructure.CopyContext) as the last line in the constructor and pass it the
same CopyContext passed to the constructor.
IEvaluator.updateEvaluatorReferences(agi.foundation.infrastructure.CopyContext) as normal. See the reference documentation for
IEvaluator.updateEvaluatorReferences(agi.foundation.infrastructure.CopyContext) for more information on implementing that method.
public MyClass(MyClass existingInstance, CopyContext context) {
super(existingInstance, context);
someReference = context.updateReference(existingInstance.someReference);
evaluatorReference = existingInstance.evaluatorReference;
updateEvaluatorReferences(context);
}
@Override
public void updateEvaluatorReferences(CopyContext context) {
evaluatorReference = context.updateReference(evaluatorReference);
}
@Override
public Object clone(CopyContext context) {
return new MyClass(this, context);
}
private Object someReference;
private IEvaluator evaluatorReference;clone in interface ICloneWithContextcontext - The context to use to perform the copy.public final boolean getIsThreadSafe()
If this property is true, all methods and properties are guaranteed to be thread safe.
Conceptually, an object that returns true for this method acts as if there is a lock
protecting each method and property such that only one thread at a time can be inside any method or
property in the class. In reality, such locks are generally not used and are in fact discouraged. However,
the user must not experience any exceptions or inconsistent behavior that would not be experienced if such
locks were used.
If this property is false, the behavior when using this class from multiple threads
simultaneously is undefined and may include inconsistent results and exceptions. Clients wishing to use
multiple threads should call CopyForAnotherThread.copy(T) to get a separate instance of the
object for each thread.
getIsThreadSafe in interface IThreadAware@Nonnull public final JulianDate getCurrentDate()
JulianDate that this state is valid.getCurrentDate in interface ITimeBasedStatepublic final void setCurrentDate(@Nonnull JulianDate value)
JulianDate that this state is valid.setCurrentDate in interface ITimeBasedStatepublic final List<String> getAvailableElements()
getAvailableElements in interface ITimeBasedStatepublic final <T> T getValue(String elementIdentification)
getValue in interface ITimeBasedStateT - The type of the motion that the elementIdentification is
(Cartesian, double, etc...).elementIdentification - The name of the element.elementIdentification.@Nonnull public final <T> Motion1<T> getMotion(String elementIdentification)
Motion1 of the requested elementIdentification.getMotion in interface ITimeBasedStateT - The type of the Motion1 that the
elementIdentification is (Cartesian, double, etc...).elementIdentification - The name of the element.Motion1 of the elementIdentification.public final <T> void modifyValue(String elementIdentification, T newValue)
modifyValue in interface ITimeBasedStateT - The type that the value described by the elementIdentification is.elementIdentification - The name of the element to change.newValue - The new value for the elementIdentification.public final <T> void modifyMotion(String elementIdentification, @Nonnull Motion1<T> newValue)
ITimeBasedState with the Motion1 of the
specified elementIdentification updated.modifyMotion in interface ITimeBasedStateT - The type that the Motion1 described by the elementIdentification
is.elementIdentification - The name of the element to change.newValue - The new values for the elementIdentification.public final <T> void addStateElementValue(String elementIdentification, T value)
value is of a type that this state can store.addStateElementValue in interface IAdjustableStateT - The type of the element being added to the state.elementIdentification - The name of the new element.value - The value of the new element.public final <T> void addStateElementMotion(String elementIdentification, @Nonnull Motion1<T> motion)
motion is of a type that this state can store.addStateElementMotion in interface IAdjustableStateT - The type of the Motion being added to the state.elementIdentification - The name of the new element.motion - The Motion{T} of the new element.public final boolean removeStateElement(String elementIdentification)
removeStateElement in interface IAdjustableStateelementIdentification - The name of the element to be removed.true if the element was removed successfully; otherwise false.