SegmentPropagatorPropagate Method (ITimeBasedState, ITrackCalculationProgress) |
Propagates the segment starting from the initialState.
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(
ITimeBasedState initialState,
ITrackCalculationProgress progressTracker
)
Public Function Propagate (
initialState As ITimeBasedState,
progressTracker As ITrackCalculationProgress
) As SegmentResults
public:
SegmentResults^ Propagate(
ITimeBasedState^ initialState,
ITrackCalculationProgress^ progressTracker
)
member Propagate :
initialState : ITimeBasedState *
progressTracker : ITrackCalculationProgress -> SegmentResults
Parameters
- initialState
- Type: AGI.Foundation.CoordinatesITimeBasedState
The initial state for this segment to propagate from. This is usually the
final state of the previous segment. It will be processed by any the state element adapters before being
propagated. - 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