Click or drag to resize

AGI.Foundation.StoppingConditions Namespace

Contains types for stopping propagation when various events occur.
Classes
  ClassDescription
Public classAccessStoppingCondition
A StoppingCondition that will stop after an access query is satisfied.
Public classDelegateStoppingCondition
A stopping condition that will stop a function by search for thresholds and extrema from values of a ConditionCheckCallback.
Public classDelegateStoppingConditionConstraint
A StoppingConditionConstraintEvaluator where the method that checks if the state at a stop satisfies this StoppingConditionConstraint is specified by a delegate.
Public classDurationStoppingCondition

A StoppingCondition that will stop after a given Duration has passed. Note that the sign of the value in the Duration matters; if you are propagating backwards you will need to use a negative Threshold.

Note that the threshold tolerance for this stopping condition is set to Epsilon9 by default. That is the worst case for a Duration's precision.

Public classDurationStoppingConditionConstraint
A StoppingConditionConstraint that determines its satisfaction based on the Duration that has passed during propagation.
Public classEpochSecondsStoppingCondition

A StoppingCondition whose threshold is the number of seconds past an arbitrary epoch.

Note that the threshold tolerance for this stopping condition is set to Epsilon9 by default. That is the worst case for a Duration's precision.

Public classJulianDateStoppingConditionConstraint
A StoppingConditionConstraint that determines its satisfaction on the current JulianDate relative to a stored JulianDate.
Public classScalarStoppingCondition
A StoppingCondition that will stop propagation by search for thresholds and extrema from values of a Scalar.
Public classScalarStoppingConditionConstraint
A StoppingConditionConstraintEvaluator that compares the value of a Scalar at the time of a state with a threshold.
Public classStoppingCondition
A stopping condition will get evaluated at every step of propagation, and treat some value based on the computed state as a function. That function will then be sampled to find events such as thresholds and extrema, and propagation will be signaled to stop when a specified event is found. This is the definition of the Evaluator that will actually produce the value.
Public classStoppingConditionConstraint
The definition for a StoppingConditionConstraintEvaluator. These constraints act as additional criteria for a StoppingCondition. The constraints will take the current state of propagation and return a Boolean for if this state is aloud to potentially stop propagation.
Public classStoppingConditionConstraintEvaluator
The evaluator for a StoppingConditionConstraint. The constraint will be checked at one of two times and return a Boolean indicating if the state checked can be used to stop propagation (if the StoppingConditionEvaluator also determines if propagation should stop).
Public classStoppingConditionEvaluator
The type that actually evaluates a value from the state of propagation that can be used to stop the propagation.
Public classStoppingConditionEvent
The details of when a StoppingConditionEvaluator has been satisfied.
Public classStoppingConditionEventFoundEventArgs
The EventArgs for when a StoppingConditionEvent has been detected.
Public classThresholdStoppingConditionConstraint
A StoppingConditionConstraint that will compute a single value and compare it to a threshold to determine if this constraint is satisfied.
Public classThresholdStoppingConditionConstraintEvaluator
Public classValueInStateStoppingCondition
A StoppingCondition that samples the value of a Motion{double} stored in an ITimeBasedState.
Public classValueInStateStoppingConditionConstraint
A StoppingConditionConstraint that compares a value stored in an ITimeBasedState to a specified threshold.
Delegates
  DelegateDescription
Public delegateConditionCheckCallback
The delegate type that is used by the DelegateStoppingCondition to compute the value used in determining if propagation should stop.
Public delegateConstraintSatisfiedCallback
The delegate that is used by the DelegateStoppingConditionConstraint to determine if the constraint is satisfied.
Public delegateInitializeCallback
The delegate type that lets the StoppingConditionEvaluator or StoppingConditionConstraintEvaluator be initialized. This will be run in the Initialize(ITimeBasedState) method.
Public delegateStoppingTriggeredCallback
A delegate that gets triggered when a StoppingConditionEvaluator is satisfied.
Enumerations
  EnumerationDescription
Public enumerationCircularRange
The possible options that a numerical value could be limited to when it represents an angle.
Public enumerationInequalityCondition
The criteria for comparing one value to another. Generally for use with constraints that use a threshold to determine if they are satisfied or not, like the ThresholdStoppingConditionConstraint.
Public enumerationStoppingConditionEnabled
Settings for enabling or disabling a StoppingCondition.
Public enumerationStoppingConditionTriggeredBehavior
Describes how propagation should behave after a stopping condition has been satisfied. This allows the user who subscribes to the SatisfiedCallbackevent to control how or if propagation will continue.
Public enumerationStoppingConditionValueStatus
Indicates the value of the stopping condition relative to its threshold.
Public enumerationStopType
An enumeration listing the possible events in a function that can be detected by a StoppingCondition.
Public enumerationWhenToCheckConstraint
An enumeration specifying when a StoppingConditionConstraint should be checked. Since the stopping conditions are usually numerically sampled, there is a moment when an event is detected, but not exactly found to within tolerance.