Click or drag to resize

StationaryHoldProcedure Class

A procedure that represents a point along the route where a vehicle slows to a stop, waits at the specified location for a specified amount of time, and then speeds up to continue toward the next procedure. Note that this will represent a discontinuity in the geometry of the route and may cause difficulties for other types which require a smooth path and a non-zero velocity vector. Examples include Axes types which use velocity information to orient the vehicle but do not have additional logic to handle stationary objects.
Inheritance Hierarchy

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

The StationaryHoldProcedure type exposes the following members.

Constructors
  NameDescription
Public methodStationaryHoldProcedure
Create a new instance.
Public methodStationaryHoldProcedure(Cartographic, Duration)
Create a new instance based on the given parameters over the surface of the Earth.
Protected methodStationaryHoldProcedure(StationaryHoldProcedure, CopyContext)
Initializes a new instance as a copy of an existing instance.
Public methodStationaryHoldProcedure(Double, Double, Duration, Double, RouteHeightReference)
Create a new instance based on the given parameters over the surface of the Earth.
Public methodStationaryHoldProcedure(Double, Double, Duration, Double, TerrainProvider)
Create a new instance based on the given parameters over the surface of the Earth.
Top
Properties
  NameDescription
Public propertyHoldTime
Gets or sets the duration of time to wait at the waypoint.
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 propertyReferenceSurface
Gets or sets the reference surface above which the height of the profile is defined.
Public propertyWaypoint
Gets or sets the waypoint location at which to wait. The height of the waypoint represents the height above the ReferenceSurface.
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(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.)
Protected methodCheckForSameDefinition(StationaryHoldProcedure)
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).
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
See Also