PropagatedRoute Class |
Namespace: AGI.Foundation.RouteDesign
The PropagatedRoute type exposes the following members.
Name | Description | |
---|---|---|
PropagatedRoute(IListPropagatedRoute) |
Concatenate multiple routes together. Note that unless this may not create a continuous route
unless the initial and final conditions were specified to match.
| |
PropagatedRoute(PropagatedRoute, CopyContext) | Initializes a new instance as a copy of an existing instance. |
Name | Description | |
---|---|---|
CentralBody |
Gets the central body on which this route is defined.
| |
ConnectionConfigurationResults |
Gets a list containing results for the connections where there was a problem or other metadata associated with configuration.
This can often occur if the geometry of the surrounding procedures makes the geometry of a connection infeasible or
if the geometry violates user specified constraints in order to connect. To avoid these cases, try allowing the
surrounding procedures to adjust their heights and speeds to accommodate for the constraints on the connection.
| |
HasConfigurationErrors |
Gets a value indicating whether there were errors while configuring the route.
If the configuration was not successful, information about where the error occurs and why
can be found in the ProcedureConfigurationResults. Errors can mean
that there are discontinuities in the route (in cases where the system was unable to
find any valid trajectory) or simply represent errors where the intended behavior was
infeasible due to over-defined constraints (but still may have produced a smooth route).
| |
IsFrozen |
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.) | |
OverallSurfaceDistance |
Gets the overall distance along the projection of the route onto the Ellipsoid
shape of the CentralBody.
| |
ProcedureConfigurationResults |
Gets a list containing results for procedures where there was a problem or other metadata associated with the configuration.
This can often occur if the geometry of surrounding procedures is infeasible or if some dynamical constraint
is violated in the process of propagating a particular procedure.
| |
Segments |
Gets the list of parametric segments defining the geometry of the individual pieces of the route,
which together form the overall trajectory. In general, these segments are only needed for diagnostic
purposes. The position can be obtained by using CreatePointFromRoute. The surface
geometry can be obtained by using CreateSurfaceCurve. Lastly, scalars are available
to interpolate Heading, Height,
Surface Speed, and Total Speed.
So, these segments should only be used if information regarding the geometry at a specific procedure is required.
| |
Start |
Gets the start date of the route.
| |
Stop |
Gets the stop date at the end of the route.
|
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(PropagatedRoute) |
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.) | |
CreatePointFromRoute |
Create a Point representing the position of the platform along the route expressed in the
FixedFrame of the CentralBody.
| |
CreateSurfaceCurve |
Create a curve representing the path of this route along the surface of the CentralBody's
Ellipsoid surface.
| |
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.) | |
GetCartographicEvaluator(EvaluatorGroup) |
Gets an evaluator which can produce the Cartographic position along
the route as a function of time. The height of the Cartographic is
measured above the surface of the CentralBody.
| |
GetCartographicEvaluator(EvaluatorGroup, TerrainProvider) |
Gets an evaluator which can produce the Cartographic position along
the route as a function of time.
| |
GetDefinitionHashCode |
Gets a hash code representing the definition of this object.
(Inherited from DefinitionalObject.) | |
GetHashCode | Serves as the default hash function. (Inherited from Object.) | |
GetSegment |
Attempts to find the parametric geometry for a particular procedure or connection segment.
| |
GetSpecialTimes |
Gets a list of times of special interest along the route, such as the beginning or end of a turn
or other points where the geometry changes.
| |
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.) | |
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.) |