Click or drag to resize

FiniteManeuverSegment Methods

The FiniteManeuverSegment type exposes the following members.

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(FiniteManeuverSegment)
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(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).
(Overrides NumericalPropagatorSegmentCheckForSameDefinition(NumericalPropagatorSegment).)
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).
(Inherited from NumericalPropagatorSegment.)
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 NumericalPropagatorSegmentClone(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 NumericalPropagatorSegmentComputeCurrentDefinitionHashCode.)
Public methodContainsElement
Checks to see if there is a StateElementAdapterDefinition for the provided element.
(Inherited from SegmentDefinition.)
Public methodStatic memberCreateLimitedFuelStoppingCondition(Scalar, Double, String, Boolean)
Creates a ScalarStoppingCondition that will stop when the quantity of fuel reaches the specified value. By default, the tolerance of the returned condition will be 1e-10.
Public methodStatic memberCreateLimitedFuelStoppingCondition(Scalar, Double, String, Boolean, Double)
Creates a ScalarStoppingCondition that will stop when the fuel amount reaches the specified value.
Public methodStatic memberCreateOutOfFuelStoppingCondition(Scalar, String, Boolean)
Creates a ScalarStoppingCondition that will stop when the fuel amount becomes 0. By default, the tolerance of the returned condition will be 1e-10.
Public methodStatic memberCreateOutOfFuelStoppingCondition(Scalar, String, Boolean, Double)
Creates a ScalarStoppingCondition that will stop when the fuel amount becomes 0.
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 NumericalPropagatorSegmentCreateSegmentPropagator(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 NumericalPropagatorSegmentEnumerateDependencies(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 NumericalPropagatorSegmentFreezeAggregatedObjects.)
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.
(Inherited from NumericalPropagatorSegment.)
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.
(Inherited from NumericalPropagatorSegment.)
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 is set to be run if the specified stoppingCondition stops 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.
(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.

(Inherited from NumericalPropagatorSegment.)
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
See Also