ReturnSegment Properties |
The ReturnSegment type exposes the following members.
Properties| Name | Description | |
|---|---|---|
 | Behavior |
Gets or sets if this segment will return or not when propagated. By default this is Enabled.
|
| Elements |
Gets the names of all of the elements that this segment is propagating.
(Inherited from SegmentDefinition.) |
| IsFrozen |
Gets a value indicating whether this object is frozen. A frozen object cannot be modified and an
ObjectFrozenException will be thrown if an attempt is made to do so.
(Inherited from DefinitionalObject.) |
| Name |
Gets or sets a name to describe the segment. This is optional.
(Inherited from SegmentDefinition.) |
| NextStateBehavior |
Gets or sets the behavior for passing states to the next segment. See StateForNextSegmentBehavior for more information.
(Inherited from SegmentDefinition.) |
| ParentList |
Gets or sets the SegmentDefinition that this segment will return from. This does not have to be
the immediate parent segment. If this ReturnSegment is in a list that is in this parent list, it will
return out of the ParentList. Note that some SegmentDefinitions will return a
SegmentListResults even though the segment is not a SegmentList.
|
| PassAllElementsToNextSegment |
Gets a value indicating whether the segment is such that it will not define any Elements or
StateElementAdapters. Such a segment typically
affects the control flow of multiple segments instead of propagating state elements. By default this is
, but if the specific derived segment can use the previous segment's adapters,
override this property to always return . Even if this is
some segments may require adapters to be set with the
SetElementAndAdapter(StateElementAdapterDefinition) method.
(Overrides SegmentDefinitionPassAllElementsToNextSegment.) |
| PropagationDirection |
Gets or sets the direction that this segment will be initially propagated. If this segment propagates
multiple segments, the child segments will be propagated in the direction that they are configured with.
If the overall list is going forward, segments that go back in time will override the immediate previous
segments ephemeris, but if another segment going forward follows the backwards segment, that backwards
segment will be ignored when the overall trajectory is resolved into a single ephemeris set. If you are using a
StoppingCondition that depends on time, the time span of
those stopping conditions must match this property (for example, a
DurationStoppingCondition must have a negative
threshold if this is set to Decreasing,
otherwise, the condition will never be tripped).
(Inherited from SegmentDefinition.) |
See Also