Click or drag to resize

ThresholdStoppingConditionConstraintEvaluator Methods

The ThresholdStoppingConditionConstraintEvaluator type exposes the following members.

Methods
  NameDescription
Public methodCheckCurrentState
This method gets called every time a new state is checked by the parent stopping condition. This method should be used when the criteria of your StoppingConditionConstraintEvaluator needs to check every computed state, such as the case with the ThresholdStoppingConditionConstraintEvaluator need 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 the 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. If the availability interval is infinite, this returns Infinite.
(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 the default hash function.
(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
Returns if valid data is available for this Julian date, otherwise returns .
(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. The UseAbsoluteValue flag and the InequalityCriteria options are used in this method to determine if this constraint is satisfied with the currentValue. This method should be called in the IsConstraintSatisfied(ITimeBasedState) method 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