agi.foundation.routedesign.advanced

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

Class ConfigurableConnection

java.lang.Object

agi.foundation.routedesign.advanced.ConfigurableConnection

Direct Known Subclasses:

SurfaceProcedureConnection

public abstract class ConfigurableConnection
extends Object

Base class for all types that connect two RouteProcedures together.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ConfigurableConnection() Initializes a new instance.

Method Summary

Modifier and Type	Method and Description
abstract void	configure(List<ConfigurableConnection> connections, int currentIndex) Configure this connection based on its index in the given list of all connections in the route.
double	getComputationalWeight() Get the computational weight associated with configuring this connection with the previous and next procedure.
abstract SurfaceProcedureConnectionDependency	getDependency() Get the dependency for the connection indicating whether the previous or next connection should be configured before this one.
abstract SurfaceConfigurationResult	getEntryToNextConfiguration() Gets the result of configuring the entry into the next procedure.
abstract SurfaceConfigurationResult	getExitFromPreviousConfiguration() Gets the result of configuring the exit from the previous procedure.
abstract double	getFinalHeading() Gets the final heading of the connection, in radians.
abstract Cartographic	getFinalPoint() Gets the final point of the connection segment.
abstract double	getHeading(double s) Get the heading at an arbitrary point along the connection, in radians.
abstract double	getInitialHeading() Gets the initial heading of the connection, in radians.
abstract Cartographic	getInitialPoint() Gets the initial point of the connection segment.
abstract boolean	getIsValid() Gets a value indicating whether this is a valid connection to the previous and next procedures.
abstract Cartographic	getPoint(double s) Get the surface point along the connection at the given arc length.
abstract double	getSurfaceDistance() Gets the total distance traversed by this connection from start to finish, in meters.
abstract SurfaceSegment	getSurfaceSegment() Create the surface geometry for the given connection.
abstract Ellipsoid	getSurfaceShape() Gets the shape of the reference surface upon which the surface geometry is defined.
abstract void	setIsValid(boolean value) Sets a value indicating whether this is a valid connection to the previous and next procedures.
abstract void	setPoints(Cartographic start, Cartographic stop) Set the initial and final points of the connection segment.
abstract void	setStart(Cartographic start) Set the initial point of the connection segment.
abstract void	setStop(Cartographic stop) Set the final point of the connection segment.

Methods inherited from class java.lang.Object

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

Constructor Detail

ConfigurableConnection

protected ConfigurableConnection()

Initializes a new instance.

Method Detail

getComputationalWeight

public double getComputationalWeight()

Get the computational weight associated with configuring this connection with the previous and next procedure. A number larger than one will indicate to the progress tracking system that the current connection takes more time to configure than other connections.

Returns:

The relative computational weight of this connection.

getSurfaceSegment

public abstract SurfaceSegment getSurfaceSegment()

Create the surface geometry for the given connection.

Returns:

The immutable geometry of the path over the ellipsoid surface.

getDependency

@Nonnull
public abstract SurfaceProcedureConnectionDependency getDependency()

Get the dependency for the connection indicating whether the previous or next connection should be configured before this one.

Returns:

The connection dependency.

configure

public abstract void configure(List<ConfigurableConnection> connections,
                               int currentIndex)

Configure this connection based on its index in the given list of all connections in the route.

Parameters:

connections - The list of all connections in the route.

currentIndex - The index where this connection occurs in the list of connections.

getEntryToNextConfiguration

public abstract SurfaceConfigurationResult getEntryToNextConfiguration()

Gets the result of configuring the entry into the next procedure.

getExitFromPreviousConfiguration

public abstract SurfaceConfigurationResult getExitFromPreviousConfiguration()

Gets the result of configuring the exit from the previous procedure.

setPoints

public abstract void setPoints(@Nonnull
                               Cartographic start,
                               @Nonnull
                               Cartographic stop)

Set the initial and final points of the connection segment.

Parameters:

start - The initial point of the connection.

stop - The final point of the connection.

setStart

public abstract void setStart(@Nonnull
                              Cartographic start)

Set the initial point of the connection segment.

Parameters:

start - The initial point of the connection.

setStop

public abstract void setStop(@Nonnull
                             Cartographic stop)

Set the final point of the connection segment.

Parameters:

stop - The final point of the connection.

getIsValid

public abstract boolean getIsValid()

Gets a value indicating whether this is a valid connection to the previous and next procedures.

setIsValid

public abstract void setIsValid(boolean value)

Sets a value indicating whether this is a valid connection to the previous and next procedures.

getHeading

public abstract double getHeading(double s)

Get the heading at an arbitrary point along the connection, in radians.

Parameters:

s - The arc length parameter along the connection, in meters.

Returns:

The heading measured clockwise from north, in radians.

getPoint

@Nonnull
public abstract Cartographic getPoint(double s)

Get the surface point along the connection at the given arc length.

Parameters:

s - The arc length parameter along the connection, in meters.

Returns:

The surface point at the given distance along the connection.

getInitialHeading

public abstract double getInitialHeading()

Gets the initial heading of the connection, in radians.

getFinalHeading

public abstract double getFinalHeading()

Gets the final heading of the connection, in radians.

getSurfaceDistance

public abstract double getSurfaceDistance()

Gets the total distance traversed by this connection from start to finish, in meters.

getInitialPoint

@Nonnull
public abstract Cartographic getInitialPoint()

Gets the initial point of the connection segment.

getFinalPoint

@Nonnull
public abstract Cartographic getFinalPoint()

Gets the final point of the connection segment.

getSurfaceShape

public abstract Ellipsoid getSurfaceShape()

Gets the shape of the reference surface upon which the surface geometry is defined.