RoutePropagator Methods |
The RoutePropagator type exposes the following members.
Methods| Name | Description | |
|---|---|---|
 | CheckForSameDefinition(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).) |
| CheckForSameDefinition(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).
|
 | Clone |
Clones this object using the specified context.
(Overrides DefinitionalObjectClone(CopyContext).) |
| ComputeCurrentDefinitionHashCode |
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.) |
| EnumerateDependencies |
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).) |
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object.) |
| Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) |
| Freeze |
Freezes this object. Further attempts to modify it will result
in an ObjectFrozenException.
(Inherited from DefinitionalObject.) |
| FreezeAggregatedObjects |
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.) |
| GetDefinitionHashCode |
Gets a hash code representing the definition of this object.
(Inherited from DefinitionalObject.) |
| GetHashCode | Serves as the default hash function. (Inherited from Object.) |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| IsSameDefinition |
Determines if this object has the same definition as another object.
(Inherited from DefinitionalObject.) |
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
| PropagateFromTime(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. |
| PropagateFromTime(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. |
| PropagateTowardTime(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. |
| PropagateTowardTime(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. |
| ThrowIfFrozen |
Throws ObjectFrozenException if this object IsFrozen.
This method should be called from any method or property that modifies this object.
(Inherited from DefinitionalObject.) |
| ToString | Returns a string that represents the current object. (Inherited from Object.) |
See Also