Click or drag to resize

SegmentPropagatorPropagate Method (SegmentListResults, SegmentConfiguration, ITrackCalculationProgress)

Propagates the segment with the given parameters.

Namespace:  AGI.Foundation.SegmentPropagation
Assembly:  AGI.Foundation.Models (in AGI.Foundation.Models.dll) Version: 24.2.419.0 (24.2.419.0)
Syntax
Copy
public virtual SegmentResults Propagate(
	SegmentListResults cumulativeResults,
	SegmentConfiguration editedConfiguration,
	ITrackCalculationProgress progressTracker
)

Parameters

cumulativeResults
Type: AGI.Foundation.SegmentPropagationSegmentListResults
The results of propagation up to this point.
editedConfiguration
Type: AGI.Foundation.SegmentPropagationSegmentConfiguration
The segment configuration that some other segment has determined that this segment should run. If it is then use this segments OriginalConfiguration.
progressTracker
Type: AGI.FoundationITrackCalculationProgress
An optional progress tracker. How long the segment will take to propagate generally is not known ahead of time, so the reported progress completed is set to -1. However you can cancel propagation with the tracker.

Return Value

Type: SegmentResults
This segments propagation results. See the documentation of the derived type to determine if these SegmentResults may be cast to a more specific type.
See Also