agi.foundation.access.constraints

(agi.foundation.platforms-2024r2.jar)

Class ScalarConstraint

java.lang.Object

agi.foundation.infrastructure.DefinitionalObject

agi.foundation.access.AccessQuery

agi.foundation.access.AccessConstraint

agi.foundation.access.MinimumMaximumAccessConstraint

agi.foundation.access.constraints.ScalarConstraint

All Implemented Interfaces:

ISingleObjectConstraint, ICloneWithContext, IEnumerateDependencies, IEquatableDefinition, IFreezable

public class ScalarConstraint
extends MinimumMaximumAccessConstraint
implements ISingleObjectConstraint

A class representing a generalized constraint based on a given evaluator with a minimum and maximum threshold value which indicate the satisfaction region. This constraint can be used to evaluate angles created from geometry types or to evaluate arbitrary scalar functions.

See Also:

ScalarAngleBetweenVectors, ScalarDihedralAngle

Nested Class Summary

Nested classes/interfaces inherited from class agi.foundation.access.MinimumMaximumAccessConstraint

MinimumMaximumAccessConstraint.MinMaxThresholdEvaluator

Constructor Summary

Constructors

Modifier	Constructor and Description
	ScalarConstraint() Initializes a new instance with default values.
	ScalarConstraint(IServiceProvider constrainedObject, Scalar scalar, double minimumValue) Initializes a new instance with the specified constrained object, scalar, and minimum value.
	ScalarConstraint(IServiceProvider constrainedObject, Scalar scalar, double minimumValue, double maximumValue) Initializes a new instance with the specified constrained object, scalar, minimum value, and maximum value.
protected	ScalarConstraint(ScalarConstraint existingInstance, CopyContext context) Initializes a new instance as a copy of an existing instance.
	ScalarConstraint(Scalar scalar, double minimumValue) Initializes a new instance with the specified scalar and minimum value.
	ScalarConstraint(Scalar scalar, double minimumValue, double maximumValue) Initializes a new instance with the specified scalar, minimum value, and maximum value.

Method Summary

Modifier and Type	Method and Description
void	buildQueryEvaluator(ConstraintQueryBuilder builder, EvaluatorGroup group) Builds a query evaluator from this constraint.
protected boolean	checkForSameDefinition(MinimumMaximumAccessConstraint other) Checks to determine if another instance has the same definition as this instance and returns true if it does.
protected boolean	checkForSameDefinition(ScalarConstraint 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.
void	enumerateDependencies(DependencyEnumerator enumerator) Enumerates the dependencies of this object by calling DependencyEnumerator#enumerate(T) for each object that this object directly depends upon.
IServiceProvider	getConstrainedObject() Gets the object to which this constraint applies.
Scalar	getScalar() Gets the scalar function to compare to MinimumValue (get / set) and MaximumValue (get / set).
void	setConstrainedObject(IServiceProvider value) Sets the object to which this constraint applies.
void	setScalar(Scalar value) Sets the scalar function to compare to MinimumValue (get / set) and MaximumValue (get / set).
String	toString() Returns a string representation of the object.

Methods inherited from class agi.foundation.access.MinimumMaximumAccessConstraint

checkForSameDefinition, getIsMaximumEnabled, getIsMinimumEnabled, getMaximumTolerance, getMaximumValue, getMinimumTolerance, getMinimumValue, setIsMaximumEnabled, setIsMinimumEnabled, setMaximumTolerance, setMaximumValue, setMinimumTolerance, setMinimumValue

Methods inherited from class agi.foundation.access.AccessConstraint

checkForSameDefinition, freezeAggregatedObjects, getApplicability, getEvaluationOrder, getEvaluator, getSampling, setApplicability, setEvaluationOrder, toDisjunctiveNormalForm

Methods inherited from class agi.foundation.access.AccessQuery

and, and, anyPath, anyPath, anyPath, anyPath, anyPath, anyPath, atLeastN, atMostN, checkForSameDefinition, exactlyN, fromObject, fromObjectAllowNoConstraints, getDebuggingLogger, getEvaluator, getEvaluator, not, or, or, setDebuggingLogger

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, wait, wait, wait

Constructor Detail

ScalarConstraint

public ScalarConstraint()

Initializes a new instance with default values.

Before evaluating this constraint using AccessComputation, the user must set the MinimumValue (get / set) property, the MaximumValue (get / set) property, or both. Before evaluating this constraint as part of an AccessQuery, it is also necessary to set the ConstrainedObject (get / set) property.

ScalarConstraint

public ScalarConstraint(Scalar scalar,
                        double minimumValue)

Initializes a new instance with the specified scalar and minimum value.

This constraint is ready for use with AccessComputation after being constructed using this constructor. However, before evaluating this constraint as part of an AccessQuery, it is necessary to set the ConstrainedObject (get / set) property.

Parameters:

scalar - The scalar function to constrain.

minimumValue - The minimum allowed scalar value.

ScalarConstraint

public ScalarConstraint(IServiceProvider constrainedObject,
                        Scalar scalar,
                        double minimumValue)

Initializes a new instance with the specified constrained object, scalar, and minimum value.

This constraint is ready for use with both AccessComputation and AccessQuery after being constructed using this constructor.

Parameters:

constrainedObject - The object to which this constraint applies. See ConstrainedObject (get / set) for more information.

scalar - The scalar function to constrain.

minimumValue - The minimum allowed scalar value.

ScalarConstraint

public ScalarConstraint(Scalar scalar,
                        double minimumValue,
                        double maximumValue)

Initializes a new instance with the specified scalar, minimum value, and maximum value.

This constraint is ready for use with AccessComputation after being constructed using this constructor. However, before evaluating this constraint as part of an AccessQuery, it is necessary to set the ConstrainedObject (get / set) property.

Parameters:

scalar - The scalar function to constrain.

minimumValue - The minimum allowed scalar value.

maximumValue - The maximum allowed scalar value.

ScalarConstraint

public ScalarConstraint(IServiceProvider constrainedObject,
                        Scalar scalar,
                        double minimumValue,
                        double maximumValue)

Initializes a new instance with the specified constrained object, scalar, minimum value, and maximum value.

This constraint is ready for use with both AccessComputation and AccessQuery after being constructed using this constructor.

Parameters:

constrainedObject - The object to which this constraint applies. See ConstrainedObject (get / set) for more information.

scalar - The scalar function to constrain.

minimumValue - The minimum allowed scalar value.

maximumValue - The maximum allowed scalar value.

ScalarConstraint

protected ScalarConstraint(@Nonnull
                           ScalarConstraint 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(MinimumMaximumAccessConstraint 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 MinimumMaximumAccessConstraint

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(ScalarConstraint 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 ScalarConstraint.checkForSameDefinition(agi.foundation.access.MinimumMaximumAccessConstraint) method.

Overrides:

computeCurrentDefinitionHashCode in class MinimumMaximumAccessConstraint

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 AccessConstraint

Parameters:

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

getScalar

public final Scalar getScalar()

Gets the scalar function to compare to MinimumValue (get / set) and MaximumValue (get / set).

setScalar

public final void setScalar(Scalar value)

Sets the scalar function to compare to MinimumValue (get / set) and MaximumValue (get / set).

getConstrainedObject

public final IServiceProvider getConstrainedObject()

Gets the object to which this constraint applies. This constraint does not use this property directly. However, when this constraint is part of a larger AccessQuery, this property identifies the participant that is observing the scalar, so event times will be moved to this participant before evaluating the scalar.

Specified by:

getConstrainedObject in interface ISingleObjectConstraint

setConstrainedObject

public final void setConstrainedObject(IServiceProvider value)

Sets the object to which this constraint applies. This constraint does not use this property directly. However, when this constraint is part of a larger AccessQuery, this property identifies the participant that is observing the scalar, so event times will be moved to this participant before evaluating the scalar.

Specified by:

setConstrainedObject in interface ISingleObjectConstraint

toString

public String toString()

Description copied from class: java.lang.Object

Returns a string representation of the object. In general, the toString method returns a string that "textually represents" this object. The result should be a concise but informative representation that is easy for a person to read. It is recommended that all subclasses override this method.

The toString method for class Object returns a string consisting of the name of the class of which the object is an instance, the at-sign character `@', and the unsigned hexadecimal representation of the hash code of the object. In other words, this method returns a string equal to the value of:

 getClass().getName() + '@' + Integer.toHexString(hashCode())
 

Overrides:

toString in class Object

Returns:

a string representation of the object.

buildQueryEvaluator

public void buildQueryEvaluator(ConstraintQueryBuilder builder,
                                EvaluatorGroup group)

Builds a query evaluator from this constraint.

Specified by:

buildQueryEvaluator in class AccessConstraint

Parameters:

builder - The builder instance to use to build the evaluator.

group - The evaluator group in which to create individual constraint function evaluators.