| SurfaceSegment Class | 
 Inheritance Hierarchy
Inheritance HierarchyNamespace: AGI.Foundation.RouteDesign.Advanced
 Syntax
SyntaxThe SurfaceSegment type exposes the following members.
 Constructors
Constructors| Name | Description | |
|---|---|---|
|  | SurfaceSegment | Initializes a new instance. | 
|  | SurfaceSegment(SurfaceSegment) | 
            Create a new instance based on an existing one.
             | 
|  | SurfaceSegment(Ellipsoid, Double) | 
            Create a new instance with the given surface shape and total distance.
             | 
|  | SurfaceSegment(SurfaceSegment, CopyContext) | Initializes a new instance as a copy of an existing instance. | 
 Properties
Properties| Name | Description | |
|---|---|---|
|  | FinalHeading | 
            Gets the final heading measured eastward from north, in radians.
             | 
|  | FinalSurfacePoint | 
            Gets the final position at the end of the surface segment.
             | 
|  | InitialHeading | 
            Gets the initial heading measured eastward from north, in radians.
             | 
|  | InitialSurfacePoint | 
            Gets the initial position at the start of the surface segment.
             | 
|  | 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.) | 
|  | SurfaceDistance | 
            Gets or sets the total arc length along the surface path, in meters.
             | 
|  | SurfaceShape | 
            Gets or sets the shape of the surface upon which the path is defined.
             | 
|  | TransitionPoints | 
            Gets the arc lengths, in meters, at which the geometry changes behavior.
            This could represent discontinuities in the route in one or more derivatives or
            other points of interest.
             | 
 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).
      (Overrides DefinitionalObjectCheckForSameDefinition(DefinitionalObject).) | 
|  | CheckForSameDefinition(SurfaceSegment) | 
        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.) | 
|  | ComputeCartographicExtent | 
            Computes the latitude and longitude boundary surrounding this segment.
             | 
|  | 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.) | 
|  | CreateSurfaceCurve | 
            Create an EllipsoidSurfaceCurve which represents this segment of a route along the 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.
      (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.) | 
|  | GetHeading(Double) | 
            Get the heading measured clockwise from local north, in radians.
             | 
|  | GetHeading(MotionDouble, Int32) | 
            Get the heading and its derivatives, in radians and radians/meter.
             | 
|  | GetType | Gets the Type of the current instance.(Inherited from Object.) | 
|  | IsSameDefinition(Object) | 
        Determines if this object has the same definition as another object.
      (Inherited from DefinitionalObject.) | 
|  | IsSameDefinition(SurfaceSegment) | 
        Determines if this object has the same definition as another object.
       | 
|  | 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.) | 
|  | TraverseFixed | 
            Get the surface position in the fixed frame of the SurfaceShape at the 
            specified distance along the surface path.
             | 
|  | TraverseSurface | 
            Get the surface position at the specified distance along the surface path.
             | 
 See Also
See Also