SegmentListPropagatorPropagateSegments Method |
Propagates a list of segments.
Instead of returning some set of
SegmentListResults,
this method will add the results to
cumulativeResults.
Namespace:
AGI.Foundation.SegmentPropagation
Assembly:
AGI.Foundation.Models (in AGI.Foundation.Models.dll) Version: 24.2.419.0 (24.2.419.0)
Syntax public static void PropagateSegments(
SegmentListResults cumulativeResults,
IList<SegmentPropagator> segmentsToPropagate,
SegmentListConfiguration configuration,
ITrackCalculationProgress progressTracker
)
Public Shared Sub PropagateSegments (
cumulativeResults As SegmentListResults,
segmentsToPropagate As IList(Of SegmentPropagator),
configuration As SegmentListConfiguration,
progressTracker As ITrackCalculationProgress
)
public:
static void PropagateSegments(
SegmentListResults^ cumulativeResults,
IList<SegmentPropagator^>^ segmentsToPropagate,
SegmentListConfiguration^ configuration,
ITrackCalculationProgress^ progressTracker
)
static member PropagateSegments :
cumulativeResults : SegmentListResults *
segmentsToPropagate : IList<SegmentPropagator> *
configuration : SegmentListConfiguration *
progressTracker : ITrackCalculationProgress -> unit
Parameters
- cumulativeResults
- Type: AGI.Foundation.SegmentPropagationSegmentListResults
The results of the SegmentListPropagator
that is calling this static method. These results must have the ParentResults and
Propagator set. - segmentsToPropagate
- Type: System.Collections.GenericIListSegmentPropagator
The SegmentPropagators that should be propagated. - configuration
- Type: AGI.Foundation.SegmentPropagationSegmentListConfiguration
The segment configuration that some
other segment has determined that this segment should run. If it is then the
segments original configuration of the
Propagator of the cumulativeResults will be used. - 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. But you can cancel propagation with the tracker.
See Also