Click or drag to resize

AccessStoppingCondition Class

A StoppingCondition that will stop after an access query is satisfied.
Inheritance Hierarchy

Namespace:  AGI.Foundation.StoppingConditions
Assembly:  AGI.Foundation.Models (in AGI.Foundation.Models.dll) Version: 19.5.402.0 (19.5.402.0)
Syntax
public class AccessStoppingCondition : StoppingCondition

The AccessStoppingCondition type exposes the following members.

Constructors
  NameDescription
Public methodAccessStoppingCondition
Initializes a new instance.
Public methodAccessStoppingCondition(AccessQuery)
Initializes a new instance with the specified query. The StoppingClassification defaults to a constant value definition where AccessExists and the TimeObserver defaults to .
Public methodAccessStoppingCondition(AccessQuery, ValueDefinitionAccessClassification)
Initializes a new instance with the specified query. The TimeObserver defaults to .
Protected methodAccessStoppingCondition(AccessStoppingCondition, CopyContext)
Initializes a new instance as a copy of an existing instance.
Public methodAccessStoppingCondition(AccessQuery, ValueDefinitionAccessClassification, IServiceProvider)
Initializes a new instance with the specified query and time observer.
Top
Properties
  NameDescription
Public propertyAngularSetting
Gets or sets the range a value should be cropped to if the value computed is a angle, or indicates that the value computed is not an angle. By default this is set to NotCircular.
(Inherited from StoppingCondition.)
Public propertyConstraints
Gets additional constraints on the stopping condition. The constraints allow you to add extra criteria to whether an event should be considered valid to stop on. See their help for more information.
(Inherited from StoppingCondition.)
Public propertyEnabled
Gets or sets if this StoppingCondition will be considered during propagation.
(Inherited from StoppingCondition.)
Public propertyFunctionTolerance
Gets or sets how close the function value must get to the threshold to be considered equal to. Note that even if there is unquestionably a threshold, if the event search can not converge to a value at or below this value, it will not satisfy the stopping condition and no event will be logged. This must be larger than machine precision of values near the threshold.
(Inherited from StoppingCondition.)
Public propertyIsFrozen
Gets a value indicating whether this object is frozen. A frozen object cannot be modified and an ObjectFrozenException will be thrown if an attempt is made to do so.
(Inherited from DefinitionalObject.)
Public propertyName
Gets or sets an optional name for this stopping condition.
(Inherited from StoppingCondition.)
Public propertyQuery
Gets or sets the AccessQuery that will trigger this stopping condition.
Public propertyRequireFunctionTolerance
Gets or sets a value indicating whether the FunctionTolerance does not need to be satisfied. The search for an event will still attempt to converge to within the FunctionTolerance, but if it is known that an event is there (such as a threshold crossing), the event will be reported and this condition consider satisfied even if the search did not converge within the FunctionTolerance. This is by default.
(Inherited from StoppingCondition.)
Public propertySatisfiedCallback
Gets or sets a callback that is executed when this condition is satisfied.
(Inherited from StoppingCondition.)
Public propertyStopOnEventNumber
Gets or sets how many times the threshold must be met, or how many extrema must be found before stopping. If a StoppingConditionEvaluator finds a valid stop except for a constraint being unsatisfied, that will not count as a crossing.
(Inherited from StoppingCondition.)
Public propertyStoppingClassification
Gets or sets the access classification to stop on.
Public propertyTimeObserver
Gets or sets the time observer of the access query. By default this is .
Public propertyTypeOfStoppingCondition
Gets or sets the type of the event to stop on (extrema, threshold, ...).
(Inherited from StoppingCondition.)
Top
Methods
  NameDescription
Protected methodCheckForSameDefinition(AccessStoppingCondition)
Checks to determine if another instance has the same definition as this instance and returns if it does. Derived classes MUST override this method and check all new fields introduced by the derived class for definitional equivalence. It is NOT necessary to check base class fields because the base class will already have done that. When overriding this method, you should NOT call the base implementation because it will return for all derived-class instances. Derived classes should check the type of other to preserve the symmetric nature of IsSameDefinition(Object).
Protected methodCheckForSameDefinition(DefinitionalObject)
Checks to determine if another instance has the same definition as this instance and returns if it does. Derived classes MUST override this method and check all new fields introduced by the derived class for definitional equivalence. It is NOT necessary to check base class fields because the base class will already have done that. When overriding this method, you should NOT call the base implementation because it will return for all derived-class instances. Derived classes should check the type of other to preserve the symmetric nature of IsSameDefinition(Object).
(Inherited from StoppingCondition.)
Protected methodCheckForSameDefinition(StoppingCondition)
Checks to determine if another instance has the same definition as this instance and returns if it does. Derived classes MUST override this method and check all new fields introduced by the derived class for definitional equivalence. It is NOT necessary to check base class fields because the base class will already have done that. When overriding this method, you should NOT call the base implementation because it will return for all derived-class instances. Derived classes should check the type of other to preserve the symmetric nature of IsSameDefinition(Object).
(Overrides StoppingConditionCheckForSameDefinition(StoppingCondition).)
Public methodClone
Clones this object using the specified context.
(Overrides DefinitionalObjectClone(CopyContext).)
Protected methodComputeCurrentDefinitionHashCode
Computes a hash code based on the current properties of this object. Derived classes MUST override this method and compute a hash code that combines: a unique hash code seed, the base implementation result, and the hash codes of all new fields introduced by the derived class which are used in the CheckForSameDefinition(DefinitionalObject) method.
(Overrides StoppingConditionComputeCurrentDefinitionHashCode.)
Public methodCreateDoubleThreshold (Overrides StoppingConditionCreateDoubleThreshold.)
Public methodEnumerateDependencies
Enumerates the dependencies of this object by calling EnumerateT(T) for each object that this object directly depends upon. Derived classes which contain additional dependencies MUST override this method, call the base implementation, and enumerate dependencies introduced by the derived class.
(Overrides StoppingConditionEnumerateDependencies(DependencyEnumerator).)
Public methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
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 methodFreeze
Freezes this object. Further attempts to modify it will result in an ObjectFrozenException.
(Inherited from DefinitionalObject.)
Protected methodFreezeAggregatedObjects
Called by Freeze to also freeze any objects that are considered to be a part of this object. Derived classes which contain additional aggregated objects MUST override this method, call the base implementation, and freeze aggregated objects introduced by the derived class. The objects that need to be frozen in this method are frequently created in this object's constructor and are not settable via properties.
(Inherited from StoppingCondition.)
Public methodGetDefinitionHashCode
Gets a hash code representing the definition of this object.
(Inherited from DefinitionalObject.)
Public methodGetEvaluator (Overrides StoppingConditionGetEvaluator(EvaluatorGroup).)
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodIsSameDefinition
Determines if this object has the same definition as another object.
(Inherited from DefinitionalObject.)
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Protected methodThrowIfFrozen
Throws ObjectFrozenException if this object IsFrozen. This method should be called from any method or property that modifies this object.
(Inherited from DefinitionalObject.)
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Protected methodValidateProperties
Validates that required properties are configured correctly in order to get an evaluator for this instance. Derived classes should call this method when implementing GetEvaluator(EvaluatorGroup), as well as validate their own properties.
(Inherited from StoppingCondition.)
Top
See Also