Click or drag to resize

RoutePropagator Class

A route propagator that takes a sequential list of procedures and connections in order to create a PropagatedRoute. This can be used to either produce a route given a start time or to produce a route given a final rendezvous time.
Inheritance Hierarchy

Namespace:  AGI.Foundation.RouteDesign
Assembly:  AGI.Foundation.RouteDesign (in AGI.Foundation.RouteDesign.dll) Version: 19.1.398.0 (19.1.398.0)
Syntax
public class RoutePropagator : DefinitionalObject

The RoutePropagator type exposes the following members.

Constructors
Properties
  NameDescription
Public propertyCentralBody
Gets or sets the CentralBody upon which to build the route. This will also reconfigure the settings on the DefaultConnectionBehavior to match the given CentralBody.
Public propertyCustomDefaultConnection
Gets or sets the custom connection that will be used to fill in any missing connections in the list of route Segments. If the CustomDefaultConnection is null, the DefaultConnectionBehavior will be used instead.
Public propertyDefaultConnectionBehavior
Gets the instance of DefaultConnectionBehavior that defines the behavior of a generic connection segment between two RouteProcedures. If CustomDefaultConnection is not null, it will override the default behavior and this property will return null.
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 propertyIterationLimit
Gets or sets the maximum number of times to attempt to configure the surface route before returning a route that may contain discontinuities or other problems. By default, the maximum number of iterations is 3.
Public propertySegments
Gets the list of route segments including the procedures and connections. If two RouteProcedures exist in the list without a RouteConnection between them, the propagator will first see if there is a CustomDefaultConnection available and if not it will add a connection based on the DefaultConnectionBehavior settings. Note that two consecutive RouteConnection objects in the list will cause an error.
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).
(Overrides DefinitionalObjectCheckForSameDefinition(DefinitionalObject).)
Protected methodCheckForSameDefinition(RoutePropagator)
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 DefinitionalObjectComputeCurrentDefinitionHashCode.)
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 DefinitionalObjectEnumerateDependencies(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 DefinitionalObjectFreezeAggregatedObjects.)
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 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 methodPropagateFromTime(JulianDate)
Create a PropagatedRoute by configuring the segments to represent a route which starts at the given time. Note that the resulting PropagatedRoute instance may contain errors if configuration could not be completed successfully. The system will attempt to create a feasible route, even if there is an error. Make sure to check HasConfigurationErrors to see if there are any errors and determine whether the errors indicate unexpected discontinuities.

Note that this method is safe to call from multiple threads so long as none of the threads modifies any of the properties of either the RoutePropagator or the Segments on the propagator.

Public methodPropagateFromTime(JulianDate, ITrackCalculationProgress)
Create a PropagatedRoute by configuring the segments to represent a route which starts at the given time. Note that the resulting PropagatedRoute instance may contain errors if configuration could not be completed successfully. The system will attempt to create a feasible route, even if there is an error. Make sure to check HasConfigurationErrors to see if there are any errors and determine whether the errors indicate unexpected discontinuities.

Note that this method is safe to call from multiple threads so long as none of the threads modifies any of the properties of either the RoutePropagator or the Segments on the propagator.

Public methodPropagateTowardTime(JulianDate)
Create a PropagatedRoute by configuring the segments to represent a route which will end at the given time (This can be useful for designing a rendezvous at a given time). Note that the resulting PropagatedRoute instance may contain errors if configuration could not be completed successfully. The system will attempt to create a feasible route, even if there is an error. Make sure to check HasConfigurationErrors to see if there are any errors and determine whether the errors indicate unexpected discontinuities.

Note that this method is safe to call from multiple threads so long as none of the threads modifies any of the properties of either the RoutePropagator or the Segments on the propagator.

Public methodPropagateTowardTime(JulianDate, ITrackCalculationProgress)
Create a PropagatedRoute by configuring the segments to represent a route which will end at the given time (This can be useful for designing a rendezvous at a given time). Note that the resulting PropagatedRoute instance may contain errors if configuration could not be completed successfully. The system will attempt to create a feasible route, even if there is an error. Make sure to check HasConfigurationErrors to see if there are any errors and determine whether the errors indicate unexpected discontinuities.

Note that this method is safe to call from multiple threads so long as none of the threads modifies any of the properties of either the RoutePropagator or the Segments on the propagator.

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
Remarks
While this type is designed to be used for either forward or backward scheduling, it cannot constrain both a start and a stop time for the route. To do this, the user should iterate the properties along the route as needed in order to satisfy the desired condition. Using a root finder, such as the BrentFindRoot can help when doing this.
See Also