agi.foundation.routedesign

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

Class ProfileRouteConnection

java.lang.Object

agi.foundation.infrastructure.DefinitionalObject

agi.foundation.routedesign.RouteSegment

agi.foundation.routedesign.RouteConnection

agi.foundation.routedesign.ProfileRouteConnection

All Implemented Interfaces:

ICloneWithContext, IEnumerateDependencies, IEquatableDefinition, IFreezable

public class ProfileRouteConnection
extends RouteConnection

A simple route connection that defines a straight connection between two procedures with a user specified profile defining the vertical and temporal behavior along the connection.

Constructor Summary

Constructors

Modifier	Constructor and Description
	ProfileRouteConnection() Create a new instance.
	ProfileRouteConnection(Ellipsoid referenceSurface, RouteProfile connectionProfile) Create a new instance based on the given profile.
	ProfileRouteConnection(Ellipsoid referenceSurface, RouteProfile connectionProfile, KindOfSurfaceConnection kindOfConnection) Create a new instance based on the given profile and reference surface.
protected	ProfileRouteConnection(ProfileRouteConnection existingInstance, CopyContext context) Initializes a new instance as a copy of an existing instance.

Method Summary

Modifier and Type	Method and Description
protected boolean	checkForSameDefinition(ProfileRouteConnection other) Checks to determine if another instance has the same definition as this instance and returns true if it does.
protected boolean	checkForSameDefinition(RouteConnection other) Checks to determine if another instance has the same definition as this instance and returns true if it does.
Object	clone(CopyContext context) Clones this object using the specified context.
protected int	computeCurrentDefinitionHashCode() Computes a hash code based on the current properties of this object.
ConfigurableProfile	createConfigurableProfile(SurfaceSegment surfacePath) Create a profile based on the given settings that the RoutePropagator can use to configure this profile in relation to all other profiles along the route.
ConfigurableConnection	createConnection(ConfigurableSurfaceProcedure previousPath, ConfigurableSurfaceProcedure nextPath, RouteProcedure previousProcedure, RouteProcedure nextProcedure) Create the ConfigurableConnection used to configure how the route behaves when transitioning from one procedure to the next.
KindOfSurfaceConnection	getKindOfSurfaceConnection() Gets the kind of behavior to use when connecting surface procedures.
RouteProfile	getRouteProfile() Gets the profile to use in order to define the height and speed along the connection.
void	setKindOfSurfaceConnection(KindOfSurfaceConnection value) Sets the kind of behavior to use when connecting surface procedures.
void	setRouteProfile(RouteProfile value) Sets the profile to use in order to define the height and speed along the connection.

Methods inherited from class agi.foundation.routedesign.RouteConnection

checkForSameDefinition, getSurfaceShape, setSurfaceShape

Methods inherited from class agi.foundation.routedesign.RouteSegment

checkForSameDefinition

Methods inherited from class agi.foundation.infrastructure.DefinitionalObject

areSameDefinition, areSameDefinition, areSameDefinition, areSameDefinition, areSameDefinition, 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

ProfileRouteConnection

public ProfileRouteConnection()

Create a new instance. The RouteProfile (get / set) must be set prior to creating the connection. By default this will connect procedures using a constant heading.

ProfileRouteConnection

public ProfileRouteConnection(Ellipsoid referenceSurface,
                              RouteProfile connectionProfile)

Create a new instance based on the given profile. By default this will connect procedures using a constant heading.

Parameters:

referenceSurface - The shape of the surface over which to define the connection.

connectionProfile - The profile defining the height and speed along the connection.

ProfileRouteConnection

public ProfileRouteConnection(Ellipsoid referenceSurface,
                              RouteProfile connectionProfile,
                              @Nonnull
                              KindOfSurfaceConnection kindOfConnection)

Create a new instance based on the given profile and reference surface.

Parameters:

referenceSurface - The shape of the surface over which to define the connection.

connectionProfile - The profile defining the height and speed along the connection.

kindOfConnection - The type of behavior to use when connecting the surface procedures.

ProfileRouteConnection

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

clone

public Object clone(CopyContext context)

Clones this object using the specified context.

This method should be implemented to call a copy constructor on the class of the object being cloned. The copy constructor should take the CopyContext as a parameter in addition to the existing instance to copy. The copy constructor should first call CopyContext.addObjectMapping(T, T) to identify the newly constructed instance as a copy of the existing instance. It should then copy all fields, using CopyContext.updateReference(T) to copy any reference fields.

A typical implementation of ICloneWithContext:

public static class MyClass implements ICloneWithContext {
    public MyClass(MyClass existingInstance, CopyContext context) {
        context.addObjectMapping(existingInstance, this);
        someReference = context.updateReference(existingInstance.someReference);
    }

    @Override
    public final Object clone(CopyContext context) {
        return new MyClass(this, context);
    }

    private Object someReference;
}

In general, all fields that are reference types should be copied with a call to CopyContext.updateReference(T). There are a couple of exceptions:

1. Fields that are aggregate parts of the object should always be copied. A referenced object is an aggregate if properties or methods on the object being copied can modify the externally-visible value of the referenced object.
2. If the semantics of the referenced object require that it have a single parent, owner, context, etc., and the object being copied is that parent, owner, or context, then the referenced object should always be copied.

If one of these exceptions applies, the CopyContext should be given an opportunity to update the reference before the reference is copied explicitly. Use CopyContext.updateReference(T) to update the reference. If CopyContext.updateReference(T) returns the original object, indicating that the context does not have a replacement registered, then copy the object manually by invoking a Clone method, a copy constructor, or by manually constructing a new instance and copying the values.

alwaysCopy = context.updateReference(existingInstance.alwaysCopy);
if (existingInstance.alwaysCopy != null && alwaysCopy == existingInstance.alwaysCopy) {
    alwaysCopy = (AlwaysCopy) existingInstance.alwaysCopy.clone(context);
}

If you are implementing an evaluator (a class that implements IEvaluator), the IEvaluator.updateEvaluatorReferences(agi.foundation.infrastructure.CopyContext) method shares some responsibilities with the copy context constructor. Code duplication can be avoided by doing the following:

1. For references to other evaluators ONLY, simply assign the reference in the constructor instead of calling CopyContext.updateReference(T). You should still call CopyContext.updateReference(T) on any references to non-evaluators.
2. Call IEvaluator.updateEvaluatorReferences(agi.foundation.infrastructure.CopyContext) as the last line in the constructor and pass it the same CopyContext passed to the constructor.
3. Implement IEvaluator.updateEvaluatorReferences(agi.foundation.infrastructure.CopyContext) as normal. See the reference documentation for IEvaluator.updateEvaluatorReferences(agi.foundation.infrastructure.CopyContext) for more information on implementing that method.

public MyClass(MyClass existingInstance, CopyContext context) {
    super(existingInstance, context);
    someReference = context.updateReference(existingInstance.someReference);
    evaluatorReference = existingInstance.evaluatorReference;
    updateEvaluatorReferences(context);
}

@Override
public void updateEvaluatorReferences(CopyContext context) {
    evaluatorReference = context.updateReference(evaluatorReference);
}

@Override
public Object clone(CopyContext context) {
    return new MyClass(this, context);
}

private Object someReference;
private IEvaluator evaluatorReference;

Specified by:

clone in interface ICloneWithContext

Specified by:

clone in class DefinitionalObject

Parameters:

context - The context to use to perform the copy.

Returns:

A new instance which is a copy of this object.

checkForSameDefinition

protected final 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).

Specified by:

checkForSameDefinition in class RouteConnection

Parameters:

other - The other instance to compare to this one.

Returns:

true if the two objects are defined equivalently; otherwise false.

checkForSameDefinition

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

Overrides:

computeCurrentDefinitionHashCode in class RouteConnection

Returns:

The computed hash code.

createConnection

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

Create the ConfigurableConnection used to configure how the route behaves when transitioning from one procedure to the next.

Specified by:

createConnection in class RouteConnection

Parameters:

previousPath - The surface path at the beginning of the connection.

nextPath - The surface path at the end of the connection.

previousProcedure - The previous procedure with the initial conditions for the connection.

nextProcedure - The next procedure with the final conditions for the connection.

Returns:

The configurable connection.

getRouteProfile

public final RouteProfile getRouteProfile()

Gets the profile to use in order to define the height and speed along the connection.

setRouteProfile

public final void setRouteProfile(RouteProfile value)

Sets the profile to use in order to define the height and speed along the connection.

createConfigurableProfile

public ConfigurableProfile createConfigurableProfile(SurfaceSegment surfacePath)

Create a profile based on the given settings that the RoutePropagator can use to configure this profile in relation to all other profiles along the route.

Specified by:

createConfigurableProfile in class RouteSegment

Parameters:

surfacePath - The surface path over which the profile is defined.

Returns:

The configurable profile used by the RoutePropagator to configure the route.

getKindOfSurfaceConnection

@Nonnull
public final KindOfSurfaceConnection getKindOfSurfaceConnection()

Gets the kind of behavior to use when connecting surface procedures. By default, the connections will connect by using constant heading.

setKindOfSurfaceConnection

public final void setKindOfSurfaceConnection(@Nonnull
                                             KindOfSurfaceConnection value)

Sets the kind of behavior to use when connecting surface procedures. By default, the connections will connect by using constant heading.