Click or drag to resize

ThresholdStoppingConditionConstraintEvaluator Class

Inheritance Hierarchy
SystemObject
  AGI.Foundation.StoppingConditionsStoppingConditionConstraintEvaluator
    AGI.Foundation.StoppingConditionsThresholdStoppingConditionConstraintEvaluator

Namespace:  AGI.Foundation.StoppingConditions
Assembly:  AGI.Foundation.Models (in AGI.Foundation.Models.dll) Version: 20.3.405.0 (20.3.405.0)
Syntax
public abstract class ThresholdStoppingConditionConstraintEvaluator : StoppingConditionConstraintEvaluator

The ThresholdStoppingConditionConstraintEvaluator type exposes the following members.

Constructors
Properties
  NameDescription
Public propertyGroup
Gets the group that contains this evaluator.
(Inherited from StoppingConditionConstraintEvaluator.)
Public propertyIsThreadSafe
Gets a value indicating whether the methods on this instance are safe to call from multiple threads simultaneously.
(Overrides StoppingConditionConstraintEvaluatorIsThreadSafe.)
Public propertyName
Gets an optional name for this StoppingConditionConstraintEvaluator.
(Inherited from StoppingConditionConstraintEvaluator.)
Public propertyWhenToCheck
Gets when to check the constraint (when an event is detected or exactly found). See the documentation of WhenToCheckConstraint to help decide which one to pick.
(Inherited from StoppingConditionConstraintEvaluator.)
Top
Methods
  NameDescription
Public methodCheckCurrentState
This method gets called every time a new ITimeBasedState is checked by the parent StoppingConditionEvaluator. This method should be used when the criteria of your StoppingConditionConstraintEvaluator needs to check every computed state. For example, ThresholdStoppingConditionConstraintEvaluator needs to keep track of extrema if its InequalityCriteria is set to GreaterThanMinimum or LessThanMaximum.
(Overrides StoppingConditionConstraintEvaluatorCheckCurrentState(ITimeBasedState).)
Public methodClone
Clones this object using the specified context.
(Inherited from StoppingConditionConstraintEvaluator.)
Public methodDispose
Releases any resources associated with this instance.
(Inherited from StoppingConditionConstraintEvaluator.)
Protected methodDispose(Boolean)
Releases any resources associated with this instance.
(Inherited from StoppingConditionConstraintEvaluator.)
Public methodEquals
Determines whether the specified Object is equal to the current Object.
(Inherited from Object.)
Protected methodEvaluateSingleValue

This method will return the value that will be compared to the Threshold. This method does not need to deal with UseAbsoluteValue.

Protected methodFinalize
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object.)
Public methodGetAvailabilityIntervals
Gets the intervals over which data is available.
(Inherited from StoppingConditionConstraintEvaluator.)
Public methodGetCachingWrapper
Gets a version of this evaluator that caches the previously computed value so that if it is evaluated twice at the same date the computation is done only once.
(Inherited from StoppingConditionConstraintEvaluator.)
Public methodGetHashCode
Serves as a hash function for a particular type.
(Inherited from Object.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodInitialize
Initialize the constraint with the initialState. This is useful for when the constraint is comparing the current value with the initial (such as something related to the duration of propagation).
(Inherited from StoppingConditionConstraintEvaluator.)
Public methodIsAvailable
Determines if valid data is available for the given JulianDate.
(Inherited from StoppingConditionConstraintEvaluator.)
Public methodIsConstraintSatisfied
This method will examine from the state and return if this constraint is satisfied, and if not.
(Overrides StoppingConditionConstraintEvaluatorIsConstraintSatisfied(ITimeBasedState).)
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public methodStatic memberSimpleCheck
Performs a simple check of the currentValue against a threshold and tolerance, using the useAbsoluteValue and inequalityCriteria to determine if this constraint is satisfied by the currentValue. This method can be called by IsConstraintSatisfied(ITimeBasedState) if your constraint is simply computing a value to be compared to a threshold.
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Public methodUpdateEvaluatorReferences
Updates the evaluator references held by this object using the reference-to-reference mapping in the specified CopyContext.
(Inherited from StoppingConditionConstraintEvaluator.)
Top
See Also