HeightTransitionProcedure Class |
A procedure that will transition from one height to another based on the given Dynamics. The surface procedure behaves like a TurnBeforeWaypointProcedure. The platform will enter into a spiral prior to reaching the given waypoint in order to adjust its current height. This is useful in cases where the maximum ascent or descent velocity would otherwise be violated while trying to transition from one procedure to another.
Namespace: AGI.Foundation.RouteDesign
The HeightTransitionProcedure type exposes the following members.
Name | Description | |
---|---|---|
HeightTransitionProcedure |
Create a new instance.
| |
HeightTransitionProcedure(HeightTransitionProcedure, CopyContext) | Initializes a new instance as a copy of an existing instance. | |
HeightTransitionProcedure(TerrainProvider, Cartographic, Double, ProfileDynamics, ProfileSpeed, Double, Double) |
Create a new instance based on the given parameters.
|
Name | Description | |
---|---|---|
AllowModificationOfFinalHeight |
Gets or sets a value indicating whether to allow the following connection to update the
FinalHeight if there was a problem with the next profile.
| |
AllowModificationOfInitialHeight |
Gets or sets a value indicating whether to allow the previous connection to update the
InitialHeight if there was a problem with the previous profile.
| |
Dynamics |
Gets or sets the set of parameters specifying the achievable accelerations during the profile.
| |
FinalHeight |
Gets or sets the final target height above the HeightReferenceSurface, in meters.
| |
HeightReferenceSurface |
Gets or sets the reference surface above which the profile height is defined.
| |
InitialHeight |
Gets or sets the initial target height above the HeightReferenceSurface, in meters.
| |
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.) | |
Speed |
Gets or sets the target speed at which to transition between heights.
| |
TurningRadius |
Gets or sets the radius at which to turn during the spiral transition from the
InitialHeight to the FinalHeight, in meters.
| |
Waypoint |
Gets or sets the waypoint at which to make the transition. This is the point at
which the procedure will leave after transitioning to the FinalHeight.
|
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).
(Inherited from RouteSegment.) | |
CheckForSameDefinition(HeightTransitionProcedure) |
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).
| |
CheckForSameDefinition(RouteProcedure) |
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 RouteProcedureCheckForSameDefinition(RouteProcedure).) | |
CheckForSameDefinition(RouteSegment) |
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 RouteProcedure.) | |
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 RouteProcedureComputeCurrentDefinitionHashCode.) | |
CreateConfigurableProfile |
Create a profile based on the given settings that the RoutePropagator can
use to configure this profile in relation to all other profiles along the route.
(Overrides RouteSegmentCreateConfigurableProfile(SurfaceSegment).) | |
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.
(Inherited from DefinitionalObject.) | |
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.
(Inherited from DefinitionalObject.) | |
GetDefinitionHashCode |
Gets a hash code representing the definition of this object.
(Inherited from DefinitionalObject.) | |
GetHashCode | Serves as the default hash function. (Inherited from Object.) | |
GetSurfacePath |
Get an object that will allow configuration of the surface geometry as it
connects with other procedures.
(Overrides RouteProcedureGetSurfacePath.) | |
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.) |
This procedure is illustrated by the following image: