Click or drag to resize

SwitchableSegmentConfiguration Class

Inheritance Hierarchy

Namespace:  AGI.Foundation.SegmentPropagation
Assembly:  AGI.Foundation.SegmentPropagation (in AGI.Foundation.SegmentPropagation.dll) Version: 25.1.421.0 (25.1.421.0)
Syntax
public class SwitchableSegmentConfiguration : SegmentListConfiguration

The SwitchableSegmentConfiguration type exposes the following members.

Constructors
Properties
  NameDescription
Public propertyAlternateSegmentConfiguration
Gets the configuration for the AlternateSegment.
Public propertyDefaultInitialState
Gets or sets the initial state of the segment. Note that this property may not be edited by a SegmentPropagatorVariable.
(Overrides SegmentConfiguration.DefaultInitialState.)
Public propertyIsNonNominalRunDifferent
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 true if the specific segment type might behave differently in an unofficial propagation. By default this returns false indicating that there is no difference.
(Overrides SegmentListConfiguration.IsNonNominalRunDifferent.)
Public propertyNominalRun
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 false to indicate if the segment is being run in a TargetedSegmentListOperator). By default this is true. 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.
(Overrides SegmentListConfiguration.NominalRun.)
Public propertyPrimaryConfiguration
Gets the configuration for the PrimarySegment.
Top
Methods
  NameDescription
Public methodClone
Clones this object using the specified context.
(Overrides SegmentListConfiguration.Clone(CopyContext).)
Public methodContainsSegmentConfiguration(SegmentDefinition)
Checks to see if the segment has a configuration stored in this configuration.
(Inherited from SegmentListConfiguration.)
Public methodContainsSegmentConfiguration(String)
Checks to see if a segment configuration with the segmentName exists in this configuration. This will search recursively through all SegmentListConfigurations that are stored in this configuration.
(Inherited from SegmentListConfiguration.)
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 methodGetSegmentsConfiguration(SegmentDefinition)
Gets the segment configuration for the segment, or null if there is no configuration for the segment in this.
(Inherited from SegmentListConfiguration.)
Public methodGetSegmentsConfiguration(String)
Gets the segment configuration for the segment with the segmentName, or null if there is no configuration in this for such a SegmentPropagator.
(Inherited from SegmentListConfiguration.)
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 methodRemoveSegmentConfiguration
Removes the configuration of the segment from this configuration.
(Inherited from SegmentListConfiguration.)
Public methodSetSegmentConfiguration
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.)
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Top
See Also