public class PropagateSegmentConfiguration : SegmentListConfiguration, IThreadAware, ICloneWithContext
Public Class PropagateSegmentConfiguration Inherits SegmentListConfiguration Implements IThreadAware, ICloneWithContext
public ref class PropagateSegmentConfiguration : public SegmentListConfiguration, IThreadAware, ICloneWithContext
type PropagateSegmentConfiguration = class inherit SegmentListConfiguration interface IThreadAware interface ICloneWithContext end
Thetype exposes the following members.
Initializes a new instance as a copy of an existing instance.
|PropagateSegmentConfiguration(StoppablePropagator, DictionarySegmentDefinition, SegmentConfiguration)|
Initializes a new instance.
Gets or sets the initial state of the segment. Note that this property may not be edited by a SegmentPropagatorVariable.(Inherited from SegmentConfiguration.)
Gets a value indicating whether the associated SegmentPropagator will behave differently if it is being run nominally or not. You should overload this property to return if the specific segment type might behave differently in an unofficial propagation. By default this returns indicating that there is no difference.(Inherited from SegmentListConfiguration.)
Gets a value indicating whether the methods on this instance are safe to call from multiple threads simultaneously.
Gets or sets a value indicating whether this segment is being run normally and as such its results should be included as the final results, or if this segment is being run as part of some other operation (commonly this is set to to indicate if the segment is being run in a TargetedSegmentListOperator). By default this is . Override this property when one SegmentConfiguration manages another SegmentConfiguration (as in the case of a SegmentList) and have the overridden setter set the property on all wrapped configuration.(Inherited from SegmentListConfiguration.)
Gets or sets the StoppablePropagator to use during propagation of the segment. Note that you are able to override the type of propagator being propagated in any PropagateSegment. For example, you can configure your segment to initially propagate with a TwoBodyStoppablePropagator but specify a StoppableNumericalPropagator here.
Gets or sets a value indicating whether the original propagator in the PropagateSegment should be used, or if the propagator in this configuration should be used.
Clones this object using the specified context.(Overrides SegmentListConfigurationClone(CopyContext).)
Checks to see if a segment configuration with the segmentName exists in this. This will search recursively through all SegmentListConfigurations that are stored in this.(Inherited from SegmentListConfiguration.)
Checks to see if the segment has a configuration stored in this.(Inherited from SegmentListConfiguration.)
Determines whether the specified object is equal to the current object.(Inherited from Object.)
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.(Inherited from Object.)
Serves as the default hash function.(Inherited from Object.)
Gets the segment configuration for the segment with the segmentName, or if there is no configuration in this for such a SegmentPropagator.(Inherited from SegmentListConfiguration.)
Gets the segment configuration for the segment, or if there is no configuration for the segment in this.(Inherited from SegmentListConfiguration.)
Gets the Type of the current instance.(Inherited from Object.)
Creates a shallow copy of the current Object.(Inherited from Object.)
Removes the configuration of the segment from this configuration.(Inherited from SegmentListConfiguration.)
Stores the configuration of the segment. When attempting to add the segment that happens to be stored in a nested SegmentList, this method will drill down to the SegmentListConfiguration of the segment immediate parent SegmentList.(Inherited from SegmentListConfiguration.)
Returns a string that represents the current object.(Inherited from Object.)
The segment configurations are mutable objects that store all of the editable settings that a SegmentPropagator needs to run. These settings can be edited by operator evaluators. The configurations should be designed to be able to easily get to and modify the data you need to. When a SegmentPropagator is propagated, the updated configuration will be passed into the method, and it is the responsibility of the PropagateSegment(SegmentListResults, SegmentConfiguration, ITrackCalculationProgress) method to use the data in the configuration properly.