agi.foundation.routedesign.advanced

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

Class ConfigurableSurfaceProcedure

java.lang.Object

agi.foundation.routedesign.advanced.ConfigurableSurfaceProcedure

public abstract class ConfigurableSurfaceProcedure
extends Object

A definition for the procedure from which to configure the surface geometry between procedures and connections.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ConfigurableSurfaceProcedure(SurfaceProcedureConnectionDependency dependency) Create a new instance based on the given configuration dependency

Method Summary

Modifier and Type	Method and Description
abstract SurfaceConfigurationResult	configureEntry(List<ConfigurableConnection> connections, int previousIndex) Given the list of connections, configure the previous connection as it enters this procedure.
abstract SurfaceConfigurationResult	configureExit(List<ConfigurableConnection> connections, int nextIndex) Given the list of connections, configure the next connection as it leaves this procedure.
abstract Cartographic	getAnchorPoint() Gets the surface location to use as a marker for the approximate center or point of interest for the given procedure.
SurfaceProcedureConnectionDependency	getConnectionDependency() Gets the order in which to configure the surrounding connections.
double	getSurfacePathComputationalWeight() Gets the weight to use when reporting progress.
abstract SurfaceSegment	getSurfaceSegment() Create an immutable SurfaceSegment representing the geometry of this procedure, including any entry and exit arcs prior to the connections.
protected void	setConnectionDependency(SurfaceProcedureConnectionDependency value) Sets the order in which to configure the surrounding connections.

Methods inherited from class java.lang.Object

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

Constructor Detail

ConfigurableSurfaceProcedure

protected ConfigurableSurfaceProcedure(@Nonnull
                                       SurfaceProcedureConnectionDependency dependency)

Create a new instance based on the given configuration dependency

Parameters:

dependency - The dependency indicating the order in which to configure the surrounding connections.

Method Detail

getConnectionDependency

@Nonnull
public final SurfaceProcedureConnectionDependency getConnectionDependency()

Gets the order in which to configure the surrounding connections.

setConnectionDependency

protected final void setConnectionDependency(@Nonnull
                                             SurfaceProcedureConnectionDependency value)

Sets the order in which to configure the surrounding connections.

getSurfacePathComputationalWeight

public double getSurfacePathComputationalWeight()

Gets the weight to use when reporting progress. By default, the value is one.

getAnchorPoint

@Nonnull
public abstract Cartographic getAnchorPoint()

Gets the surface location to use as a marker for the approximate center or point of interest for the given procedure.

configureEntry

public abstract SurfaceConfigurationResult configureEntry(List<ConfigurableConnection> connections,
                                                          int previousIndex)

Given the list of connections, configure the previous connection as it enters this procedure. Ensure that the connection is continuous in both position and heading. Note that the incoming heading may have changed in between evaluations if other procedures are configuring the same connection. The procedure is responsible for providing an entry arc which accounts for this change.

Parameters:

connections - The list of connections in the route.

previousIndex - The index of the connection which comes before this procedure.

Returns:

Returns a result indicating whether the configuration was successful or whether there was an error which either prevents configuration or forces a discontinuous result.

configureExit

public abstract SurfaceConfigurationResult configureExit(List<ConfigurableConnection> connections,
                                                         int nextIndex)

Given the list of connections, configure the next connection as it leaves this procedure. Ensure that the connection is continuous in both position and heading. Note that the outgoing heading may have changed in between evaluations if other procedures are configuring the same connection. The procedure is responsible for providing an exit arc which accounts for this change.

Parameters:

connections - The list of connections in the route.

nextIndex - The index of the connection which comes after this procedure.

Returns:

Returns a result indicating whether the configuration was successful or whether there was an error which either prevents configuration or forces a discontinuous result.

getSurfaceSegment

@Nonnull
public abstract SurfaceSegment getSurfaceSegment()

Create an immutable SurfaceSegment representing the geometry of this procedure, including any entry and exit arcs prior to the connections.

Returns:

The immutable surface geometry.