Click or drag to resize

RacetrackHoldProcedure Class

A procedure defined by two circular turns connected by straight segments with entry and exit occurring at either circle or at additional turns occurring at the beginning or ends of the straight segments. The RoutePropagator will attempt to connect the previous procedure with the nearest entry arc on the racetrack and leave at the exit arc nearest to the next procedure.
Inheritance Hierarchy

Namespace:  AGI.Foundation.RouteDesign
Assembly:  AGI.Foundation.RouteDesign (in AGI.Foundation.RouteDesign.dll) Version: 24.3.420.0 (24.3.420.0)
Syntax
public class RacetrackHoldProcedure : RouteProcedure

The RacetrackHoldProcedure type exposes the following members.

Constructors
Properties
  NameDescription
Public propertyCenterOfTurnOne
Gets or sets the center of the first racetrack turn.
Public propertyCenterOfTurnTwo
Gets or sets the center of the second racetrack turn.
Public propertyConstrainEntryAndExitToTrackArcs
Gets or sets a value indicating whether to ignore the additional entry and exit turns, restricting the entry and exit to be tangent to the two turns in the racetrack. By default, this is set to false.
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 propertyMinimumRevolutions
Gets or sets the minimum number of complete revolutions around the racetrack to make prior to leaving. The number of revolutions may be more if the MinimumTime condition is not met.
Public propertyMinimumTime
Gets or sets the minimum time to spend in the hold before leaving. The time spent in the hold may be more if the number of MinimumRevolutions is not met.
Public propertyProfile
Gets or sets the profile to use for this racetrack hold. See ConstantHeightProfile.
Public propertySurfaceShape
Gets or sets the reference surface over which to define the geometry.
Public propertyTurnDirection
Gets or sets the direction in which the racetrack turns.
Public propertyTurningRadiusForEntryAndExit
Gets or sets the turning radius used to enter and exit the racetrack, in meters.
Public propertyTurningRadiusForHold
Gets or sets the radius of the circular arcs at either end of the racetrack, in meters.
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 RouteSegment.)
Protected methodCheckForSameDefinition(RacetrackHoldProcedure)
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(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).)
Protected methodCheckForSameDefinition(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.)
Public methodClone
Clones this object using the specified context.
(Overrides DefinitionalObjectClone(CopyContext).)
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 RouteProcedureComputeCurrentDefinitionHashCode.)
Public methodCreateConfigurableProfile
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).)
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 methodGetSurfacePath
Get an object that will allow configuration of the surface geometry as it connects with other procedures.
(Overrides RouteProcedureGetSurfacePath.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodIsSameDefinition
Determines if this object has the same definition as another object.
(Inherited from DefinitionalObject.)
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.)
Top
Remarks

This procedure is illustrated by the following image:

See Also