public class GeometryDynamicState extends DynamicState<IAdjustableState>
Points, Axes, Scalars, Vectors),
and DynamicMatrix that can be evaluated together at once and the results of which are stored in an IAdjustableState.| Modifier | Constructor and Description |
|---|---|
|
GeometryDynamicState()
Initializes a new instance.
|
protected |
GeometryDynamicState(GeometryDynamicState existingInstance,
CopyContext context)
Initializes a new instance as a copy of an existing instance.
|
| Modifier and Type | Method and Description |
|---|---|
protected boolean |
checkForSameDefinition(DynamicState<IAdjustableState> other)
Checks to determine if another instance has the same definition as this instance and
returns
true if it does. |
protected boolean |
checkForSameDefinition(GeometryDynamicState other)
Checks to determine if another instance has the same definition as this instance and
returns
true if it does. |
Object |
clone(CopyContext context)
Clones this object using the specified context.
|
protected int |
computeCurrentDefinitionHashCode()
Computes a hash code based on the current properties of this object.
|
boolean |
containsElement(String elementIdentification)
Checks to see if the specified element is contained in this definition.
|
void |
enumerateDependencies(DependencyEnumerator enumerator)
Enumerates the dependencies of this object by calling
DependencyEnumerator#enumerate(T) for each object that this object directly depends upon. |
<T extends DefinitionalObject> |
getElement(String elementIdentification)
Gets the
DefinitionalObject (Point, Scalar...)
of the elementIdentification stored in this GeometryDynamicState. |
Iterable<String> |
getElements()
Gets a read only collection of the identifications of the elements in this definition.
|
StateEvaluator<IAdjustableState> |
getEvaluator(EvaluatorGroup group)
Gets and creates the
StateEvaluator. |
boolean |
removeItem(String elementIdentification)
Removes the specified item from this definition.
|
<T extends DefinitionalObject> |
setElement(String elementIdentification,
T geometry)
Adds or changes the geometry type stored in this dynamic state.
|
checkForSameDefinition, getEvaluatorareSameDefinition, areSameDefinition, areSameDefinition, areSameDefinition, areSameDefinition, collectionItemsAreSameDefinition, collectionItemsAreSameDefinition, collectionItemsAreSameDefinition, dictionaryItemsAreSameDefinition, freeze, freezeAggregatedObjects, getCollectionHashCode, getCollectionHashCode, getCollectionHashCode, getDefinitionHashCode, getDefinitionHashCode, getDefinitionHashCode, getDefinitionHashCode, getDefinitionHashCode, getDefinitionHashCode, getDictionaryHashCode, getIsFrozen, isSameDefinition, throwIfFrozenpublic GeometryDynamicState()
protected GeometryDynamicState(@Nonnull GeometryDynamicState 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 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 ICloneWithContextclone in class DefinitionalObjectcontext - The context to use to perform the copy.protected final boolean checkForSameDefinition(DynamicState<IAdjustableState> other)
DynamicStatetrue if it does. Derived classes MUST override this method and check
all new fields introduced by the derived class for definitional equivalence. It is NOT necessary
to check base class fields because the base class will already have done that. When overriding this method,
you should NOT call the base implementation because it will return false for all derived-class instances.
Derived classes should check the type of other to preserve the symmetric nature of IEquatableDefinition.isSameDefinition(java.lang.Object).checkForSameDefinition in class DynamicState<IAdjustableState>other - The other instance to compare to this one.true if the two objects are defined equivalently; otherwise false.protected boolean checkForSameDefinition(GeometryDynamicState other)
true if it does. Derived classes MUST override this method and check
all new fields introduced by the derived class for definitional equivalence. It is NOT necessary
to check base class fields because the base class will already have done that. When overriding this method,
you should NOT call the base implementation because it will return false for all derived-class instances.
Derived classes should check the type of other to preserve the symmetric nature of IEquatableDefinition.isSameDefinition(java.lang.Object).other - The other instance to compare to this one.true if the two objects are defined equivalently; otherwise false.protected int computeCurrentDefinitionHashCode()
GeometryDynamicState.checkForSameDefinition(agi.foundation.coordinates.DynamicState<agi.foundation.coordinates.IAdjustableState>) method.computeCurrentDefinitionHashCode in class DynamicState<IAdjustableState>public void enumerateDependencies(DependencyEnumerator enumerator)
DependencyEnumerator#enumerate(T) for each object that this object directly depends upon.
Derived classes which contain additional dependencies MUST override this method, call the base
implementation, and enumerate dependencies introduced by the derived class.enumerateDependencies in interface IEnumerateDependenciesenumerateDependencies in class DefinitionalObjectenumerator - The enumerator that is informed of the dependencies of this object.public <T extends DefinitionalObject> T getElement(@Nonnull String elementIdentification)
DefinitionalObject (Point, Scalar...)
of the elementIdentification stored in this GeometryDynamicState.T - The type of the DefinitionalObject (Point, Scalar).elementIdentification - The name of the element to get.DefinitionalObject of the elementIdentification.public <T extends DefinitionalObject> void setElement(@Nonnull String elementIdentification, T geometry)
T is
not storable by this type then this method will throw.T - The type of the DefinitionalObject (Point, Scalar).elementIdentification - The name of the element to add or change.geometry - The DefinitionalObject to store in this dynamic state.public boolean containsElement(@Nonnull String elementIdentification)
elementIdentification - The name of the element to check on.true if the element is part of this definition; otherwise false.public boolean removeItem(@Nonnull String elementIdentification)
elementIdentification - The name of the element to remove.true if the item was removed successfully; otherwise false.@Nonnull public final Iterable<String> getElements()
public StateEvaluator<IAdjustableState> getEvaluator(EvaluatorGroup group)
StateEvaluator.getEvaluator in class DynamicState<IAdjustableState>group - The evaluator group in which to create the evaluator.StateEvaluator defined by this instance.