public abstract class AuxiliaryStateElementConverter extends Object implements IThreadAware
AuxiliaryStateElement.
This represents the indexed auxiliary state, and a means of
converting the raw output information back into useful information specific
to this element.| Modifier | Constructor and Description |
|---|---|
protected |
AuxiliaryStateElementConverter(AuxiliaryStateElementConverter existingInstance,
CopyContext context)
Initializes a new instance as a copy of an existing instance.
|
protected |
AuxiliaryStateElementConverter(String identification,
int[] indices)
Initializes a new instance.
|
| Modifier and Type | Method and Description |
|---|---|
abstract Object |
clone(CopyContext context)
Clones this object using the specified context.
|
abstract <T> Motion1<T> |
convertState(double[] auxiliaryState)
Convert the raw auxiliary state into this instance's
TypeOfOutput (get)
and its derivatives. |
int[] |
getAuxiliaryIndices()
Gets the indices into the auxiliary state output.
|
abstract int |
getDimension()
Gets the number of parameters (per
Order (get)) within this element. |
String |
getIdentification()
Gets the string identifying this instance in the overall output.
|
abstract boolean |
getIsThreadSafe()
Gets a value indicating whether the methods on this instance are safe to call from
multiple threads simultaneously.
|
abstract int |
getOrder()
Gets the order of this auxiliary state.
|
abstract Class<?> |
getTypeOfOutput()
Gets the type associated with the output of this instance.
|
protected AuxiliaryStateElementConverter(String identification, @Nonnull int[] indices)
identification - A string identifying this instance in the overall output.indices - The indices of the individual values in the overall auxiliary state.protected AuxiliaryStateElementConverter(@Nonnull AuxiliaryStateElementConverter 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 abstract 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 abstract 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 IThreadAwarepublic final String getIdentification()
public final int[] getAuxiliaryIndices()
public abstract int getOrder()
public abstract int getDimension()
Order (get)) within this element.@Nonnull public abstract Class<?> getTypeOfOutput()
@Nonnull public abstract <T> Motion1<T> convertState(double[] auxiliaryState)
TypeOfOutput (get)
and its derivatives.T - The TypeOfOutput (get) produced by this instance.auxiliaryState - The raw auxiliary state to convert.