Click or drag to resize

StoppingConditionEvaluator Methods

The StoppingConditionEvaluator type exposes the following members.

Methods
  NameDescription
Public methodCheckForExactCrossing
Checks to see if the state is at the exact threshold to within machine tolerance.
Public methodClone
Clones this object using the specified context.
Public methodComputeThreshold
Computes the threshold for this StoppingConditionEvaluator, or throws an Exception if this evaluator is searching for an extrema.
Public methodDispose
Releases any resources associated with this instance.
Protected methodDispose(Boolean)
Releases any resources associated with this instance.
Public methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Public methodEvaluateRawValue
Returns the raw value before it is bound by circular constraints. This method does not need to deal with the AngularSetting.
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.
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.
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodGetNextSampleSuggestion
Gets the next step that the thing that is sampling this StoppingConditionEvaluator should take. The returned Duration must be signed correctly. Override this method if this particular stopping condition has some sense of how it should be sampled, or if it somehow knows at what time it's extrema or thresholds will occur at.
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodGetValue
Compute the value of the stopping condition from the state. This method will put the raw value into the circular bounds (if the function is circular).
Public methodInitialize

Initialize the StoppingConditionEvaluator with the initial state of propagation. This method is useful if the value that the StoppingConditionEvaluator evaluates is related to the initial state (for example, if this StoppingConditionEvaluator value is the span of time from the start of propagation to whatever the current time is, you will need to store that initial date in the derived type).

When overriding this method, the base method must be called.

Public methodIsAvailable
Returns if valid data is available for this Julian date, otherwise returns .
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
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.
Top
See Also