agi.foundation.access

Class MinimumMaximumAccessConstraint.MinMaxThresholdEvaluator

java.lang.Object

agi.foundation.Function2<JulianDate,T>

agi.foundation.MotionEvaluator1<Double>

agi.foundation.access.AccessConstraintEvaluator

agi.foundation.access.MinimumMaximumAccessConstraint.MinMaxThresholdEvaluator

All Implemented Interfaces:

IDisposable, IEvaluator, IEvaluator1<Double>, ICloneWithContext, IIsTimeVarying, IThreadAware, IAvailability, AutoCloseable

Enclosing class:

MinimumMaximumAccessConstraint

protected abstract static class MinimumMaximumAccessConstraint.MinMaxThresholdEvaluator
extends AccessConstraintEvaluator

A convenient base class to use for the evaluators for constraints derived from MinimumMaximumAccessConstraint.

Field Summary

Fields inherited from class agi.foundation.access.AccessConstraintEvaluator

DefaultTolerance

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	MinMaxThresholdEvaluator(EvaluatorGroup group, MinimumMaximumAccessConstraint constraint, boolean isMinimum) Initializes a new instance based on a given minimum or maximum threshold value.
protected	MinMaxThresholdEvaluator(MinimumMaximumAccessConstraint.MinMaxThresholdEvaluator existingInstance, CopyContext context) Initializes a new instance as a copy of an existing instance.

Method Summary

Modifier and Type	Method and Description
protected double	getConstraintValueFromFunctionValue(double functionValue) Adjusts a raw function value to be above zero when the value is between the MinimumValue (get / set) and MaximumValue (get / set), and less than zero when it is outside that range.

Methods inherited from class agi.foundation.access.AccessConstraintEvaluator

getCachingWrapper, getDebuggingLogger, getQueryEvaluator, getTolerance, isSatisfied, setDebuggingLogger, setTolerance

Methods inherited from class agi.foundation.MotionEvaluator1

evaluate, evaluate, evaluate, evaluate, evaluate, evaluate, getAvailabilityIntervals, getAvailabilityIntervals, getGroup, getIsTimeVarying, isAvailable, updateEvaluatorReferences

Methods inherited from class agi.foundation.Function2

clone, dispose, dispose, getIsThreadSafe, getNextSampleSuggestion

Methods inherited from class java.lang.Object

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

Methods inherited from interface agi.foundation.infrastructure.IThreadAware

getIsThreadSafe

Methods inherited from interface agi.foundation.infrastructure.ICloneWithContext

clone

Methods inherited from interface agi.foundation.compatibility.IDisposable

close, dispose

Constructor Detail

MinMaxThresholdEvaluator

protected MinMaxThresholdEvaluator(@Nonnull
                                   EvaluatorGroup group,
                                   @Nonnull
                                   MinimumMaximumAccessConstraint constraint,
                                   boolean isMinimum)

Initializes a new instance based on a given minimum or maximum threshold value.

Parameters:

group - The group that contains this evaluator.

constraint - The constraint which determines the threshold information.

isMinimum - Flag to indicate whether to evaluate the minimum or maximum threshold.

Throws:

ArgumentNullException - Thrown when group or constraint is null.

MinMaxThresholdEvaluator

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

getConstraintValueFromFunctionValue

protected final double getConstraintValueFromFunctionValue(double functionValue)

Adjusts a raw function value to be above zero when the value is between the MinimumValue (get / set) and MaximumValue (get / set), and less than zero when it is outside that range. The evaluator of any constraint that derives from MinimumMaximumAccessConstraint should call this method in its Evaluate method with the raw function value and return the value that this method returns.

Parameters:

functionValue - The raw function value.

Returns:

The adjusted value.