agi.foundation.routedesign

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

Class RouteConnection

java.lang.Object

agi.foundation.infrastructure.DefinitionalObject

agi.foundation.routedesign.RouteSegment

agi.foundation.routedesign.RouteConnection

All Implemented Interfaces:

ICloneWithContext, IEnumerateDependencies, IEquatableDefinition, IFreezable

Direct Known Subclasses:

ProfileRouteConnection

public abstract class RouteConnection
extends RouteSegment

The base class for all the different ways in which to connect one RouteProcedure with another.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	RouteConnection() Create a new instance.
protected	RouteConnection(Ellipsoid surfaceShape) Create a new instance.
protected	RouteConnection(RouteConnection existingInstance, CopyContext context) Initializes a new instance as a copy of an existing instance.

Method Summary

Modifier and Type	Method and Description
protected abstract boolean	checkForSameDefinition(RouteConnection other) Checks to determine if another instance has the same definition as this instance and returns true if it does.
protected boolean	checkForSameDefinition(RouteSegment 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.
abstract ConfigurableConnection	createConnection(ConfigurableSurfaceProcedure previousPath, ConfigurableSurfaceProcedure nextPath, RouteProcedure previousProcedure, RouteProcedure nextProcedure) Create the ConfigurableConnection that can be used by the RoutePropagator to configure the connections between route segments.
Ellipsoid	getSurfaceShape() Gets the reference surface to use when defining the surface geometry and heights above it.
void	setSurfaceShape(Ellipsoid value) Sets the reference surface to use when defining the surface geometry and heights above it.

Methods inherited from class agi.foundation.routedesign.RouteSegment

checkForSameDefinition, createConfigurableProfile

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

RouteConnection

protected RouteConnection()

Create a new instance.

RouteConnection

protected RouteConnection(Ellipsoid surfaceShape)

Create a new instance.

Parameters:

surfaceShape - The reference surface to use when defining the surface geometry and heights above it.

RouteConnection

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

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

Overrides:

computeCurrentDefinitionHashCode in class RouteSegment

Returns:

The computed hash code.

createConnection

public abstract ConfigurableConnection createConnection(ConfigurableSurfaceProcedure previousPath,
                                                        ConfigurableSurfaceProcedure nextPath,
                                                        RouteProcedure previousProcedure,
                                                        RouteProcedure nextProcedure)

Create the ConfigurableConnection that can be used by the RoutePropagator to configure the connections between route segments.

Parameters:

previousPath - The previous procedure's configurable path.

nextPath - The next procedure's configurable path.

previousProcedure - The previous procedure.

nextProcedure - The next procedure.

Returns:

The connection between the previous and next procedures.

getSurfaceShape

public final Ellipsoid getSurfaceShape()

Gets the reference surface to use when defining the surface geometry and heights above it. By default, this is the shape of the Earth taken from EarthCentralBody.

setSurfaceShape

public final void setSurfaceShape(Ellipsoid value)

Sets the reference surface to use when defining the surface geometry and heights above it. By default, this is the shape of the Earth taken from EarthCentralBody.