ThresholdStoppingConditionConstraintEvaluator Class

The StoppingConditionConstraintEvaluator for a ThresholdStoppingConditionConstraint.

Inheritance Hierarchy

SystemObject
AGI.Foundation.StoppingConditionsStoppingConditionConstraintEvaluator
AGI.Foundation.StoppingConditionsThresholdStoppingConditionConstraintEvaluator

Namespace: AGI.Foundation.StoppingConditions
Assembly: AGI.Foundation.Models (in AGI.Foundation.Models.dll) Version: 24.2.419.0 (24.2.419.0)

Syntax

C++

Copy

public abstract class ThresholdStoppingConditionConstraintEvaluator : StoppingConditionConstraintEvaluator

Public MustInherit Class ThresholdStoppingConditionConstraintEvaluator
	Inherits StoppingConditionConstraintEvaluator

public ref class ThresholdStoppingConditionConstraintEvaluator abstract : public StoppingConditionConstraintEvaluator

[<AbstractClassAttribute>]
type ThresholdStoppingConditionConstraintEvaluator =  
    class
        inherit StoppingConditionConstraintEvaluator
    end

The ThresholdStoppingConditionConstraintEvaluator type exposes the following members.

Constructors

	Name	Description
	ThresholdStoppingConditionConstraintEvaluator(EvaluatorGroup, ThresholdStoppingConditionConstraint)	Initializes a new instance.
	ThresholdStoppingConditionConstraintEvaluator(ThresholdStoppingConditionConstraintEvaluator, CopyContext)	Initializes a new instance as a copy of an existing instance.

Top

Properties

	Name	Description
	Group	Gets the group that contains this evaluator. (Inherited from StoppingConditionConstraintEvaluator.)
	IsThreadSafe	Gets a value indicating whether the methods on this instance are safe to call from multiple threads simultaneously. (Overrides StoppingConditionConstraintEvaluatorIsThreadSafe.)
	Name	Gets an optional name for this StoppingConditionConstraintEvaluator. (Inherited from StoppingConditionConstraintEvaluator.)
	WhenToCheck	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

	Name	Description
	CheckCurrentState	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).)
	Clone	Clones this object using the specified context. (Inherited from StoppingConditionConstraintEvaluator.)
	Dispose	Releases any resources associated with this instance. (Inherited from StoppingConditionConstraintEvaluator.)
	Dispose(Boolean)	Releases any resources associated with this instance. (Inherited from StoppingConditionConstraintEvaluator.)
	Equals	Determines whether the specified object is equal to the current object. (Inherited from Object.)
	EvaluateSingleValue	This method will return the value that will be compared to the Threshold. This method does not need to deal with UseAbsoluteValue.
	Finalize	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
	GetAvailabilityIntervals	Gets the intervals over which data is available. (Inherited from StoppingConditionConstraintEvaluator.)
	GetCachingWrapper	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.)
	GetHashCode	Serves as the default hash function. (Inherited from Object.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	Initialize	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.)
	IsAvailable	Determines if valid data is available for the given JulianDate. (Inherited from StoppingConditionConstraintEvaluator.)
	IsConstraintSatisfied	This method will examine from the state and return if this constraint is satisfied, and if not. (Overrides StoppingConditionConstraintEvaluatorIsConstraintSatisfied(ITimeBasedState).)
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	SimpleCheck	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.
	ToString	Returns a string that represents the current object. (Inherited from Object.)
	UpdateEvaluatorReferences	Updates the evaluator references held by this object using the reference-to-reference mapping in the specified CopyContext. (Inherited from StoppingConditionConstraintEvaluator.)

Top

Reference

AGI.Foundation.StoppingConditions Namespace