agi.foundation.routedesign.advanced

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

Class ConnectionStrategy

java.lang.Object

agi.foundation.routedesign.advanced.ConnectionStrategy

Direct Known Subclasses:

GeodesicConnectionStrategy, RhumbLineConnectionStrategy

public abstract class ConnectionStrategy
extends Object

Base class for a set of connections that represent a path from one Cartographic point to another.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
abstract double	getDistance() Get the total distance traversed by this connection from start to finish, in meters.
abstract double	getFinalHeading() Get the final heading of the connection, in radians.
abstract double	getFinalHeading(Ellipsoid shape, Cartographic initialPoint, Cartographic finalPoint) Get the final heading of the curve corresponding to the given parameters.
abstract double	getFinalHeading(Ellipsoid shape, Cartographic initialPoint, double heading, double distance) Get the final heading of the curve corresponding to the given parameters.
abstract double	getFinalHeading(EllipsoidSurfaceCurve curve) Get the final heading of the given curve, 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() Get the initial heading of the connection, in radians.
abstract double	getInitialHeading(Ellipsoid shape, Cartographic initialPoint, Cartographic finalPoint) Get the initial heading of the curve corresponding to the given parameters.
abstract double	getInitialHeading(EllipsoidSurfaceCurve curve) Get the initial heading of the given curve, in radians.
abstract Cartographic	getInitialPoint() Gets the initial point of the connection segment.
abstract EllipsoidSurfaceCurve	getSurfaceCurve(Ellipsoid shape, Cartographic initialPoint, Cartographic finalPoint) Generate a curve representing the connection from the initial to the final point.
abstract EllipsoidSurfaceCurve	getSurfaceCurve(Ellipsoid shape, Cartographic initialPoint, double heading, double distance) Generate a curve representing the connection from the initial to the final point.
abstract Cartographic	getSurfacePoint(double s) Get the surface point along the connection at the given arc length.
abstract SurfaceSegment	getSurfaceSegment() Get an instance of the surface geometry corresponding to this connection segment.
abstract Ellipsoid	getSurfaceShape() Gets the shape of the reference surface upon which the surface geometry is defined.
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.
abstract void	setSurfaceCurve(EllipsoidSurfaceCurve curve) Set this connection to use the given surface curve.

Methods inherited from class java.lang.Object

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

Constructor Detail

ConnectionStrategy

protected ConnectionStrategy()

Initializes a new instance.

Method Detail

getSurfaceCurve

public abstract EllipsoidSurfaceCurve getSurfaceCurve(Ellipsoid shape,
                                                      @Nonnull
                                                      Cartographic initialPoint,
                                                      @Nonnull
                                                      Cartographic finalPoint)

Generate a curve representing the connection from the initial to the final point.

Parameters:

shape - The surface shape to use.

initialPoint - The initial point of the curve.

finalPoint - The final point of the curve.

Returns:

The resulting connection curve.

getSurfaceCurve

public abstract EllipsoidSurfaceCurve getSurfaceCurve(Ellipsoid shape,
                                                      @Nonnull
                                                      Cartographic initialPoint,
                                                      double heading,
                                                      double distance)

Generate a curve representing the connection from the initial to the final point.

Parameters:

shape - The surface shape to use.

initialPoint - The initial point of the curve.

heading - The initial heading along the curve, in radians.

distance - The surface distance along the curve, in meters.

Returns:

The resulting connection curve.

getInitialHeading

public abstract double getInitialHeading(EllipsoidSurfaceCurve curve)

Get the initial heading of the given curve, in radians.

Parameters:

curve - The curve to analyze.

Returns:

The initial heading of the curve, in radians.

getFinalHeading

public abstract double getFinalHeading(EllipsoidSurfaceCurve curve)

Get the final heading of the given curve, in radians.

Parameters:

curve - The curve to analyze.

Returns:

The final heading of the curve, in radians.

getInitialHeading

public abstract double getInitialHeading(Ellipsoid shape,
                                         @Nonnull
                                         Cartographic initialPoint,
                                         @Nonnull
                                         Cartographic finalPoint)

Get the initial heading of the curve corresponding to the given parameters.

Parameters:

shape - The shape of the surface.

initialPoint - The initial point of the curve.

finalPoint - The final point of the curve.

Returns:

The initial heading along the curve, in radians.

getFinalHeading

public abstract double getFinalHeading(Ellipsoid shape,
                                       @Nonnull
                                       Cartographic initialPoint,
                                       @Nonnull
                                       Cartographic finalPoint)

Get the final heading of the curve corresponding to the given parameters.

Parameters:

shape - The shape of the surface.

initialPoint - The initial point on the curve.

finalPoint - The final point on the curve.

Returns:

The final heading along the curve, in radians.

getFinalHeading

public abstract double getFinalHeading(Ellipsoid shape,
                                       @Nonnull
                                       Cartographic initialPoint,
                                       double heading,
                                       double distance)

Get the final heading of the curve corresponding to the given parameters.

Parameters:

shape - The shape of the surface.

initialPoint - The initial point on the curve.

heading - The initial heading along the curve, in radians.

distance - The surface distance along the curve, in meters.

Returns:

The final heading along the curve, in radians.

setSurfaceCurve

public abstract void setSurfaceCurve(EllipsoidSurfaceCurve curve)

Set this connection to use the given surface curve.

If the given curve is incompatible with the current strategy, the strategy will attempt to create a new curve that will use the end points of the specified curve.

Parameters:

curve - The curve to use as the connection.

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.

getInitialHeading

public abstract double getInitialHeading()

Get the initial heading of the connection, in radians.

Returns:

The initial heading measured clockwise from north, in radians.

getFinalHeading

public abstract double getFinalHeading()

Get the final heading of the connection, in radians.

Returns:

The final heading measured clockwise from north, in radians.

getDistance

public abstract double getDistance()

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

Returns:

The total distance, in meters.

getSurfaceSegment

public abstract SurfaceSegment getSurfaceSegment()

Get an instance of the surface geometry corresponding to this connection segment.

Returns:

The immutable surface geometry corresponding to this connection.

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.

getSurfacePoint

@Nonnull
public abstract Cartographic getSurfacePoint(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.

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.