HeadingAtWaypointProcedure Class

A procedure that defines a required heading at a waypoint. This can be used as an initial or final state for a route, which can be used to smoothly concatenate multiple routes together or create a route based on another ephemeris. It can also be used to ensure the platform's position is pointing in a particular direction at the given waypoint in order to avoid an obstacle or turn into the wind direction. The platform will turn before and after the waypoint to satisfy the heading. In order to have the platform follow a particular heading over a given distance, use a SurfaceCurveProcedure with an EllipsoidRhumbLine.

Inheritance Hierarchy

SystemObject
  AGI.Foundation.InfrastructureDefinitionalObject
    AGI.Foundation.RouteDesignRouteSegment
      AGI.Foundation.RouteDesignRouteProcedure
        AGI.Foundation.RouteDesign.AdvancedSimpleRouteProcedure
          AGI.Foundation.RouteDesignHeadingAtWaypointProcedure

Namespace: AGI.Foundation.RouteDesign
Assembly: AGI.Foundation.RouteDesign (in AGI.Foundation.RouteDesign.dll) Version: 24.2.419.0 (24.2.419.0)

Syntax

C++

Copy

public class HeadingAtWaypointProcedure : SimpleRouteProcedure

Public Class HeadingAtWaypointProcedure
	Inherits SimpleRouteProcedure

public ref class HeadingAtWaypointProcedure : public SimpleRouteProcedure

type HeadingAtWaypointProcedure =  
    class
        inherit SimpleRouteProcedure
    end

The HeadingAtWaypointProcedure type exposes the following members.

Constructors

	Name	Description
	HeadingAtWaypointProcedure	Create a new instance.
	HeadingAtWaypointProcedure(HeadingAtWaypointProcedure, CopyContext)	Initializes a new instance as a copy of an existing instance.
	HeadingAtWaypointProcedure(Cartographic, Double, Double, Double)	Create a new instance based on the given parameters over the surface of the Earth.
	HeadingAtWaypointProcedure(Ellipsoid, Cartographic, Double, Double, RouteProfile)	Create a new instance based on the given parameters for the surface procedure and its associated profile.
	HeadingAtWaypointProcedure(Double, Double, Double, Double, Double, Double, RouteHeightReference)	Create a new instance based on the given parameters over the surface of the Earth.
	HeadingAtWaypointProcedure(Double, Double, Double, Double, Double, Double, TerrainProvider)	Create a new instance based on the given parameters over a terrain surface.

Top

Properties

	Name	Description
	Heading	Gets or sets the position's heading with respect to north at which to arrive at and leave from the waypoint Position, in radians.
	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.)
	Position	Gets or sets the geodetic position of the waypoint at which to arrive and leave at the given Heading.
	Profile	Gets or sets the profile associated with this procedure. (Inherited from SimpleRouteProcedure.)
	SurfaceShape	Gets or sets the reference surface over which the surface geometry is defined.
	TurningRadius	Gets or sets the horizontal turning radius to use when turning toward and from the given heading, in meters.

Top

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(HeadingAtWaypointProcedure)	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). (Inherited from SimpleRouteProcedure.)
	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). (Overrides SimpleRouteProcedureCheckForSameDefinition(SimpleRouteProcedure).)
	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 SimpleRouteProcedureComputeCurrentDefinitionHashCode.)
	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. (Inherited from SimpleRouteProcedure.)
	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.)
	GetFinalFromNextState	Creates an instance of the procedure to represent a final state for a route based on a given state (position and velocity) in the FixedFrame of the CentralBody.
	GetHashCode	Serves as the default hash function. (Inherited from Object.)
	GetInitialFromPreviousState	Creates an instance of the procedure to represent an initial state for a route based on a given state (position and velocity) in the FixedFrame of the CentralBody.
	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.)
	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. (Inherited from SimpleRouteProcedure.)
	SetProfileFromHeightAboveMeanSeaLevel	Set the profile to a given constant height and speed with respect to MeanSeaLevel of the Earth. (Inherited from SimpleRouteProcedure.)
	SetProfileFromHeightAboveSurface	Set the profile to a given constant height and speed with respect to the surface of the Earth. (Inherited from SimpleRouteProcedure.)
	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. (Inherited from SimpleRouteProcedure.)
	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.)

Top

Remarks

This procedure is illustrated by the following image:

Reference

AGI.Foundation.RouteDesign Namespace