Click or drag to resize

SegmentConfiguration Class

The configuration for a SegmentPropagator. This configuration must be mutable and it must have all of the settings that some outer operation may want to change to drive the segment to propagate towards a common result. SegmentConfigurations will be created by the segment when the propagator is created and potentially changed by a TargetedSegmentListOperator.

If writing your own SegmentDefinition and SegmentPropagator, it is best to create a specific SegmentConfiguration for that new segment. Generally, all of the settings on the SegmentDefinition should be reflected in this configuration.

Inheritance Hierarchy
SystemObject
  AGI.Foundation.SegmentPropagationSegmentConfiguration
    More...

Namespace:  AGI.Foundation.SegmentPropagation
Assembly:  AGI.Foundation.Models (in AGI.Foundation.Models.dll) Version: 19.5.402.0 (19.5.402.0)
Syntax
public abstract class SegmentConfiguration : ICloneWithContext

The SegmentConfiguration type exposes the following members.

Constructors
  NameDescription
Protected methodSegmentConfiguration
Initializes a new instance.
Protected methodSegmentConfiguration(SegmentConfiguration, CopyContext)
Initializes a new instance as a copy of an existing instance.
Top
Properties
  NameDescription
Public propertyDefaultInitialState
Gets or sets the initial state of the segment. Note that this property may not be edited by a SegmentPropagatorVariable.
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 if the specific segment type might behave differently in an unofficial propagation. By default this returns indicating that there is no difference.
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 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.
Top
Methods
  NameDescription
Public methodClone
Clones this object using the specified context.
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 methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Top
See Also
Inheritance Hierarchy