agi.foundation.routedesign

(agi.foundation.routedesign-2024r2.jar)

Class RasterSearchProcedure

java.lang.Object

agi.foundation.infrastructure.DefinitionalObject

agi.foundation.routedesign.RouteSegment

agi.foundation.routedesign.RouteProcedure

agi.foundation.routedesign.advanced.SimpleRouteProcedure

agi.foundation.routedesign.RasterSearchProcedure

All Implemented Interfaces:

ICloneWithContext, IEnumerateDependencies, IEquatableDefinition, IFreezable

public class RasterSearchProcedure
extends SimpleRouteProcedure

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.

This procedure is illustrated by the following image:

Constructor Summary

Constructors

Modifier	Constructor and Description
	RasterSearchProcedure() Create a new instance.
	RasterSearchProcedure(Cartographic center, double headingAlongLength, double length, double width, double turningRadius, double speed, double height, RouteHeightReference reference) Create a new instance over the surface of the Earth (get).
	RasterSearchProcedure(Ellipsoid surfaceShape, Cartographic center, double headingAlongLength, double length, double width, double turningRadius, double speed, double height, RouteHeightReference reference) Create a new instance based on the given parameters.
	RasterSearchProcedure(Ellipsoid surfaceShape, Cartographic center, double headingAlongLength, double length, double width, double turningRadius, RouteProfile profile) Create a new instance based on the given parameters.
protected	RasterSearchProcedure(RasterSearchProcedure existingInstance, CopyContext context) Initializes a new instance as a copy of an existing instance.

Method Summary

Modifier and Type	Method and Description
protected boolean	checkForSameDefinition(RasterSearchProcedure other) Checks to determine if another instance has the same definition as this instance and returns true if it does.
protected boolean	checkForSameDefinition(SimpleRouteProcedure other) Checks to determine if another instance has the same definition as this instance and returns true if it does.
Object	clone(CopyContext context) Clones this object using the specified context.
protected int	computeCurrentDefinitionHashCode() Computes a hash code based on the current properties of this object.
Cartographic	getCenter() Gets the center of the search area.
double	getHeadingAlongLength() Gets the heading along the Length (get / set) with respect to north, in radians.
double	getLength() Gets the length of the search area, in meters.
EllipsoidSurfaceRegion	getSearchRegion() Gets the rectangular surface region underneath the raster search that represents the area over which to search.
ConfigurableSurfaceProcedure	getSurfacePath() Get an object that will allow configuration of the surface geometry as it connects with other procedures.
Ellipsoid	getSurfaceShape() Gets the shape of the reference surface over which to define the surface geometry for the search.
double	getTurningRadius() Gets the turning radius for the position, in meters.
double	getWidth() Gets the width of the search area, in meters.
void	setCenter(Cartographic value) Sets the center of the search area.
void	setHeadingAlongLength(double value) Sets the heading along the Length (get / set) with respect to north, in radians.
void	setLength(double value) Sets the length of the search area, in meters.
void	setSurfaceShape(Ellipsoid value) Sets the shape of the reference surface over which to define the surface geometry for the search.
void	setTurningRadius(double value) Sets the turning radius for the position, in meters.
void	setWidth(double value) Sets the width of the search area, in meters.

Methods inherited from class agi.foundation.routedesign.advanced.SimpleRouteProcedure

checkForSameDefinition, createConfigurableProfile, getProfile, setProfile, setProfileFromHeight, setProfileFromHeightAboveMeanSeaLevel, setProfileFromHeightAboveSurface, setProfileFromHeightAboveTerrain

Methods inherited from class agi.foundation.routedesign.RouteProcedure

checkForSameDefinition

Methods inherited from class agi.foundation.routedesign.RouteSegment

checkForSameDefinition

Methods inherited from class agi.foundation.infrastructure.DefinitionalObject

areSameDefinition, areSameDefinition, areSameDefinition, areSameDefinition, areSameDefinition, collectionItemsAreSameDefinition, collectionItemsAreSameDefinition, collectionItemsAreSameDefinition, dictionaryItemsAreSameDefinition, enumerateDependencies, freeze, freezeAggregatedObjects, getCollectionHashCode, getCollectionHashCode, getCollectionHashCode, getDefinitionHashCode, getDefinitionHashCode, getDefinitionHashCode, getDefinitionHashCode, getDefinitionHashCode, getDefinitionHashCode, getDictionaryHashCode, getIsFrozen, isSameDefinition, throwIfFrozen

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

RasterSearchProcedure

public RasterSearchProcedure()

Create a new instance.

RasterSearchProcedure

public RasterSearchProcedure(@Nonnull
                             Cartographic center,
                             double headingAlongLength,
                             double length,
                             double width,
                             double turningRadius,
                             double speed,
                             double height,
                             @Nonnull
                             RouteHeightReference reference)

Create a new instance over the surface of the Earth (get).

Parameters:

center - The center of the search area, including the height above the surface at which to search.

headingAlongLength - The heading along the length of the search area with respect to north, in radians.

length - The length of the search area over the surface, in meters.

width - The width of the search area over the surface, in meters.

turningRadius - The horizontal radius at which to turn during the search pattern, in meters.

speed - The speed at which to conduct the search, in meters per second.

height - The height of the route with respect to the reference surface, in meters.

reference - The reference surface above which the height is defined.

RasterSearchProcedure

public RasterSearchProcedure(Ellipsoid surfaceShape,
                             @Nonnull
                             Cartographic center,
                             double headingAlongLength,
                             double length,
                             double width,
                             double turningRadius,
                             double speed,
                             double height,
                             @Nonnull
                             RouteHeightReference reference)

Create a new instance based on the given parameters.

Parameters:

surfaceShape - The surface over which to define the surface geometry and the height profile.

center - The center of the search area, including the height above the surfaceShape.

headingAlongLength - The heading along the length of the search area with respect to north, in radians.

length - The length of the search area over the surface, in meters.

width - The width of the search area over the surface, in meters.

turningRadius - The horizontal radius at which to turn during the search pattern, in meters.

speed - The speed at which to conduct the search, in meters per second.

height - The height of the route with respect to the reference surface, in meters.

reference - The reference surface above which the height is defined.

RasterSearchProcedure

public RasterSearchProcedure(Ellipsoid surfaceShape,
                             @Nonnull
                             Cartographic center,
                             double headingAlongLength,
                             double length,
                             double width,
                             double turningRadius,
                             RouteProfile profile)

Create a new instance based on the given parameters.

Parameters:

surfaceShape - The surface over which to define the surface geometry and the height profile.

center - The center of the search area, including the height above the surfaceShape.

headingAlongLength - The heading along the length of the search area with respect to north, in radians.

length - The length of the search area over the surface, in meters.

width - The width of the search area over the surface, in meters.

turningRadius - The horizontal radius at which to turn during the search pattern, in meters.

profile - The profile that defines the height and speed over the course of the search.

RasterSearchProcedure

protected RasterSearchProcedure(@Nonnull
                                RasterSearchProcedure existingInstance,
                                @Nonnull
                                CopyContext context)

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

See ICloneWithContext.clone(CopyContext) for more information about how to implement this constructor in a derived class.

Parameters:

existingInstance - The existing instance to copy.

context - A CopyContext that controls the depth of the copy.

Throws:

ArgumentNullException - Thrown when existingInstance or context is null.

Method Detail

clone

public Object clone(CopyContext context)

Clones this object using the specified context.

This method should be implemented to call a copy constructor on the class of the object being cloned. The copy constructor should take the CopyContext as a parameter in addition to the existing instance to copy. The copy constructor should first call CopyContext.addObjectMapping(T, T) to identify the newly constructed instance as a copy of the existing instance. It should then copy all fields, using CopyContext.updateReference(T) to copy any reference fields.

A typical implementation of ICloneWithContext:

public static class MyClass implements ICloneWithContext {
    public MyClass(MyClass existingInstance, CopyContext context) {
        context.addObjectMapping(existingInstance, this);
        someReference = context.updateReference(existingInstance.someReference);
    }

    @Override
    public final Object clone(CopyContext context) {
        return new MyClass(this, context);
    }

    private Object someReference;
}

In general, all fields that are reference types should be copied with a call to CopyContext.updateReference(T). There are a couple of exceptions:

1. Fields that are aggregate parts of the object should always be copied. A referenced object is an aggregate if properties or methods on the object being copied can modify the externally-visible value of the referenced object.
2. If the semantics of the referenced object require that it have a single parent, owner, context, etc., and the object being copied is that parent, owner, or context, then the referenced object should always be copied.

If one of these exceptions applies, the CopyContext should be given an opportunity to update the reference before the reference is copied explicitly. Use CopyContext.updateReference(T) to update the reference. If CopyContext.updateReference(T) returns the original object, indicating that the context does not have a replacement registered, then copy the object manually by invoking a Clone method, a copy constructor, or by manually constructing a new instance and copying the values.

alwaysCopy = context.updateReference(existingInstance.alwaysCopy);
if (existingInstance.alwaysCopy != null && alwaysCopy == existingInstance.alwaysCopy) {
    alwaysCopy = (AlwaysCopy) existingInstance.alwaysCopy.clone(context);
}

If you are implementing an evaluator (a class that implements IEvaluator), the IEvaluator.updateEvaluatorReferences(agi.foundation.infrastructure.CopyContext) method shares some responsibilities with the copy context constructor. Code duplication can be avoided by doing the following:

1. For references to other evaluators ONLY, simply assign the reference in the constructor instead of calling CopyContext.updateReference(T). You should still call CopyContext.updateReference(T) on any references to non-evaluators.
2. Call IEvaluator.updateEvaluatorReferences(agi.foundation.infrastructure.CopyContext) as the last line in the constructor and pass it the same CopyContext passed to the constructor.
3. Implement IEvaluator.updateEvaluatorReferences(agi.foundation.infrastructure.CopyContext) as normal. See the reference documentation for IEvaluator.updateEvaluatorReferences(agi.foundation.infrastructure.CopyContext) for more information on implementing that method.

public MyClass(MyClass existingInstance, CopyContext context) {
    super(existingInstance, context);
    someReference = context.updateReference(existingInstance.someReference);
    evaluatorReference = existingInstance.evaluatorReference;
    updateEvaluatorReferences(context);
}

@Override
public void updateEvaluatorReferences(CopyContext context) {
    evaluatorReference = context.updateReference(evaluatorReference);
}

@Override
public Object clone(CopyContext context) {
    return new MyClass(this, context);
}

private Object someReference;
private IEvaluator evaluatorReference;

Specified by:

clone in interface ICloneWithContext

Specified by:

clone in class DefinitionalObject

Parameters:

context - The context to use to perform the copy.

Returns:

A new instance which is a copy of this object.

checkForSameDefinition

protected final boolean checkForSameDefinition(SimpleRouteProcedure other)

Checks to determine if another instance has the same definition as this instance and returns true 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 false for all derived-class instances. Derived classes should check the type of other to preserve the symmetric nature of IEquatableDefinition.isSameDefinition(java.lang.Object).

Specified by:

checkForSameDefinition in class SimpleRouteProcedure

Parameters:

other - The other instance to compare to this one.

Returns:

true if the two objects are defined equivalently; otherwise false.

checkForSameDefinition

protected boolean checkForSameDefinition(RasterSearchProcedure other)

Checks to determine if another instance has the same definition as this instance and returns true 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 false for all derived-class instances. Derived classes should check the type of other to preserve the symmetric nature of IEquatableDefinition.isSameDefinition(java.lang.Object).

Parameters:

other - The other instance to compare to this one.

Returns:

true if the two objects are defined equivalently; otherwise false.

computeCurrentDefinitionHashCode

protected int 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 RasterSearchProcedure.checkForSameDefinition(agi.foundation.routedesign.advanced.SimpleRouteProcedure) method.

Overrides:

computeCurrentDefinitionHashCode in class SimpleRouteProcedure

Returns:

The computed hash code.

getCenter

@Nonnull
public final Cartographic getCenter()

Gets the center of the search area.

setCenter

public final void setCenter(@Nonnull
                            Cartographic value)

Sets the center of the search area.

getSurfaceShape

public final Ellipsoid getSurfaceShape()

Gets the shape of the reference surface over which to define the surface geometry for the search.

setSurfaceShape

public final void setSurfaceShape(Ellipsoid value)

Sets the shape of the reference surface over which to define the surface geometry for the search.

getHeadingAlongLength

public final double getHeadingAlongLength()

Gets the heading along the Length (get / set) with respect to north, in radians. This defines the direction in which the position travels when 'searching'.

setHeadingAlongLength

public final void setHeadingAlongLength(double value)

Sets the heading along the Length (get / set) with respect to north, in radians. This defines the direction in which the position travels when 'searching'.

getLength

public final double getLength()

Gets the length of the search area, in meters. This determines the distance between turns.

setLength

public final void setLength(double value)

Sets the length of the search area, in meters. This determines the distance between turns.

getWidth

public final double getWidth()

Gets the width of the search area, in meters. This determines the number of turns required, along with the TurningRadius (get / set), in order to cover the entire area.

setWidth

public final void setWidth(double value)

Sets the width of the search area, in meters. This determines the number of turns required, along with the TurningRadius (get / set), in order to cover the entire area.

getTurningRadius

public final double getTurningRadius()

Gets the turning radius for the position, in meters. This determines the number of turns required, along with the Width (get / set), in order to cover the entire area.

setTurningRadius

public final void setTurningRadius(double value)

Sets the turning radius for the position, in meters. This determines the number of turns required, along with the Width (get / set), in order to cover the entire area.

getSearchRegion

public final EllipsoidSurfaceRegion getSearchRegion()

Gets the rectangular surface region underneath the raster search that represents the area over which to search. This area is oriented along the HeadingAlongLength (get / set).

Returns:

The surface region representing the search area.

getSurfacePath

public ConfigurableSurfaceProcedure getSurfacePath()

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

This is used by the RoutePropagator to ensure smooth connection between procedures.

Specified by:

getSurfacePath in class RouteProcedure

Returns:

The configurable surface geometry.