Click or drag to resize

SurfaceCurveSegment Class

A surface segment representing the path defined by an EllipsoidSurfaceCurve. Most commonly, this is used with either an EllipsoidRhumbLine (constant heading) or an EllipsoidGeodesic (shortest distance).
Inheritance Hierarchy

Namespace:  AGI.Foundation.RouteDesign.Advanced
Assembly:  AGI.Foundation.RouteDesign (in AGI.Foundation.RouteDesign.dll) Version: 19.2.399.0 (19.2.399.0)
Syntax
public class SurfaceCurveSegment : SurfaceSegment

The SurfaceCurveSegment type exposes the following members.

Constructors
  NameDescription
Public methodSurfaceCurveSegment(EllipsoidSurfaceCurve)
Create a new instance based on the given surface curve.
Protected methodSurfaceCurveSegment(SurfaceCurveSegment, CopyContext)
Initializes a new instance as a copy of an existing instance.
Top
Properties
  NameDescription
Public propertyFinalHeading
Gets the final heading measured eastward from north, in radians.
(Overrides SurfaceSegmentFinalHeading.)
Public propertyFinalSurfacePoint
Gets the final position at the end of the surface segment.
(Overrides SurfaceSegmentFinalSurfacePoint.)
Public propertyInitialHeading
Gets the initial heading measured eastward from north, in radians.
(Overrides SurfaceSegmentInitialHeading.)
Public propertyInitialSurfacePoint
Gets the initial position at the start of the surface segment.
(Overrides SurfaceSegmentInitialSurfacePoint.)
Public propertyIsFrozen
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.)
Public propertySurfaceDistance
Gets or sets the total arc length along the surface path, in meters.
(Inherited from SurfaceSegment.)
Public propertySurfaceShape
Gets or sets the shape of the surface upon which the path is defined.
(Inherited from SurfaceSegment.)
Public propertyTransitionPoints
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.
(Overrides SurfaceSegmentTransitionPoints.)
Top
Methods
  NameDescription
Protected methodCheckForSameDefinition(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 SurfaceSegment.)
Protected methodCheckForSameDefinition(SurfaceCurveSegment)
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).
Protected methodCheckForSameDefinition(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).
(Overrides SurfaceSegmentCheckForSameDefinition(SurfaceSegment).)
Public methodClone
Clones this object using the specified context.
(Overrides DefinitionalObjectClone(CopyContext).)
Protected methodComputeCartographicExtent
Computes the latitude and longitude boundary surrounding this segment.
(Overrides SurfaceSegmentComputeCartographicExtent.)
Protected methodComputeCurrentDefinitionHashCode
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 SurfaceSegmentComputeCurrentDefinitionHashCode.)
Public methodCreateSurfaceCurve
Create an EllipsoidSurfaceCurve which represents this segment of a route along the surface.
(Overrides SurfaceSegmentCreateSurfaceCurve.)
Public methodEnumerateDependencies
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.)
Public methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Protected methodFinalize
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object.)
Public methodFreeze
Freezes this object. Further attempts to modify it will result in an ObjectFrozenException.
(Inherited from DefinitionalObject.)
Protected methodFreezeAggregatedObjects
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.)
Public methodGetDefinitionHashCode
Gets a hash code representing the definition of this object.
(Inherited from DefinitionalObject.)
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodGetHeading(Double)
Get the heading measured clockwise from local north, in radians.
(Overrides SurfaceSegmentGetHeading(Double).)
Public methodGetHeading(MotionDouble, Int32)
Get the heading and its derivatives, in radians and radians/meter.
(Overrides SurfaceSegmentGetHeading(MotionDouble, Int32).)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodIsSameDefinition(Object)
Determines if this object has the same definition as another object.
(Inherited from DefinitionalObject.)
Public methodIsSameDefinition(SurfaceSegment)
Determines if this object has the same definition as another object.
(Inherited from SurfaceSegment.)
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Protected methodThrowIfFrozen
Throws ObjectFrozenException if this object IsFrozen. This method should be called from any method or property that modifies this object.
(Inherited from DefinitionalObject.)
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Public methodTraverseFixed
Get the surface position in the fixed frame of the SurfaceShape at the specified distance along the surface path.
(Overrides SurfaceSegmentTraverseFixed(Double).)
Public methodTraverseSurface
Get the surface position at the specified distance along the surface path.
(Overrides SurfaceSegmentTraverseSurface(Double).)
Top
See Also