The base class defining the definition of a SegmentPropagator. Segments will define how an ITimeBasedState will be propagated. That initial state will be passed into the propagatorsPropagateSegment method. Consider wrapping another lower level propagator in your SegmentPropagator. Multiple segments can be strung together, one running after the previous, and the initial state of each segment will be initialized with the final state of the previous one.
It is a good idea to design custom segments to support being the first segment that is run. However if it truly makes no sense for a custom segment to not be the first segment, then a detailed Exception should be thrown when GetSegmentPropagator is called and no previous segment is included.
Segments should also have a specific configuration type that goes along with it. This configuration object will store mutable values that a parent segment could modify. The configuration object should generally not have every single property of the segment, only the ones that make sense. The configuration will assist in editing the properties it stores.
public abstract class SegmentDefinition : DefinitionalObject
Public MustInherit Class SegmentDefinition Inherits DefinitionalObject
public ref class SegmentDefinition abstract : public DefinitionalObject
[<AbstractClassAttribute>] type SegmentDefinition = class inherit DefinitionalObject end
Thetype exposes the following members.
Initializes a new instance.
Initializes a new instance as a copy of an existing instance.
Gets the names of all of the elements that this segment is propagating.
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.)
Gets or sets a name to describe the. This is optional and is only for your convenience.
Gets or sets which state will get passed to the next segment.
Gets if the type of this segment is such that it will not define any Elements or StateElementAdapters because the nature of the segment is that it affects the control flow of multiple segments instead of propagating 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.
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).
Checks to determine if another instance has the same definition as this instance and returns if it does. Derived classes MUST override this method and check all new fields introduced by the derived class for definitional equivalence. It is NOT necessary to check base class fields because the base class will already have done that. When overriding this method, you should NOT call the base implementation because it will return for all derived-class instances. Derived classes should check the type of other to preserve the symmetric nature of IsSameDefinition(Object).(Overrides DefinitionalObjectCheckForSameDefinition(DefinitionalObject).)
Checks to determine if another instance has the same definition as this instance and returns if it does. Derived classes MUST override this method and check all new fields introduced by the derived class for definitional equivalence. It is NOT necessary to check base class fields because the base class will already have done that. When overriding this method, you should NOT call the base implementation because it will return for all derived-class instances. Derived classes should check the type of other to preserve the symmetric nature of IsSameDefinition(Object).
Clones this object using the specified context.(Inherited from DefinitionalObject.)
Computes a hash code based on the current properties of this object. Derived classes MUST override this method and compute a hash code that combines: a unique hash code seed, the base implementation result, and the hash codes of all new fields introduced by the derived class which are used in the CheckForSameDefinition(DefinitionalObject) method.(Overrides DefinitionalObjectComputeCurrentDefinitionHashCode.)
Checks to see if there is a StateElementAdapterDefinition for the provided element.
Enumerates the dependencies of this object by calling EnumerateT(T) for each object that this object directly depends upon. Derived classes which contain additional dependencies MUST override this method, call the base implementation, and enumerate dependencies introduced by the derived class.(Inherited from DefinitionalObject.)
Determines whether the specified object is equal to the current object.(Inherited from Object.)
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.(Inherited from Object.)
Freezes this object. Further attempts to modify it will result in an ObjectFrozenException.(Inherited from DefinitionalObject.)
Called by Freeze to also freeze any objects that are considered to be a part of this object. Derived classes which contain additional aggregated objects MUST override this method, call the base implementation, and freeze aggregated objects introduced by the derived class. The objects that need to be frozen in this method are frequently created in this object's constructor and are not settable via properties.(Inherited from DefinitionalObject.)
Gets a hash code representing the definition of this object.(Inherited from DefinitionalObject.)
Returns the adapter for the given element. The StateElementAdapters handle the various transformations of the propagated elements between segments (for example, if the integration frame of a point being propagated changes from one segment to another, the adapter is what handles that transformation between segment). All elements propagated by this segment must have a adapter returned by this method (even if that adapter simply returns the original state). If multiple segments are getting propagated by this segment (as as SegmentList would), this must return the adapter of the StateElementAdapter of the element for the final known getting propagated.
Serves as the default hash function.(Inherited from Object.)
Creates, configures and returns the SegmentPropagator for this segment.
Creates, configures and returns the SegmentPropagator for this segment.
Gets the Type of the current instance.(Inherited from Object.)
Determines if this object has the same definition as another object.(Inherited from DefinitionalObject.)
Creates a shallow copy of the current Object.(Inherited from Object.)
Removes the StateElementAdapterDefinition for the specified element and returns if it was added and successfully removed, otherwise.
Add or sets an element and related settings to this segment.
Note that many types of derived segments will automatically handle their adapters by interrogating properties specific to the derived segment. Also some segments whose PassAllElementsToNextSegment property is do not require adapters or elements to be set.
These adapters have the responsibility of processing the initial state that the propagator will start propagating from. They will modify the initial state passed to this segment so that the state is in a form that the propagator can process.
Throws ObjectFrozenException if this object IsFrozen. This method should be called from any method or property that modifies this object.(Inherited from DefinitionalObject.)
Returns a string that represents the current object.(Overrides ObjectToString.)