SegmentPropagatorPropagate Method (SegmentConfiguration, ITrackCalculationProgress) |
Propagates the segment.
Namespace:
AGI.Foundation.SegmentPropagation
Assembly:
AGI.Foundation.Models (in AGI.Foundation.Models.dll) Version: 24.2.419.0 (24.2.419.0)
Syntax public SegmentResults Propagate(
SegmentConfiguration editedConfiguration,
ITrackCalculationProgress progressTracker
)
Public Function Propagate (
editedConfiguration As SegmentConfiguration,
progressTracker As ITrackCalculationProgress
) As SegmentResults
public:
SegmentResults^ Propagate(
SegmentConfiguration^ editedConfiguration,
ITrackCalculationProgress^ progressTracker
)
member Propagate :
editedConfiguration : SegmentConfiguration *
progressTracker : ITrackCalculationProgress -> SegmentResults
Parameters
- editedConfiguration
- Type: AGI.Foundation.SegmentPropagationSegmentConfiguration
The segment configuration that some
other segment has determined that this segment should run. If it is then use the
segments original configuration. - 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:
SegmentResultsThis
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