DefaultConnectionBehavior

java.lang.Object
- agi.foundation.infrastructure.DefinitionalObject
- - agi.foundation.routedesign.DefaultConnectionBehavior

All Implemented Interfaces:

ICloneWithContext, IEnumerateDependencies, IEquatableDefinition, IFreezable
```
public class DefaultConnectionBehavior
extends DefinitionalObject
```
This is a RouteConnection used by the RoutePropagator to define the default settings for creating RouteConnection objects in between RouteProcedures in the event the user did not specify a specific connection to use.

Constructor Summary

Constructors
Modifier	Constructor and Description
	`DefaultConnectionBehavior()` Initializes a new instance.
`protected`	`DefaultConnectionBehavior(DefaultConnectionBehavior existingInstance, CopyContext context)` Initializes a new instance as a copy of an existing instance.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected boolean`	`checkForSameDefinition(DefaultConnectionBehavior other)` Checks to determine if another instance has the same definition as this instance and returns `true` if it does.
`protected boolean`	`checkForSameDefinition(DefinitionalObject 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.
`RouteConnection`	`createConnection(RouteProcedure previousProcedure, RouteProcedure nextProcedure)` Create a connection between two `RouteProcedures` based on the current settings for the connection behavior.
`ProfileDynamics`	`getDynamics()` Gets the dynamical characteristics of the position traversing the route.
`DefaultProfileBehavior`	`getKindOfProfile()` Gets an enumeration indicating what type of connection to use: following terrain, flying above terrain, or simply moving in a straight line between procedures.
`KindOfSurfaceConnection`	`getKindOfSurfaceConnection()` Gets the behavior to use to connect the surface procedures.
`double`	`getMinimumHeightAboveTerrain()` Gets the minimum height above the terrain.
`ProfileSpeed`	`getSpeed()` Gets the target cruise speed to use when traversing the connection.
`Ellipsoid`	`getSurfaceShape()` Gets the shape of the surface upon which the surface geometry of the route is defined.
`double`	`getTerrainSamplingDistance()` Gets the sampling distance used for the terrain avoidance algorithm.
`TerrainProvider`	`getTerrainSurface()` Gets the terrain surface that must be set if the `KindOfProfile` (`get` / `set`) is either `DefaultProfileBehavior.FOLLOW_TERRAIN` or `DefaultProfileBehavior.AVOID_TERRAIN`.
`boolean`	`getUseDirectTransition()` Gets a value indicating whether to connect directly between the initial and final conditions or whether to try to cruise using a constant height and speed if possible.
`void`	`setDynamics(ProfileDynamics value)` Sets the dynamical characteristics of the position traversing the route.
`void`	`setKindOfProfile(DefaultProfileBehavior value)` Sets an enumeration indicating what type of connection to use: following terrain, flying above terrain, or simply moving in a straight line between procedures.
`void`	`setKindOfSurfaceConnection(KindOfSurfaceConnection value)` Sets the behavior to use to connect the surface procedures.
`void`	`setMinimumHeightAboveTerrain(double value)` Sets the minimum height above the terrain.
`void`	`setSpeed(ProfileSpeed value)` Sets the target cruise speed to use when traversing the connection.
`void`	`setSurfaceShape(Ellipsoid value)` Sets the shape of the surface upon which the surface geometry of the route is defined.
`void`	`setTerrainSamplingDistance(double value)` Sets the sampling distance used for the terrain avoidance algorithm.
`void`	`setTerrainSurface(TerrainProvider value)` Sets the terrain surface that must be set if the `KindOfProfile` (`get` / `set`) is either `DefaultProfileBehavior.FOLLOW_TERRAIN` or `DefaultProfileBehavior.AVOID_TERRAIN`.
`void`	`setUseDirectTransition(boolean value)` Sets a value indicating whether to connect directly between the initial and final conditions or whether to try to cruise using a constant height and speed if possible.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - DefaultConnectionBehavior
```
public DefaultConnectionBehavior()
```
    Initializes a new instance.
  - DefaultConnectionBehavior
```
protected DefaultConnectionBehavior(@Nonnull
                                    DefaultConnectionBehavior 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(DefinitionalObject 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 DefinitionalObject
    
    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(DefaultConnectionBehavior 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 DefaultConnectionBehavior.checkForSameDefinition(agi.foundation.infrastructure.DefinitionalObject) method.
    
    Overrides:
    
    computeCurrentDefinitionHashCode in class DefinitionalObject
    
    Returns:
    
    The computed hash code.
  - getSurfaceShape
```
public final Ellipsoid getSurfaceShape()
```
    Gets the shape of the surface upon which the surface geometry of the route is defined.
  - setSurfaceShape
```
public final void setSurfaceShape(Ellipsoid value)
```
    Sets the shape of the surface upon which the surface geometry of the route is defined.
  - getTerrainSurface
```
public final TerrainProvider getTerrainSurface()
```
    Gets the terrain surface that must be set if the KindOfProfile (get / set) is either DefaultProfileBehavior.FOLLOW_TERRAIN or DefaultProfileBehavior.AVOID_TERRAIN.
  - setTerrainSurface
```
public final void setTerrainSurface(TerrainProvider value)
```
    Sets the terrain surface that must be set if the KindOfProfile (get / set) is either DefaultProfileBehavior.FOLLOW_TERRAIN or DefaultProfileBehavior.AVOID_TERRAIN.
  - getMinimumHeightAboveTerrain
```
public final double getMinimumHeightAboveTerrain()
```
    Gets the minimum height above the terrain. This is ignored if ignoring terrain altogether. In the case of following terrain, this is the constant offset above the terrain to use when moving along the terrain surface. For terrain avoidance, this is the minimum distance above which to create the route.
  - setMinimumHeightAboveTerrain
```
public final void setMinimumHeightAboveTerrain(double value)
```
    Sets the minimum height above the terrain. This is ignored if ignoring terrain altogether. In the case of following terrain, this is the constant offset above the terrain to use when moving along the terrain surface. For terrain avoidance, this is the minimum distance above which to create the route.
  - getTerrainSamplingDistance
```
public final double getTerrainSamplingDistance()
```
    Gets the sampling distance used for the terrain avoidance algorithm. A larger sampling distance will be faster but result in a higher chance that the route will go below the MinimumHeightAboveTerrain (get / set) in between samples.
  - setTerrainSamplingDistance
```
public final void setTerrainSamplingDistance(double value)
```
    Sets the sampling distance used for the terrain avoidance algorithm. A larger sampling distance will be faster but result in a higher chance that the route will go below the MinimumHeightAboveTerrain (get / set) in between samples.
  - getKindOfProfile
```
@Nonnull
public final DefaultProfileBehavior getKindOfProfile()
```
    Gets an enumeration indicating what type of connection to use: following terrain, flying above terrain, or simply moving in a straight line between procedures. By default, this will ignore terrain and connect with a straight line.
  - setKindOfProfile
```
public final void setKindOfProfile(@Nonnull
                                   DefaultProfileBehavior value)
```
    Sets an enumeration indicating what type of connection to use: following terrain, flying above terrain, or simply moving in a straight line between procedures. By default, this will ignore terrain and connect with a straight line.
  - getSpeed
```
public final ProfileSpeed getSpeed()
```
    Gets the target cruise speed to use when traversing the connection. In order for the connection to target this speed, UseDirectTransition (get / set) must be set to false.
  - setSpeed
```
public final void setSpeed(ProfileSpeed value)
```
    Sets the target cruise speed to use when traversing the connection. In order for the connection to target this speed, UseDirectTransition (get / set) must be set to false.
  - getDynamics
```
public final ProfileDynamics getDynamics()
```
    Gets the dynamical characteristics of the position traversing the route.
  - setDynamics
```
public final void setDynamics(ProfileDynamics value)
```
    Sets the dynamical characteristics of the position traversing the route.
  - getKindOfSurfaceConnection
```
@Nonnull
public final KindOfSurfaceConnection getKindOfSurfaceConnection()
```
    Gets the behavior to use to connect the surface procedures. By default the connections will follow a constant heading between procedures.
  - setKindOfSurfaceConnection
```
public final void setKindOfSurfaceConnection(@Nonnull
                                             KindOfSurfaceConnection value)
```
    Sets the behavior to use to connect the surface procedures. By default the connections will follow a constant heading between procedures.
  - getUseDirectTransition
```
public final boolean getUseDirectTransition()
```
    Gets a value indicating whether to connect directly between the initial and final conditions or whether to try to cruise using a constant height and speed if possible. By default, the default behavior is to connect directly.
  - setUseDirectTransition
```
public final void setUseDirectTransition(boolean value)
```
    Sets a value indicating whether to connect directly between the initial and final conditions or whether to try to cruise using a constant height and speed if possible. By default, the default behavior is to connect directly.
  - createConnection
```
public final RouteConnection createConnection(RouteProcedure previousProcedure,
                                              RouteProcedure nextProcedure)
```
    Create a connection between two RouteProcedures based on the current settings for the connection behavior.
    
    Parameters:
    
    previousProcedure - The previous procedure providing initial conditions for the connection.
    
    nextProcedure - The next procedure providing final conditions for the connection.
    
    Returns:
    
    A new instance of a connection to insert between the two RouteProcedures.

Class DefaultConnectionBehavior

Constructor Summary

Method Summary

Methods inherited from class agi.foundation.infrastructure.DefinitionalObject

Methods inherited from class java.lang.Object

Constructor Detail

DefaultConnectionBehavior

Method Detail

clone

checkForSameDefinition

checkForSameDefinition

computeCurrentDefinitionHashCode

getSurfaceShape

setSurfaceShape

getTerrainSurface

setTerrainSurface

getMinimumHeightAboveTerrain

setMinimumHeightAboveTerrain

getTerrainSamplingDistance

setTerrainSamplingDistance

getKindOfProfile

setKindOfProfile

getSpeed

setSpeed

getDynamics

setDynamics

getKindOfSurfaceConnection

setKindOfSurfaceConnection

getUseDirectTransition

setUseDirectTransition

createConnection