Click or drag to resize

ReturnSegmentConfiguration Class

The configuration for a ReturnSegment.
Inheritance Hierarchy
SystemObject
  AGI.Foundation.SegmentPropagationSegmentConfiguration
    AGI.Foundation.SegmentPropagationReturnSegmentConfiguration

Namespace:  AGI.Foundation.SegmentPropagation
Assembly:  AGI.Foundation.SegmentPropagation (in AGI.Foundation.SegmentPropagation.dll) Version: 22.2.414.0 (22.2.414.0)
Syntax
public class ReturnSegmentConfiguration : SegmentConfiguration

The ReturnSegmentConfiguration type exposes the following members.

Constructors
  NameDescription
Public methodReturnSegmentConfiguration(ReturnSegmentBehavior)
Initializes a new instance.
Protected methodReturnSegmentConfiguration(ReturnSegmentConfiguration, 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.
(Inherited from SegmentConfiguration.)
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.
(Overrides SegmentConfigurationIsNonNominalRunDifferent.)
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.
(Inherited from SegmentConfiguration.)
Public propertyReturnSegmentBehavior
Gets or sets if the ReturnSegment that this configuration is for will actually return or not. Note that the ReturnSegment can behave differently if it is being run in a TargetedSegmentListOperator or not, you should always check the NominalRun when checking this property. Or, use the ActuallyEnabled instead of getting this property.
Top
Methods
  NameDescription
Public methodActuallyEnabled
Gets if this segment is actually enabled or not. This will check both the ReturnSegmentBehavior and NominalRun, and return if the appropriate combination of them would have the ReturnSegment actually return; otherwise .
Public methodClone
Clones this object using the specified context.
(Overrides SegmentConfigurationClone(CopyContext).)
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