FollowSegment Properties |
The FollowSegment type exposes the following members.
Name | Description | |
---|---|---|
AllowZeroElements |
Gets a value indicating whether if it is acceptable for this type of PropagateSegment to
have no elements. By default this is false.
(Inherited from PropagateSegment.) | |
Elements |
Gets the names of all of the elements that this segment is propagating.
(Inherited from SegmentDefinition.) | |
EndOfFollowSegment |
Gets or sets the how the final state of propagation will be determined. This
may be if the IgnoreFinalPropagation on
the StartOfFollowSegment is .
| |
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.) | |
MaximumDuration |
Gets or sets the maximum Duration that this segment may propagate before being stopped.
The sign of this Duration will be changed at configuration time to match this segments
PropagationDirection. By default this is set to 100 days.
(Inherited from PropagateSegment.) | |
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.) | |
OutputSparsity |
Gets or sets the interval at which to produce output samples.
By default this is set to one, meaning that output will be saved in the state history
for every integration step. If a thinner (but less accurate) ephemeris is desired you can set this
to a higher number. Two means that output is saved every other integration step, etc, etc.
(Inherited from PropagateSegment.) | |
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.
(Inherited from SegmentDefinition.) | |
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.) | |
PropagatorDefinition |
Gets or sets the definition of the StoppablePropagator that
this segment will propagate.
| |
StartOfFollowSegment |
Gets or sets the how the initial state of propagation will be determined.
This will take precedence over any initial state passed into the propagate
method and as such can cause discontinuities with previous segments.
| |
StopOnMaximumDurationBehavior |
Gets or sets what should be done if the span of propagation exceeds the MaximumDuration.
By default this will stop all propagation and immediately return the results computed up to this point.
(Inherited from PropagateSegment.) | |
StoppablePropagator |
Gets or sets the StoppablePropagatorDefinition that will be
propagated by this segment. Note that the adapters on the
StoppablePropagatorDefinition will be automatically set by
this segment. Segments that derived from PropagateSegment
may set this, but it is often easier to expose the relevant properties on this
than to expose it directly.
(Inherited from PropagateSegment.) | |
StoppingConditions |
Gets the stopping conditions that may stop this segment.
Only one StoppingCondition needs to be satisfied to stop propagation. If by the
very rare chance that two conditions happens to stop at the exact same time, the one
earlier in this list will be the one that was reported to have stopped propagation.
Note that this property returns the
conditions on the
StoppablePropagator. This
will be until the StoppablePropagator is initialized.
(Inherited from PropagateSegment.) |