SegmentListPropagatorPropagateSegmentList Method (SegmentListResults, SegmentListConfiguration, ITrackCalculationProgress) |
Namespace:
AGI.Foundation.SegmentPropagation
Assembly:
AGI.Foundation.Models (in AGI.Foundation.Models.dll) Version: 24.3.420.0 (24.3.420.0)
Syntax public virtual SegmentListResults PropagateSegmentList(
SegmentListResults cumulativeResults,
SegmentListConfiguration configuration,
ITrackCalculationProgress progressTracker
)
Public Overridable Function PropagateSegmentList (
cumulativeResults As SegmentListResults,
configuration As SegmentListConfiguration,
progressTracker As ITrackCalculationProgress
) As SegmentListResults
public:
virtual SegmentListResults^ PropagateSegmentList(
SegmentListResults^ cumulativeResults,
SegmentListConfiguration^ configuration,
ITrackCalculationProgress^ progressTracker
)
abstract PropagateSegmentList :
cumulativeResults : SegmentListResults *
configuration : SegmentListConfiguration *
progressTracker : ITrackCalculationProgress -> SegmentListResults
override PropagateSegmentList :
cumulativeResults : SegmentListResults *
configuration : SegmentListConfiguration *
progressTracker : ITrackCalculationProgress -> SegmentListResults
Parameters
- cumulativeResults
- Type: AGI.Foundation.SegmentPropagationSegmentListResults
The overall results
of propagation up to this point. This may be if this segment is the top level segment. - 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 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. A tracker is useful to cancel propagation if such an operation is desired.
Return Value
Type:
SegmentListResultsThe
SegmentListResults of this propagation.
See Also