Click or drag to resize

TwoBodyStoppablePropagator Class

A StoppablePropagator that propagates an orbit using a simple two-body model.
Inheritance Hierarchy

Namespace:  AGI.Foundation.Propagators
Assembly:  AGI.Foundation.Models (in AGI.Foundation.Models.dll) Version: 24.1.418.0 (24.1.418.0)
Syntax
public class TwoBodyStoppablePropagator : SinglePointStoppablePropagatorDefinition

The TwoBodyStoppablePropagator type exposes the following members.

Constructors
Properties
  NameDescription
Public propertyAutomaticallyAddEndOfAvailabilityStoppingConditions
Gets or sets a value indicating whether the propagator should automatically have a pair of StoppingConditions that will stop propagation at the start or end times of this propagators availability. By default this is and should only be set to if calling code is sure that propagation will never go beyond the availability.
(Inherited from SinglePointStoppablePropagatorDefinition.)
Public propertyDirection
Gets a value that will, at run time, report the current direction of propagation of the StoppablePropagator.
(Inherited from StoppablePropagatorDefinition.)
Public propertyGravitationalParameter
Gets or sets the gravitational parameter of the central body that the propagated element is around.
Public propertyInitialDate
Gets or sets the optional initial date for this propagator. This will only be used if the initial state passed into the propagator's propagate method is null.
(Inherited from SinglePointStoppablePropagatorDefinition.)
Public propertyInitialMotion
Gets or sets the optional initial position and velocity for this propagator. This will only be used if the initial state passed into the propagator's propagate method is null.
(Inherited from SinglePointStoppablePropagatorDefinition.)
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 propertyOrder (Inherited from SinglePointStoppablePropagatorDefinition.)
Public propertyPropagationFrame
Gets or sets the ReferenceFrame to propagate in. This should be an inertial reference frame.
(Inherited from SinglePointStoppablePropagatorDefinition.)
Public propertyPropagationPoint
Gets the Point to use in other geometry types that depend on the propagation of this propagator, such as in StoppingConditions that depend on geometry types.
(Inherited from SinglePointStoppablePropagatorDefinition.)
Public propertyPropagationPointIdentification
Gets or sets a name to identify the Points ephemeris with.
(Inherited from SinglePointStoppablePropagatorDefinition.)
Public propertyStep
Gets or sets the step size for this propagator.
(Inherited from SinglePointStoppablePropagatorDefinition.)
Public propertyStoppingConditions
Gets the list of StoppingConditions that will find events and dictate when propagation should end.
(Inherited from StoppablePropagatorDefinition.)
Public propertyTimeTolerance
Gets or sets the tolerance in seconds that the StoppablePropagator will use to say that a StoppingCondition converged on time. When the propagator is trying to find the exact event, if the time between dates is equal to or less than this span, it will say that that StoppingCondition has converged even if the FunctionTolerance has not been satisfied. This value is optional, with a default of Zero. The value must be positive. If the value is specified, then stopping conditions can converged to events if either the function tolerance or this time tolerance is satisfied.
(Inherited from StoppablePropagatorDefinition.)
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 StoppablePropagatorDefinition.)
Protected methodCheckForSameDefinition(SinglePointStoppablePropagatorDefinition)
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 SinglePointStoppablePropagatorDefinitionCheckForSameDefinition(SinglePointStoppablePropagatorDefinition).)
Protected methodCheckForSameDefinition(StoppablePropagatorDefinition)
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 SinglePointStoppablePropagatorDefinition.)
Protected methodCheckForSameDefinition(TwoBodyStoppablePropagator)
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).
Public methodClone
Clones this object using the specified context.
(Overrides DefinitionalObjectClone(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 SinglePointStoppablePropagatorDefinitionComputeCurrentDefinitionHashCode.)
Public methodContainsAdapter
Checks if there is a StateElementAdapter stored in this definition for elementIdentification.
(Inherited from StoppablePropagatorDefinition.)
Protected methodCreatePropagator
Creates and initialize the actual SinglePointStoppablePropagator.
(Overrides SinglePointStoppablePropagatorDefinitionCreatePropagator(EvaluatorGroup, IListStateElementAdapterDefinition).)
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.
(Inherited from SinglePointStoppablePropagatorDefinition.)
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.
(Inherited from StoppablePropagatorDefinition.)
Public methodGetAdapter
Gets the StateElementAdapter stored in this definition for elementIdentification.
(Inherited from StoppablePropagatorDefinition.)
Public methodGetAllAdapters
Gets all of the StateElementAdapters that have been registered with this propagator.
(Inherited from StoppablePropagatorDefinition.)
Public methodGetDefinitionHashCode
Gets a hash code representing the definition of this object.
(Inherited from DefinitionalObject.)
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodGetSinglePointPropagator
Creates and returns the SinglePointStoppablePropagator as defined by this instance.
(Inherited from SinglePointStoppablePropagatorDefinition.)
Public methodGetSinglePointPropagator(EvaluatorGroup)
Creates and returns the SinglePointStoppablePropagator as defined by this instance. It is assumed that the Adapters are either not needed or are fully configured with any current and previous objects set.
(Inherited from SinglePointStoppablePropagatorDefinition.)
Public methodGetStoppablePropagator
Creates and initialize the actual StoppablePropagator. It is assume that the Adapters are either not needed or are fully configured with any current and previous objects set.
(Inherited from StoppablePropagatorDefinition.)
Public methodGetStoppablePropagator(EvaluatorGroup)
Creates and initialize the actual StoppablePropagator. It is assume that the Adapters are either not needed or are fully configured with any current and previous objects set.
(Inherited from StoppablePropagatorDefinition.)
Public methodGetStoppablePropagator(EvaluatorGroup, IListStateElementAdapterDefinition)
Creates and initialize the actual StoppablePropagator.
(Inherited from SinglePointStoppablePropagatorDefinition.)
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 methodOnAnyConditionSatisfied
Called when any of the StoppingConditions are satisfied.
(Inherited from StoppablePropagatorDefinition.)
Public methodRemoveAdapter
Removes the StateElementAdapter stored in this definition for elementIdentification.
(Inherited from StoppablePropagatorDefinition.)
Public methodSetAdapter
Adds a StateElementAdapter to this propagator.
(Inherited from StoppablePropagatorDefinition.)
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 Object.)
Top
Events
  NameDescription
Public eventAnyConditionSatisfied
Raised when any of the StoppingConditions are satisfied.
(Inherited from StoppablePropagatorDefinition.)
Top
See Also