Click or drag to resize

PropagateSegmentSetStoppingConditionAutoSegment Method

Each StoppingCondition in the StoppingConditions can have a SegmentDefinition associated with it that will be propagated if that StoppingCondition happens to be the one that stops this segments propagation. Use this method to set that optional segment.

Namespace:  AGI.Foundation.SegmentPropagation
Assembly:  AGI.Foundation.SegmentPropagation (in AGI.Foundation.SegmentPropagation.dll) Version: 20.2.404.0 (20.2.404.0)
Syntax
public void SetStoppingConditionAutoSegment(
	StoppingCondition stoppingCondition,
	SegmentDefinition autoSegment,
	int numberOfTimesToExecuteAutoSequence
)

Parameters

stoppingCondition
Type: AGI.Foundation.StoppingConditionsStoppingCondition
The StoppingCondition that if tripped will trigger the autoSegment to propagate. The stoppingCondition must be in the StoppingConditions when this segments propagator is created.
autoSegment
Type: AGI.Foundation.SegmentPropagationSegmentDefinition
The segment to run if the stoppingCondition stops propagation.
numberOfTimesToExecuteAutoSequence
Type: SystemInt32
Sets the number of times the autoSegment will get executed. When set to more than 1, after the StoppablePropagator is stopped by the stoppingCondition, the autoSegment will be propagated. Once that segment finishes, the StoppingConditionEvaluator that stopped the in initial propagation will be reinitialized and the propagation of the StoppablePropagator will continue as many times as this value is specified.
Exceptions
ExceptionCondition
ArgumentOutOfRangeException Thrown when the numberOfTimesToExecuteAutoSequence is less than 1.
See Also