agi.foundation.access

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

Class MinimumMaximumAccessConstraint

java.lang.Object

agi.foundation.infrastructure.DefinitionalObject

agi.foundation.access.AccessQuery

agi.foundation.access.AccessConstraint

agi.foundation.access.MinimumMaximumAccessConstraint

All Implemented Interfaces:

ICloneWithContext, IEnumerateDependencies, IEquatableDefinition, IFreezable

Direct Known Subclasses:

AltitudeConstraint, AngleOutOfPlaneConstraint, AzimuthAngleRateConstraint, AzimuthElevationMaskConstraint, CentralBodySurfaceCurveElevationAngleConstraint, CentralBodySurfaceRegionElevationAngleConstraint, CircularEquatorialOrbitGrazingAngleConstraint, CommunicationLinkConstraint, CommunicationObjectConstraint, CovarianceSeparationConstraint, DilutionOfPrecisionConstraint, ElevationAngleConstraint, ElevationAngleRateConstraint, GroundSampleDistanceConstraint, HeightAboveHorizonConstraint, NavigationAccuracyAssessedConstraint, NavigationAccuracyPredictedConstraint, RangeConstraint, RangeRateConstraint, ScalarConstraint, SingleTargetRadarObjectConstraint, SurfaceDistanceConstraint, ThirdBodyElevationAngleConstraint, TotalAngularRateConstraint

public abstract class MinimumMaximumAccessConstraint
extends AccessConstraint

The base class for Access constraints where the function must lie between a minimum value and a maximum value in order for the constraint to be considered satisfied.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	MinimumMaximumAccessConstraint.MinMaxThresholdEvaluator A convenient base class to use for the evaluators for constraints derived from MinimumMaximumAccessConstraint.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	MinimumMaximumAccessConstraint() Initializes a new instance.
protected	MinimumMaximumAccessConstraint(MinimumMaximumAccessConstraint 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(MinimumMaximumAccessConstraint 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.
boolean	getIsMaximumEnabled() Gets a value indicating whether a maximum threshold is used in calculating constraint satisfaction.
boolean	getIsMinimumEnabled() Gets a value indicating whether a minimum threshold is used in calculating constraint satisfaction.
double	getMaximumTolerance() Gets the tolerance associated with the MaximumValue (get / set) to be used when computing threshold crossings.
double	getMaximumValue() Gets the maximum function value that is allowed for this constraint to be satisfied.
double	getMinimumTolerance() Gets the tolerance associated with the MinimumValue (get / set) to be used when computing threshold crossings.
double	getMinimumValue() Gets the minimum function value that is required for this constraint to be satisfied.
void	setIsMaximumEnabled(boolean value) Sets a value indicating whether a maximum threshold is used in calculating constraint satisfaction.
void	setIsMinimumEnabled(boolean value) Sets a value indicating whether a minimum threshold is used in calculating constraint satisfaction.
void	setMaximumTolerance(double value) Sets the tolerance associated with the MaximumValue (get / set) to be used when computing threshold crossings.
void	setMaximumValue(double value) Sets the maximum function value that is allowed for this constraint to be satisfied.
void	setMinimumTolerance(double value) Sets the tolerance associated with the MinimumValue (get / set) to be used when computing threshold crossings.
void	setMinimumValue(double value) Sets the minimum function value that is required for this constraint to be satisfied.

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

MinimumMaximumAccessConstraint

protected MinimumMaximumAccessConstraint()

Initializes a new instance.

MinimumMaximumAccessConstraint

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

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

Overrides:

computeCurrentDefinitionHashCode in class AccessConstraint

Returns:

The computed hash code.

getMinimumValue

public final double getMinimumValue()

Gets the minimum function value that is required for this constraint to be satisfied. By default, this is Double.NEGATIVE_INFINITY.

setMinimumValue

public final void setMinimumValue(double value)

Sets the minimum function value that is required for this constraint to be satisfied. By default, this is Double.NEGATIVE_INFINITY.

getMaximumValue

public final double getMaximumValue()

Gets the maximum function value that is allowed for this constraint to be satisfied. By default this is Double.POSITIVE_INFINITY.

setMaximumValue

public final void setMaximumValue(double value)

Sets the maximum function value that is allowed for this constraint to be satisfied. By default this is Double.POSITIVE_INFINITY.

getIsMinimumEnabled

public final boolean getIsMinimumEnabled()

Gets a value indicating whether a minimum threshold is used in calculating constraint satisfaction.

setIsMinimumEnabled

public final void setIsMinimumEnabled(boolean value)

Sets a value indicating whether a minimum threshold is used in calculating constraint satisfaction.

getIsMaximumEnabled

public final boolean getIsMaximumEnabled()

Gets a value indicating whether a maximum threshold is used in calculating constraint satisfaction.

setIsMaximumEnabled

public final void setIsMaximumEnabled(boolean value)

Sets a value indicating whether a maximum threshold is used in calculating constraint satisfaction.

getMinimumTolerance

public final double getMinimumTolerance()

Gets the tolerance associated with the MinimumValue (get / set) to be used when computing threshold crossings.

In comparison to other AccessConstraints, this tolerance should reflect the MinimumValue (get / set). If the MinimumValue (get / set) is nearly zero, the tolerance should be small. The default tolerance is Constants.Epsilon8. However, it is recommended that if MinimumValue (get / set) is small, the tolerance should be set to Constants.Epsilon8 multiplied by the MinimumValue (get / set).

Throws:

ArgumentOutOfRangeException - The value of the tolerance must be positive and non-zero.

setMinimumTolerance

public final void setMinimumTolerance(double value)

Sets the tolerance associated with the MinimumValue (get / set) to be used when computing threshold crossings.

In comparison to other AccessConstraints, this tolerance should reflect the MinimumValue (get / set). If the MinimumValue (get / set) is nearly zero, the tolerance should be small. The default tolerance is Constants.Epsilon8. However, it is recommended that if MinimumValue (get / set) is small, the tolerance should be set to Constants.Epsilon8 multiplied by the MinimumValue (get / set).

Throws:

ArgumentOutOfRangeException - The value of the tolerance must be positive and non-zero.

getMaximumTolerance

public final double getMaximumTolerance()

Gets the tolerance associated with the MaximumValue (get / set) to be used when computing threshold crossings.

In comparison to other AccessConstraints, this tolerance should reflect the MaximumValue (get / set). If the MaximumValue (get / set) is nearly zero, the tolerance should be small. The default tolerance is Constants.Epsilon8. However, it is recommended that if MaximumValue (get / set) is small, the tolerance should be set to Constants.Epsilon8 multiplied by the MaximumValue (get / set).

Throws:

ArgumentOutOfRangeException - The value of the tolerance must be positive and non-zero.

setMaximumTolerance

public final void setMaximumTolerance(double value)

Sets the tolerance associated with the MaximumValue (get / set) to be used when computing threshold crossings.

In comparison to other AccessConstraints, this tolerance should reflect the MaximumValue (get / set). If the MaximumValue (get / set) is nearly zero, the tolerance should be small. The default tolerance is Constants.Epsilon8. However, it is recommended that if MaximumValue (get / set) is small, the tolerance should be set to Constants.Epsilon8 multiplied by the MaximumValue (get / set).

Throws:

ArgumentOutOfRangeException - The value of the tolerance must be positive and non-zero.