Click or drag to resize

RasterSearchProcedure Class

A procedure that defines a route which follows a regular pattern over a given rectangular search area. The user specifies the heading, length, width, and turn radius. Then, the raster search centers a search pattern over the area of interest such that the "legs" of the search lie along the length and the route turns back 180 degrees before continuing the next leg in the opposite direction. The turns occur outside of the given search region. The search will place the first turn into the search area at the corner closest to the previous procedure. The location of the final turn depends on the placement of the entry and how many "legs" are required to cover the entire area.
Inheritance Hierarchy

Namespace:  AGI.Foundation.RouteDesign
Assembly:  AGI.Foundation.RouteDesign (in AGI.Foundation.RouteDesign.dll) Version: 19.1.398.0 (19.1.398.0)
Syntax
public class RasterSearchProcedure : SimpleRouteProcedure

The RasterSearchProcedure type exposes the following members.

Constructors
Properties
  NameDescription
Public propertyCenter
Gets or sets the center of the search area.
Public propertyHeadingAlongLength
Gets or sets the heading along the Length with respect to north, in radians. This defines the direction in which the position travels when 'searching'.
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 propertyLength
Gets or sets the length of the search area, in meters. This determines the distance between turns.
Public propertyProfile
Gets or sets the profile associated with this procedure.
(Inherited from SimpleRouteProcedure.)
Public propertySurfaceShape
Gets or sets the shape of the reference surface over which to define the surface geometry for the search.
Public propertyTurningRadius
Gets or sets the turning radius for the position, in meters. This determines the number of turns required, along with the Width, in order to cover the entire area.
Public propertyWidth
Gets or sets the width of the search area, in meters. This determines the number of turns required, along with the TurningRadius, in order to cover the entire area.
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(RasterSearchProcedure)
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).
(Inherited from SimpleRouteProcedure.)
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(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).)
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 SimpleRouteProcedureComputeCurrentDefinitionHashCode.)
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.
(Inherited from SimpleRouteProcedure.)
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 methodGetSearchRegion
Gets the rectangular surface region underneath the raster search that represents the area over which to search. This area is oriented along the HeadingAlongLength.
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.)
Public methodSetProfileFromHeight
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.)
Public methodSetProfileFromHeightAboveMeanSeaLevel
Set the profile to a given constant height and speed with respect to MeanSeaLevel of the Earth.
(Inherited from SimpleRouteProcedure.)
Public methodSetProfileFromHeightAboveSurface
Set the profile to a given constant height and speed with respect to the surface of the Earth.
(Inherited from SimpleRouteProcedure.)
Public methodSetProfileFromHeightAboveTerrain
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.)
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