agi.foundation.routedesign.advanced

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

Class SurfaceProcedureConnection

java.lang.Object

agi.foundation.routedesign.advanced.ConfigurableConnection

agi.foundation.routedesign.advanced.SurfaceProcedureConnection

public abstract class SurfaceProcedureConnection
extends ConfigurableConnection

Base class for all connections that have an arbitrary profile.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	SurfaceProcedureConnection() Create a new instance.

Method Summary

Modifier and Type	Method and Description
ConnectionStrategy	getConnection() Gets the strategy to use when connecting the previous procedure with the next.
double	getFinalHeading() Gets the final heading of the connection, in radians.
Cartographic	getFinalPoint() Gets the final point of the connection segment.
double	getHeading(double s) Get the heading at an arbitrary point along the connection, in radians.
double	getInitialHeading() Gets the initial heading of the connection, in radians.
Cartographic	getInitialPoint() Gets the initial point of the connection segment.
boolean	getIsValid() Gets a value indicating whether this is a valid connection to the previous and next procedures.
Cartographic	getPoint(double s) Get the surface point along the connection at the given arc length.
double	getSurfaceDistance() Gets the total distance traversed by this connection from start to finish, in meters.
SurfaceSegment	getSurfaceSegment() Create the surface geometry for the given connection.
Ellipsoid	getSurfaceShape() Gets the shape of the reference surface upon which the surface geometry is defined.
protected void	setConnection(ConnectionStrategy value) Sets the strategy to use when connecting the previous procedure with the next.
void	setIsValid(boolean value) Sets a value indicating whether this is a valid connection to the previous and next procedures.
void	setPoints(Cartographic start, Cartographic stop) Set the initial and final points of the connection segment.
void	setStart(Cartographic start) Set the initial point of the connection segment.
void	setStop(Cartographic stop) Set the final point of the connection segment.

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

configure, getComputationalWeight, getDependency, getEntryToNextConfiguration, getExitFromPreviousConfiguration

Methods inherited from class java.lang.Object

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

Constructor Detail

SurfaceProcedureConnection

protected SurfaceProcedureConnection()

Create a new instance.

Method Detail

getConnection

public final ConnectionStrategy getConnection()

Gets the strategy to use when connecting the previous procedure with the next. This determines the behavior of how the initial and final headings change as the initial and final points change.

setConnection

protected final void setConnection(ConnectionStrategy value)

Sets the strategy to use when connecting the previous procedure with the next. This determines the behavior of how the initial and final headings change as the initial and final points change.

getSurfaceSegment

public SurfaceSegment getSurfaceSegment()

Create the surface geometry for the given connection.

Specified by:

getSurfaceSegment in class ConfigurableConnection

Returns:

The immutable geometry of the path over the ellipsoid surface.

setPoints

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

Set the initial and final points of the connection segment.

Specified by:

setPoints in class ConfigurableConnection

Parameters:

start - The initial point of the connection.

stop - The final point of the connection.

setStart

public void setStart(@Nonnull
                     Cartographic start)

Set the initial point of the connection segment.

Specified by:

setStart in class ConfigurableConnection

Parameters:

start - The initial point of the connection.

setStop

public void setStop(@Nonnull
                    Cartographic stop)

Set the final point of the connection segment.

Specified by:

setStop in class ConfigurableConnection

Parameters:

stop - The final point of the connection.

getIsValid

public boolean getIsValid()

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

Specified by:

getIsValid in class ConfigurableConnection

setIsValid

public void setIsValid(boolean value)

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

Specified by:

setIsValid in class ConfigurableConnection

getHeading

public double getHeading(double s)

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

Specified by:

getHeading in class ConfigurableConnection

Parameters:

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

Returns:

The heading measured clockwise from north, in radians.

getPoint

@Nonnull
public Cartographic getPoint(double s)

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

Specified by:

getPoint in class ConfigurableConnection

Parameters:

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

Returns:

The surface point at the given distance along the connection.

getInitialHeading

public double getInitialHeading()

Gets the initial heading of the connection, in radians.

Specified by:

getInitialHeading in class ConfigurableConnection

getFinalHeading

public double getFinalHeading()

Gets the final heading of the connection, in radians.

Specified by:

getFinalHeading in class ConfigurableConnection

getSurfaceDistance

public double getSurfaceDistance()

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

Specified by:

getSurfaceDistance in class ConfigurableConnection

getInitialPoint

@Nonnull
public Cartographic getInitialPoint()

Gets the initial point of the connection segment.

Specified by:

getInitialPoint in class ConfigurableConnection

getFinalPoint

@Nonnull
public Cartographic getFinalPoint()

Gets the final point of the connection segment.

Specified by:

getFinalPoint in class ConfigurableConnection

getSurfaceShape

public Ellipsoid getSurfaceShape()

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

Specified by:

getSurfaceShape in class ConfigurableConnection