| SimpleRouteProcedure Class | 
 Inheritance Hierarchy
Inheritance HierarchyNamespace: AGI.Foundation.RouteDesign.Advanced
 Syntax
SyntaxThe SimpleRouteProcedure type exposes the following members.
 Constructors
Constructors| Name | Description | |
|---|---|---|
|  | SimpleRouteProcedure | Initializes a new instance. | 
|  | SimpleRouteProcedure(RouteProfile) | 
            Create a new instance based on the given profile.
             | 
|  | SimpleRouteProcedure(SimpleRouteProcedure, CopyContext) | Initializes a new instance as a copy of an existing instance. | 
|  | SimpleRouteProcedure(Double, Double, RouteHeightReference) | 
            Create a new instance based on the given constant height and speed with respect to the surface
            of the Earth.
             | 
|  | SimpleRouteProcedure(Double, Double, TerrainProvider) | 
            Create a new instance based on the given constant height and speed with respect to the 
            given terrain surface.
             | 
 Properties
Properties| Name | Description | |
|---|---|---|
|  | 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.) | 
|  | Profile | 
            Gets or sets the profile associated with this procedure.
             | 
 Methods
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).
      (Inherited from RouteSegment.) | 
|  | 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.) | 
|  | CheckForSameDefinition(SimpleRouteProcedure) | 
        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.
            (Inherited from DefinitionalObject.) | 
|  | 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.
            (Inherited from RouteProcedure.) | 
|  | 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.) | 
|  | SetProfileFromHeight | 
            Set the profile to a given constant height and speed with respect to
            the Earth.  If the 
            MeanSeaLevel is available,
            it will use that as the height reference surface.
             | 
|  | SetProfileFromHeightAboveMeanSeaLevel | 
            Set the profile to a given constant height and speed with respect to
            MeanSeaLevel of the 
            Earth.
             | 
|  | SetProfileFromHeightAboveSurface | |
|  | SetProfileFromHeightAboveTerrain | 
            Set the profile to a given constant height above the terrain surface moving
            at a constant speed with respect to the terrain's surface shape.
             | 
|  | 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
See Also Inheritance Hierarchy
Inheritance Hierarchy