Click or drag to resize

NumericalPropagatorSegment Class

A segment that will run a NumericalPropagator until a StoppingCondition is satisfied. Each StoppingCondition in the AGI.Foundation.StoppingConditions can have an optional SegmentDefinition associated with it that get propagated if that StoppingCondition is the one that stops the propagation of this segments propagator.
Inheritance Hierarchy

Namespace:  AGI.Foundation.SegmentPropagation
Assembly:  AGI.Foundation.SegmentPropagation (in AGI.Foundation.SegmentPropagation.dll) Version: 19.5.402.0 (19.5.402.0)
Syntax
public class NumericalPropagatorSegment : PropagateSegment

The NumericalPropagatorSegment type exposes the following members.

Constructors
  NameDescription
Public methodNumericalPropagatorSegment
Initializes a new instance. The PropagatorDefinition must be set, and at least one StoppingCondition must be added to the AGI.Foundation.StoppingConditions before the SegmentPropagator for this SegmentDefinition can be created.
Protected methodNumericalPropagatorSegment(NumericalPropagatorSegment, CopyContext)
Initializes a new instance as a copy of an existing instance.
Top
Properties
  NameDescription
Protected propertyAllowZeroElements
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.)
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 propertyMaximumDuration
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.)
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 propertyOutputSparsity
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.)
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.
(Inherited from SegmentDefinition.)
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 propertyPropagatorDefinition
Gets or sets the NumericalPropagatorDefinition that contains all of elements that will be propagated by this segment. Note that this simply reflects the PropagatorDefinition of the StoppablePropagator so changing the base property will change this as well.
Public propertyStopOnMaximumDurationBehavior
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.)
Public propertyStoppablePropagator
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.)
Public propertyStoppingConditions
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.)
Top
Methods
  NameDescription
Protected methodCheckForSameDefinition(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).
(Inherited from SegmentDefinition.)
Protected methodCheckForSameDefinition(NumericalPropagatorSegment)
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).
Protected methodCheckForSameDefinition(PropagateSegment)
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 PropagateSegmentCheckForSameDefinition(PropagateSegment).)
Protected methodCheckForSameDefinition(SegmentDefinition)
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).
(Inherited from PropagateSegment.)
Public methodClearStoppingConditionsAutoSegment
Removes the optional segment that would have been run if the specified StoppingCondition would stop propagation. This method will return if the stoppingCondition has no optional segment.
(Inherited from PropagateSegment.)
Public methodClone
Clones this object using the specified context.
(Overrides PropagateSegmentClone(CopyContext).)
Protected methodComputeCurrentDefinitionHashCode
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 PropagateSegmentComputeCurrentDefinitionHashCode.)
Public methodContainsElement
Checks to see if there is a StateElementAdapterDefinition for the provided element.
(Inherited from SegmentDefinition.)
Protected methodCreateSegmentPropagator
Creates, configures, and returns the SegmentPropagator for this segment. This method should check that all of the required properties on the concrete instance are configured properly before constructing the SegmentPropagator to be returned.
(Overrides PropagateSegmentCreateSegmentPropagator(EvaluatorGroup, SegmentDefinition).)
Public methodEnumerateDependencies
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.
(Overrides PropagateSegmentEnumerateDependencies(DependencyEnumerator).)
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 methodFreeze
Freezes this object. Further attempts to modify it will result in an ObjectFrozenException.
(Inherited from DefinitionalObject.)
Protected methodFreezeAggregatedObjects
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.
(Overrides PropagateSegmentFreezeAggregatedObjects.)
Public methodGetDefinedIn
Gets the object (for example, a ReferenceFrame, an Axes, etc.) in which the specified element is defined in. This can return if there is no such object. When overriding this method, you generally should not call the base method, instead the derived segment should keep track of the elements and defined in objects itself.
(Overrides SegmentDefinitionGetDefinedIn(String).)
Public methodGetDefinitionHashCode
Gets a hash code representing the definition of this object.
(Inherited from DefinitionalObject.)
Public methodGetElementAdapter
Returns the adapter for the given state 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 an adapter returned by this method (even if that adapter simply returns the original state). If multiple segments are being propagated by this segment (as a SegmentList would), this must return the adapter of the StateElementAdapter of the element for the final known segment getting propagated.
(Overrides SegmentDefinitionGetElementAdapter(String).)
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodGetNumberOfTimesToExecuteStoppingConditionsAutoSegment
Returns the number of times the auto-segment associated with the stoppingCondition is set to execute. If the stoppingCondition does not have a SegmentDefinition associated with it, then 1 will be returned.
(Inherited from PropagateSegment.)
Public methodGetSegmentPropagator
Creates, configures, and returns the SegmentPropagator for this segment. This method assumes that no previous segment is needed to configure this segment's propagator.
(Inherited from SegmentDefinition.)
Public methodGetSegmentPropagator(EvaluatorGroup)
Creates, configures, and returns the SegmentPropagator for this segment. This method assumes that no previous segment is needed to configure this segment's propagator.
(Inherited from SegmentDefinition.)
Public methodGetSegmentPropagator(SegmentDefinition)
Creates, configures, and returns the SegmentPropagator for this segment.
(Inherited from SegmentDefinition.)
Public methodGetSegmentPropagator(EvaluatorGroup, SegmentDefinition)
Creates, configures, and returns the SegmentPropagator for this segment.
(Inherited from SegmentDefinition.)
Public methodGetStoppingConditionsAutoSegment
Returns the SegmentDefinition that was set to be run if the specified stoppingCondition stops this segments propagation, or if there has not been such a segment specified.
(Inherited from PropagateSegment.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodIsSameDefinition
Determines if this object has the same definition as another object.
(Inherited from DefinitionalObject.)
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public methodRemoveElement
Removes the StateElementAdapterDefinition for the specified element and returns if it was added and successfully removed, otherwise.
(Inherited from SegmentDefinition.)
Public methodSetElementAndAdapter

Add or sets an adapter for an element in 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.

(Overrides SegmentDefinitionSetElementAndAdapter(StateElementAdapterDefinition).)
Public methodSetStoppingConditionAutoSegment
Each StoppingCondition in the StoppingConditions can have a SegmentDefinition associated with it that will be propagated if that StoppingCondition happens to be the one that stops this segments propagation. Use this method to set that optional segment.
(Inherited from PropagateSegment.)
Protected methodThrowIfFrozen
Throws ObjectFrozenException if this object IsFrozen. This method should be called from any method or property that modifies this object.
(Inherited from DefinitionalObject.)
Public methodToString
Returns a string that represents the current object.
(Inherited from SegmentDefinition.)
Top
Events
  NameDescription
Public eventPropagationFinishedEvent
An event that gets fired when propagation is complete.
(Inherited from PropagateSegment.)
Public eventStepTaken
The optional event that will fire every time a step is taken by the underlying StoppablePropagator.
(Inherited from PropagateSegment.)
Top
Remarks

The results returned when this segments propagator is propagated will always be a PropagateSegmentResults.

The advantage to using this derived type as opposed to the PropagateSegment directly is that the configuration of the StateElementAdapters is handled automatically.

Note that this segment implements PropagateSegment and as such at propagation time, it is possible to configure a ChangePropagateSegmentsPropagatorOperator with any other StoppablePropagatorDefinition.

See Also