DefaultConnectionBehavior Class |
Namespace: AGI.Foundation.RouteDesign
The DefaultConnectionBehavior type exposes the following members.
Name | Description | |
---|---|---|
DefaultConnectionBehavior | Initializes a new instance. | |
DefaultConnectionBehavior(DefaultConnectionBehavior, CopyContext) | Initializes a new instance as a copy of an existing instance. |
Name | Description | |
---|---|---|
Dynamics |
Gets or sets the dynamical characteristics of the position traversing the 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.) | |
KindOfProfile |
Gets or sets an enumeration indicating what type of connection to use:
following terrain, flying above terrain, or simply moving in a straight line
between procedures. By default, this will ignore terrain and connect with
a straight line.
| |
KindOfSurfaceConnection |
Gets or sets the behavior to use to connect the surface procedures.
By default the connections will follow a constant heading between procedures.
| |
MinimumHeightAboveTerrain |
Gets or sets the minimum height above the terrain. This is ignored
if ignoring terrain altogether. In the case of following terrain, this is
the constant offset above the terrain to use when moving along the terrain surface.
For terrain avoidance, this is the minimum distance above which to create the route.
| |
Speed |
Gets or sets the target cruise speed to use when traversing the connection.
In order for the connection to target this speed, UseDirectTransition
must be set to false.
| |
SurfaceShape |
Gets or sets the shape of the surface upon which the surface geometry of the route is defined.
| |
TerrainSamplingDistance |
Gets or sets the sampling distance used for the terrain avoidance algorithm. A
larger sampling distance will be faster but result in a higher chance that the route
will go below the MinimumHeightAboveTerrain in between samples.
| |
TerrainSurface |
Gets or sets the terrain surface that must be set if the
KindOfProfile is either FollowTerrain
or AvoidTerrain.
| |
UseDirectTransition |
Gets or sets a value indicating whether to connect directly between the initial and final
conditions or whether to try to cruise using a constant height and speed if possible.
By default, the default behavior is to connect directly.
|
Name | Description | |
---|---|---|
CheckForSameDefinition(DefaultConnectionBehavior) |
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(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).) | |
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.) | |
CreateConnection |
Create a connection between two RouteProcedures based on the
current settings for the connection behavior.
| |
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.) | |
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.) |