agi.foundation.routedesign.advanced

(agi.foundation.routedesign-2025r1.jar)

Class SimpleRouteProcedure

java.lang.Object

agi.foundation.infrastructure.DefinitionalObject

agi.foundation.routedesign.RouteSegment

agi.foundation.routedesign.RouteProcedure

agi.foundation.routedesign.advanced.SimpleRouteProcedure

All Implemented Interfaces:

ICloneWithContext, IEnumerateDependencies, IEquatableDefinition, IFreezable

Direct Known Subclasses:

HeadingAtWaypointProcedure, InscribedTurnProcedure, RasterSearchProcedure, SurfaceCurveProcedure, TurnAfterWaypointProcedure, TurnBeforeWaypointProcedure

public abstract class SimpleRouteProcedure
extends RouteProcedure

Base class for all surface procedures that don't specify an explicit RouteProfile associated with the surface path.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	SimpleRouteProcedure() Initializes a new instance.
protected	SimpleRouteProcedure(double speed, double height, RouteHeightReference heightReference) Create a new instance based on the given constant height and speed with respect to the surface of the Earth (get).
protected	SimpleRouteProcedure(double speed, double height, TerrainProvider terrain) Create a new instance based on the given constant height and speed with respect to the given terrain surface.
protected	SimpleRouteProcedure(RouteProfile profile) Create a new instance based on the given profile.
protected	SimpleRouteProcedure(SimpleRouteProcedure 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(RouteProcedure other) Checks to determine if another instance has the same definition as this instance and returns true if it does.
protected abstract boolean	checkForSameDefinition(SimpleRouteProcedure other) Checks to determine if another instance has the same definition as this instance and returns true if it does.
protected int	computeCurrentDefinitionHashCode() Computes a hash code based on the current properties of this object.
ConfigurableProfile	createConfigurableProfile(SurfaceSegment surfacePath) 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.
RouteProfile	getProfile() Gets the profile associated with this procedure.
void	setProfile(RouteProfile value) Sets the profile associated with this procedure.
void	setProfileFromHeight(double speed, double height) Set the profile to a given constant height and speed with respect to the Earth.
void	setProfileFromHeightAboveMeanSeaLevel(double speed, double height) Set the profile to a given constant height and speed with respect to MeanSeaLevel (get / set) of the Earth (get).
void	setProfileFromHeightAboveSurface(double speed, double height) Set the profile to a given constant height and speed with respect to the Shape (get / set) of the Earth (get).
void	setProfileFromHeightAboveTerrain(double speed, double height, TerrainProvider terrain) Set the profile to a given constant height above the terrain surface moving at a constant speed with respect to the terrain's Shape (get / set).

Methods inherited from class agi.foundation.routedesign.RouteProcedure

checkForSameDefinition, getSurfacePath

Methods inherited from class agi.foundation.routedesign.RouteSegment

checkForSameDefinition

Methods inherited from class agi.foundation.infrastructure.DefinitionalObject

areSameDefinition, areSameDefinition, areSameDefinition, areSameDefinition, areSameDefinition, clone, 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

SimpleRouteProcedure

protected SimpleRouteProcedure()

Initializes a new instance.

SimpleRouteProcedure

protected SimpleRouteProcedure(RouteProfile profile)

Create a new instance based on the given profile.

Parameters:

profile - The profile to associate with this procedure.

SimpleRouteProcedure

protected SimpleRouteProcedure(double speed,
                               double height,
                               @Nonnull
                               RouteHeightReference heightReference)

Create a new instance based on the given constant height and speed with respect to the surface of the Earth (get).

Parameters:

speed - The constant total speed of the position.

height - The constant height with respect to either MeanSeaLevel (get / set) or the Shape (get).

heightReference - The reference surface to use for the height, either MeanSeaLevel (get / set) or the Shape (get).

SimpleRouteProcedure

protected SimpleRouteProcedure(double speed,
                               double height,
                               @Nonnull
                               TerrainProvider terrain)

Create a new instance based on the given constant height and speed with respect to the given terrain surface.

Parameters:

speed - The constant speed with respect to the terrain's surface Shape (get / set).

height - The constant height above the terrain.

terrain - The terrain surface over which to traverse.

Throws:

ArgumentNullException - Thrown when terrain is null.

SimpleRouteProcedure

protected SimpleRouteProcedure(@Nonnull
                               SimpleRouteProcedure 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

checkForSameDefinition

protected final boolean checkForSameDefinition(RouteProcedure 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 RouteProcedure

Parameters:

other - The other instance to compare to this one.

Returns:

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

checkForSameDefinition

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

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 SimpleRouteProcedure.checkForSameDefinition(agi.foundation.routedesign.RouteProcedure) method.

Overrides:

computeCurrentDefinitionHashCode in class RouteProcedure

Returns:

The computed hash code.

getProfile

public final RouteProfile getProfile()

Gets the profile associated with this procedure.

setProfile

public final void setProfile(RouteProfile value)

Sets the profile associated with this procedure.

setProfileFromHeight

public final void setProfileFromHeight(double speed,
                                       double height)

Set the profile to a given constant height and speed with respect to the Earth. If the MeanSeaLevel (get / set) is available, it will use that as the height reference surface.

Parameters:

speed - The speed at which to traverse over the surface.

height - The constant height with respect to the Earth's reference surface.

setProfileFromHeightAboveSurface

public final void setProfileFromHeightAboveSurface(double speed,
                                                   double height)

Set the profile to a given constant height and speed with respect to the Shape (get / set) of the Earth (get).

Parameters:

speed - The speed at which to traverse over the surface.

height - The constant height with respect to the Earth's reference surface.

setProfileFromHeightAboveMeanSeaLevel

public final void setProfileFromHeightAboveMeanSeaLevel(double speed,
                                                        double height)

Set the profile to a given constant height and speed with respect to MeanSeaLevel (get / set) of the Earth (get).

Parameters:

speed - The speed at which to traverse over the surface.

height - The constant height with respect to the Earth's reference surface.

setProfileFromHeightAboveTerrain

public final void setProfileFromHeightAboveTerrain(double speed,
                                                   double height,
                                                   @Nonnull
                                                   TerrainProvider terrain)

Set the profile to a given constant height above the terrain surface moving at a constant speed with respect to the terrain's Shape (get / set).

Parameters:

speed - The speed at which to traverse over the surface path.

height - The constant height above the terrain.

terrain - The terrain surface.

Throws:

ArgumentNullException - Thrown when terrain is null.

createConfigurableProfile

public ConfigurableProfile createConfigurableProfile(SurfaceSegment surfacePath)

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.

Specified by:

createConfigurableProfile in class RouteSegment

Parameters:

surfacePath - The surface path over which the profile is defined.

Returns:

The configurable profile used by the RoutePropagator to configure the route.