agi.foundation.stoppingconditions

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

Class AccessStoppingCondition

java.lang.Object

agi.foundation.infrastructure.DefinitionalObject

agi.foundation.stoppingconditions.StoppingCondition

agi.foundation.stoppingconditions.AccessStoppingCondition

All Implemented Interfaces:

ICloneWithContext, IEnumerateDependencies, IEquatableDefinition, IFreezable

public class AccessStoppingCondition
extends StoppingCondition

A StoppingCondition that will stop after an access query is satisfied.

Constructor Summary

Constructors

Modifier	Constructor and Description
	AccessStoppingCondition() Initializes a new instance.
	AccessStoppingCondition(AccessQuery query) Initializes a new instance with the specified query.
	AccessStoppingCondition(AccessQuery query, ValueDefinition<AccessClassification> stoppingClassification) Initializes a new instance with the specified query.
	AccessStoppingCondition(AccessQuery query, ValueDefinition<AccessClassification> stoppingClassification, IServiceProvider timeObserver) Initializes a new instance with the specified query and time observer.
protected	AccessStoppingCondition(AccessStoppingCondition existingInstance, CopyContext context) Initializes a new instance as a copy of an existing instance.

Method Summary

Modifier and Type	Method and Description
protected boolean	checkForSameDefinition(AccessStoppingCondition other) Checks to determine if another instance has the same definition as this instance and returns true if it does.
protected boolean	checkForSameDefinition(StoppingCondition 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.
ValueDefinition<Double>	createDoubleThreshold() Creates a threshold ValueDefinition that represents the StoppingClassification (get / set).
void	enumerateDependencies(DependencyEnumerator enumerator) Enumerates the dependencies of this object by calling DependencyEnumerator#enumerate(T) for each object that this object directly depends upon.
StoppingConditionEvaluator	getEvaluator(EvaluatorGroup group) Gets a StoppingConditionEvaluator for use in the NumericalPropagator.
AccessQuery	getQuery() Gets the AccessQuery that will trigger this stopping condition.
ValueDefinition<AccessClassification>	getStoppingClassification() Gets the access classification to stop on.
IServiceProvider	getTimeObserver() Gets the time observer of the access query.
void	setQuery(AccessQuery value) Sets the AccessQuery that will trigger this stopping condition.
void	setStoppingClassification(ValueDefinition<AccessClassification> value) Sets the access classification to stop on.
void	setTimeObserver(IServiceProvider value) Sets the time observer of the access query.

Methods inherited from class agi.foundation.stoppingconditions.StoppingCondition

checkForSameDefinition, freezeAggregatedObjects, getAngularSetting, getConstraints, getEnabled, getFunctionTolerance, getName, getRequireFunctionTolerance, getSatisfiedCallback, getStopOnEventNumber, getTypeOfStoppingCondition, setAngularSetting, setEnabled, setFunctionTolerance, setName, setRequireFunctionTolerance, setSatisfiedCallback, setStopOnEventNumber, setTypeOfStoppingCondition, validateProperties

Methods inherited from class agi.foundation.infrastructure.DefinitionalObject

areSameDefinition, areSameDefinition, areSameDefinition, areSameDefinition, areSameDefinition, collectionItemsAreSameDefinition, collectionItemsAreSameDefinition, collectionItemsAreSameDefinition, dictionaryItemsAreSameDefinition, freeze, getCollectionHashCode, getCollectionHashCode, getCollectionHashCode, getDefinitionHashCode, getDefinitionHashCode, getDefinitionHashCode, getDefinitionHashCode, getDefinitionHashCode, getDefinitionHashCode, getDictionaryHashCode, getIsFrozen, isSameDefinition, throwIfFrozen

Methods inherited from class java.lang.Object

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

Constructor Detail

AccessStoppingCondition

public AccessStoppingCondition()

Initializes a new instance.

AccessStoppingCondition

public AccessStoppingCondition(AccessQuery query)

Initializes a new instance with the specified query. The StoppingClassification (get / set) defaults to a constant value definition where AccessClassification.ACCESS_EXISTS and the TimeObserver (get / set) defaults to null.

Parameters:

query - The query to analyze for this stopping condition.

AccessStoppingCondition

public AccessStoppingCondition(AccessQuery query,
                               ValueDefinition<AccessClassification> stoppingClassification)

Initializes a new instance with the specified query. The TimeObserver (get / set) defaults to null.

Parameters:

query - The query to analyze for this stopping condition.

stoppingClassification - The classification to stop on. See AccessClassification for more information.

AccessStoppingCondition

public AccessStoppingCondition(AccessQuery query,
                               ValueDefinition<AccessClassification> stoppingClassification,
                               IServiceProvider timeObserver)

Initializes a new instance with the specified query and time observer.

Parameters:

query - The query to analyze for this stopping condition.

stoppingClassification - The classification to stop on. See AccessClassification for more information.

timeObserver - The IServiceProvider time observer to use when evaluating this query.

AccessStoppingCondition

protected AccessStoppingCondition(@Nonnull
                                  AccessStoppingCondition existingInstance,
                                  @Nonnull
                                  CopyContext context)

Initializes a new instance as a copy of an existing instance.

See ICloneWithContext.clone(CopyContext) for more information about how to implement this constructor in a derived class.

Parameters:

existingInstance - The existing instance to copy.

context - A CopyContext that controls the depth of the copy.

Throws:

ArgumentNullException - Thrown when existingInstance or context is null.

Method Detail

clone

public Object clone(CopyContext context)

Clones this object using the specified 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:

1. Fields that are aggregate parts of the object should always be copied. A referenced object is an aggregate if properties or methods on the object being copied can modify the externally-visible value of the referenced object.
2. If the semantics of the referenced object require that it have a single parent, owner, context, etc., and the object being copied is that parent, owner, or context, then the referenced object should always be copied.

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:

1. For references to other evaluators ONLY, simply assign the reference in the constructor instead of calling CopyContext.updateReference(T). You should still call CopyContext.updateReference(T) on any references to non-evaluators.
2. Call IEvaluator.updateEvaluatorReferences(agi.foundation.infrastructure.CopyContext) as the last line in the constructor and pass it the same CopyContext passed to the constructor.
3. Implement 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;

Specified by:

clone in interface ICloneWithContext

Specified by:

clone in class DefinitionalObject

Parameters:

context - The context to use to perform the copy.

Returns:

A new instance which is a copy of this object.

checkForSameDefinition

protected final boolean checkForSameDefinition(StoppingCondition other)

Checks to determine if another instance has the same definition as this instance and returns 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).

Specified by:

checkForSameDefinition in class StoppingCondition

Parameters:

other - The other instance to compare to this one.

Returns:

true if the two objects are defined equivalently; otherwise false.

checkForSameDefinition

protected boolean checkForSameDefinition(AccessStoppingCondition other)

Checks to determine if another instance has the same definition as this instance and returns 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).

Parameters:

other - The other instance to compare to this one.

Returns:

true if the two objects are defined equivalently; otherwise false.

computeCurrentDefinitionHashCode

protected int computeCurrentDefinitionHashCode()

Computes a hash code based on the current properties of this object. Derived classes MUST override this method and compute a hash code that combines: a unique hash code seed, the base implementation result, and the hash codes of all new fields introduced by the derived class which are used in the AccessStoppingCondition.checkForSameDefinition(agi.foundation.stoppingconditions.StoppingCondition) method.

Overrides:

computeCurrentDefinitionHashCode in class StoppingCondition

Returns:

The computed hash code.

enumerateDependencies

public void enumerateDependencies(DependencyEnumerator enumerator)

Enumerates the dependencies of this object by calling 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.

Specified by:

enumerateDependencies in interface IEnumerateDependencies

Overrides:

enumerateDependencies in class StoppingCondition

Parameters:

enumerator - The enumerator that is informed of the dependencies of this object.

createDoubleThreshold

@Nonnull
public ValueDefinition<Double> createDoubleThreshold()

Creates a threshold ValueDefinition that represents the StoppingClassification (get / set). The map from stopping condition to value is as follows:

• AccessClassification.ACCESS_EXISTS maps to 1.0
• AccessClassification.NO_ACCESS maps to 0.0
• AccessClassification.ACCESS_UNKNOWN maps to -1.0

Specified by:

createDoubleThreshold in class StoppingCondition

Returns:

The threshold as a ValueDefinition where the type is a double.

getStoppingClassification

public final ValueDefinition<AccessClassification> getStoppingClassification()

Gets the access classification to stop on.

setStoppingClassification

public final void setStoppingClassification(ValueDefinition<AccessClassification> value)

Sets the access classification to stop on.

getQuery

public final AccessQuery getQuery()

Gets the AccessQuery that will trigger this stopping condition.

setQuery

public final void setQuery(AccessQuery value)

Sets the AccessQuery that will trigger this stopping condition.

getTimeObserver

public final IServiceProvider getTimeObserver()

Gets the time observer of the access query. By default this is null.

Some access queries require this to be set before computation.

setTimeObserver

public final void setTimeObserver(IServiceProvider value)

Sets the time observer of the access query. By default this is null.

Some access queries require this to be set before computation.

getEvaluator

public StoppingConditionEvaluator getEvaluator(EvaluatorGroup group)

Gets a StoppingConditionEvaluator for use in the NumericalPropagator.

Derived classes should call StoppingCondition.validateProperties() to check properties owned by this base class, as well as validate their own properties.

Specified by:

getEvaluator in class StoppingCondition

Parameters:

group - The group to use to initialize any evaluators that will be used by the condition and its Constraints (get).

Returns:

An evaluator for this StoppingCondition.