agi.foundation.access

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

Class CircularAccessConstraint

java.lang.Object

agi.foundation.infrastructure.DefinitionalObject

agi.foundation.access.AccessQuery

agi.foundation.access.AccessConstraint

agi.foundation.access.CircularAccessConstraint

All Implemented Interfaces:

ICloneWithContext, IEnumerateDependencies, IEquatableDefinition, IFreezable

Direct Known Subclasses:

AngleInPlaneConstraint, AzimuthAngleConstraint

public abstract class CircularAccessConstraint
extends AccessConstraint

Defines methods for implementing a circular function used to compute access.

Evaluators produced by this class should derive from CircularAccessConstraint.CircularAccessConstraintEvaluator.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	CircularAccessConstraint.CircularAccessConstraintEvaluator Base class for Access constraint evaluators which evaluate circular functions.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	CircularAccessConstraint() Initializes a new instance.
protected	CircularAccessConstraint(CircularAccessConstraint 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(AccessConstraint other) Checks to determine if another instance has the same definition as this instance and returns true if it does.
protected abstract boolean	checkForSameDefinition(CircularAccessConstraint other) Checks to determine if another instance has the same definition as this instance and returns true if it does.
protected int	computeCurrentDefinitionHashCode() Computes a hash code based on the current properties of this object.
double	getNormalizedStartAngle() Gets the normalized value of StartAngle (get / set) which lies within Constants.TwoPi of zero.
double	getNormalizedStopAngle() Gets the normalized value of StopAngle (get / set) which lies within Constants.TwoPi of zero.
double	getStartAngle() Gets the angle defining the beginning of the satisfaction region.
double	getStopAngle() Gets the angle defining the end of the satisfaction region
double	getTolerance() Gets the tolerance on the constraint value to use when computing the time when this constraint crosses its threshold.
void	setAngularRegion(double startAngle, double stopAngle) Sets the satisfaction region given the two angles forming the boundary: StartAngle (get / set) and StopAngle (get / set).
void	setStartAngle(double value) Sets the angle defining the beginning of the satisfaction region.
void	setStopAngle(double value) Sets the angle defining the end of the satisfaction region
void	setTolerance(double value) Sets the tolerance on the constraint value to use when computing the time when this constraint crosses its threshold.

Methods inherited from class agi.foundation.access.AccessConstraint

buildQueryEvaluator, checkForSameDefinition, enumerateDependencies, 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, clone, 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

CircularAccessConstraint

protected CircularAccessConstraint()

Initializes a new instance.

CircularAccessConstraint

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

checkForSameDefinition

protected final boolean checkForSameDefinition(AccessConstraint 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 AccessConstraint

Parameters:

other - The other instance to compare to this one.

Returns:

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

checkForSameDefinition

protected abstract boolean checkForSameDefinition(CircularAccessConstraint 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 CircularAccessConstraint.checkForSameDefinition(agi.foundation.access.AccessConstraint) method.

Overrides:

computeCurrentDefinitionHashCode in class AccessConstraint

Returns:

The computed hash code.

getStartAngle

public final double getStartAngle()

Gets the angle defining the beginning of the satisfaction region.

setStartAngle

public final void setStartAngle(double value)

Sets the angle defining the beginning of the satisfaction region.

getStopAngle

public final double getStopAngle()

Gets the angle defining the end of the satisfaction region

setStopAngle

public final void setStopAngle(double value)

Sets the angle defining the end of the satisfaction region

getNormalizedStartAngle

public final double getNormalizedStartAngle()

Gets the normalized value of StartAngle (get / set) which lies within Constants.TwoPi of zero.

getNormalizedStopAngle

public final double getNormalizedStopAngle()

Gets the normalized value of StopAngle (get / set) which lies within Constants.TwoPi of zero.

getTolerance

public final double getTolerance()

Gets the tolerance on the constraint value to use when computing the time when this constraint crosses its threshold.

setTolerance

public final void setTolerance(double value)

Sets the tolerance on the constraint value to use when computing the time when this constraint crosses its threshold.

setAngularRegion

public final void setAngularRegion(double startAngle,
                                   double stopAngle)

Sets the satisfaction region given the two angles forming the boundary: StartAngle (get / set) and StopAngle (get / set). The region is defined from the startAngle increasing to the stopAngle.

Parameters:

startAngle - The angle at the start of the boundary.

stopAngle - The angle at the end of the boundary.