Click or drag to resize

SwitchableSegment Properties

The SwitchableSegment type exposes the following members.

Properties
  NameDescription
Public propertyAlternateSegment
Gets or sets the alternate segment. By default, this is the segment that will be propagated and then swapped out. The results will be in the defined-in's (ReferenceFrame, Axes) of the PrimarySegment.
Public propertyElements
Gets the names of all of the elements that this segment is propagating.
(Overrides SegmentDefinitionElements.)
Public propertyIsFrozen
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.)
Public propertyName
Gets or sets a name to describe the segment. This is optional.
(Inherited from SegmentDefinition.)
Public propertyNextStateBehavior
Gets or sets the behavior for passing states to the next segment. See StateForNextSegmentBehavior for more information.
(Inherited from SegmentDefinition.)
Public propertyPassAllElementsToNextSegment
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.)
Public propertyPrimarySegment
Gets or sets the primary segment. For all cases where there is ambiguity between what settings the SwitchableSegment will use, this segment may be assumed to contain those settings. For example, the final states generated by the overall SwitchableSegment will be in the defined-in objects (ReferenceFrame, Axes...) of this segment.
Public propertyPropagationDirection
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.)
Public propertySegmentToRun
Gets the definition of the evaluator that will tell the SegmentPropagator which segment to run.
Public propertySegmentToRunInitially
Gets or sets which segment should be propagated initially. Defaults to Alternate.
Public propertySegmentToRunParameter
Top
See Also