CircularHoldProcedure Class

Create a new instance.

Initializes a new instance as a copy of an existing instance.

Create a new instance based on the given parameters.

Create a new instance based on the given parameters.

Create a new instance based on the given parameters. The Profile property must be set before propagation.

Gets or sets the location for the center of the circular hold.

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.

Gets or sets the minimum number of revolutions to perform before leaving the hold. The actual number of revolutions will depend on connection geometry and whether MinimumTime requires further revolutions.

Gets or sets the minimum time to spend in the hold before leaving. The actual time spent in the hold will depend on connection geometry and whether further revolutions are required to satisfy the MinimumRevolutions property.

Gets or sets the profile to use with this circular hold. See ConstantHeightProfile.

Gets or sets the shape of the reference surface over which the surface path is defined.

Gets or sets the direction (right or left) of the turn.

Gets or sets the surface distance from the center of the hold to the circular path.

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).

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).

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).

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).

Clones this object using the specified context.

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.

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.

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.

Determines whether the specified object is equal to the current object.

Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.

Freezes this object. Further attempts to modify it will result in an ObjectFrozenException.

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.

Gets a hash code representing the definition of this object.

Serves as the default hash function.

Get an object that will allow configuration of the surface geometry as it connects with other procedures.

Gets the Type of the current instance.

Determines if this object has the same definition as another object.

Creates a shallow copy of the current Object.

Throws ObjectFrozenException if this object IsFrozen. This method should be called from any method or property that modifies this object.

Returns a string that represents the current object.