Click or drag to resize

SegmentListPropagator Class

The SegmentPropagator for SegmentList. Each SegmentPropagator in the list will be propagated sequentially and a SegmentListResults will be returned. Note that there are several virtual methods on this type that must be overridden if you are extending this type.
Inheritance Hierarchy
SystemObject
  AGI.Foundation.SegmentPropagationSegmentPropagator
    AGI.Foundation.SegmentPropagationSegmentListPropagator

Namespace:  AGI.Foundation.SegmentPropagation
Assembly:  AGI.Foundation.Models (in AGI.Foundation.Models.dll) Version: 19.2.399.0 (19.2.399.0)
Syntax
public class SegmentListPropagator : SegmentPropagator

The SegmentListPropagator type exposes the following members.

Constructors
  NameDescription
Protected methodSegmentListPropagator(SegmentListPropagator, CopyContext)
Initializes a new instance as a copy of an existing instance.
Public methodSegmentListPropagator(SegmentDefinition, SegmentList, EvaluatorGroup)
Initializes a new instance.
Top
Properties
  NameDescription
Public propertyAdapters
Gets a list of the StateElementAdapters that this segment can use in its propagation.
(Inherited from SegmentPropagator.)
Public propertyIdentifier
Gets the definition that created this propagator. This is to only be used as an identifier.
(Inherited from SegmentPropagator.)
Public propertyIsThreadSafe
Gets a value indicating whether the methods on this instance are safe to call from multiple threads simultaneously.
(Inherited from SegmentPropagator.)
Public propertyName
Gets the name of this SegmentPropagator.
(Inherited from SegmentPropagator.)
Public propertyOriginalConfiguration
Gets or sets the original configuration for this segment. This must be set when the propagator is constructed. This should be ignored during propagation if a configuration is passed into the PropagateSegment(SegmentListResults, SegmentConfiguration, ITrackCalculationProgress) method.
(Inherited from SegmentPropagator.)
Public propertyPropagationDirection
Gets the initial direction of propagation.
(Inherited from SegmentPropagator.)
Public propertySegments
Gets the SegmentPropagators that will be propagated.
Public propertyStateForNextSegmentBehavior
Gets which state should be passed to the next SegmentPropagator.
(Inherited from SegmentPropagator.)
Top
Methods
  NameDescription
Public methodApplyResults
This method sets propagator's state via the input results. For SegmentPropagators that have state, there may be times when that state should be manually set (sometimes for performance considerations, when the propagator will be called multiple times and it should start from where it left off).
(Overrides SegmentPropagatorApplyResults(SegmentResults).)
Public methodClone
Clones this object using the specified context.
(Overrides SegmentPropagatorClone(CopyContext).)
Protected methodCreateNewConfiguration
Creates a new configuration for this segment. Derived types should override this and return their configuration that inherits from SegmentListConfiguration.
Protected methodDefaultStateAdaptation
Performs the default adaptation of the elements in the initialState into the finalState. Note that elements that do not exist in both states will not be adapted.
(Inherited from SegmentPropagator.)
Public methodDispose
Releases any resources associated with this instance.
(Inherited from SegmentPropagator.)
Protected methodDispose(Boolean)
Releases any resources associated with this instance.
(Inherited from SegmentPropagator.)
Public methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Protected methodFinalize
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object.)
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public methodPropagate
Propagates the segment assuming no initial state is passed in. Some segments do not require an initial state to be passed in. However other segments do; such types should override this method and provide a detailed error message in a proper Exception in such a case.
(Inherited from SegmentPropagator.)
Public methodPropagate(ITimeBasedState)
Propagates the segment starting from the initialState.
(Inherited from SegmentPropagator.)
Public methodPropagate(SegmentListResults)
Propagates the segment.
(Inherited from SegmentPropagator.)
Public methodPropagate(ITimeBasedState, ITrackCalculationProgress)
Propagates the segment starting from the initialState.
(Inherited from SegmentPropagator.)
Public methodPropagate(ITimeBasedState, SegmentListResults)
Propagates the segment starting from the initialState.
(Inherited from SegmentPropagator.)
Public methodPropagate(SegmentConfiguration, ITrackCalculationProgress)
Propagates the segment.
(Inherited from SegmentPropagator.)
Public methodPropagate(SegmentListResults, SegmentConfiguration, ITrackCalculationProgress)
Propagates the segment with the given parameters.
(Inherited from SegmentPropagator.)
Protected methodPropagateSegment
The method that actually propagates the segment. This should never be called directly; instead call whatever Propagate method most appropriate to your problem.
(Overrides SegmentPropagatorPropagateSegment(SegmentListResults, SegmentConfiguration, ITrackCalculationProgress).)
Public methodPropagateSegmentList
Propagates the segments in this SegmentListPropagator.
Public methodPropagateSegmentList(ITimeBasedState)
Propagates this starting from the initialState.
Public methodPropagateSegmentList(SegmentListResults, SegmentListConfiguration, ITrackCalculationProgress)
Propagates this propagator's list of segments.
Public methodStatic memberPropagateSegments
Propagates the segmentsToPropagate. Instead of returning some set of SegmentListResults, this method will add the results of the segmentsToPropagate to the cumulativeResults.
Public methodPropagateTo

Propagates a segment to the time or independent variable specified in the dateToPropagateTo. This method is needed to assist the case when segments might overlap. If a later segment realizes that it needs to find a different final state from this SegmentPropagator, this method should be used to find that new final state.

Consider calling PropagateToAssumingTimeBasedStates(JulianDate, SegmentResults, SegmentListResults) instead of this method directly.

(Overrides SegmentPropagatorPropagateTo(SegmentResults, JulianDate).)
Public methodToString
Returns a string that represents the current object.
(Inherited from SegmentPropagator.)
Top
Events
  NameDescription
Public eventPropagationFinishedEvent
An event that gets fired when propagation finishes. This event gets fired off in this base type; it should not be run in the PropagateSegment(SegmentListResults, SegmentConfiguration, ITrackCalculationProgress) method.
(Inherited from SegmentPropagator.)
Top
See Also