agi.foundation.routedesign

(agi.foundation.routedesign-2023r1.jar)

Class TurnBeforeWaypointProcedure

java.lang.Object

agi.foundation.infrastructure.DefinitionalObject

agi.foundation.routedesign.RouteSegment

agi.foundation.routedesign.RouteProcedure

agi.foundation.routedesign.advanced.SimpleRouteProcedure

agi.foundation.routedesign.TurnBeforeWaypointProcedure

All Implemented Interfaces:

ICloneWithContext, IEnumerateDependencies, IEquatableDefinition, IFreezable

public class TurnBeforeWaypointProcedure
extends SimpleRouteProcedure

Represents a simple turn at a specific position such that the platform will turn prior to the waypoint in order to arrive on the heading toward the next waypoint.

This procedure is illustrated by the following image:

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	TurnBeforeWaypointProcedure.ConfigurationData An enumeration indicating the status of configuring the surface procedure.

Constructor Summary

Constructors

Modifier	Constructor and Description
	TurnBeforeWaypointProcedure() Create a new instance.
	TurnBeforeWaypointProcedure(Cartographic waypoint, double turnRadius, double speed) Create a new instance based on the given parameters over the surface of the Earth (get).
	TurnBeforeWaypointProcedure(double waypointLongitude, double waypointLatitude, double turnRadius, double speed, double heightAboveSurface, RouteHeightReference heightReference) Create a new instance based on the given parameters over the surface of the Earth (get).
	TurnBeforeWaypointProcedure(double waypointLongitude, double waypointLatitude, double turnRadius, double speed, double heightAboveSurface, TerrainProvider terrain) Create a new instance based on the given parameters over the surface of the Earth (get).
	TurnBeforeWaypointProcedure(Ellipsoid surfaceShape, Cartographic waypoint, double turnRadius, RouteProfile profile) Create a new instance based on the given surface parameters and profile.
protected	TurnBeforeWaypointProcedure(TurnBeforeWaypointProcedure 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(SimpleRouteProcedure other) Checks to determine if another instance has the same definition as this instance and returns true if it does.
protected boolean	checkForSameDefinition(TurnBeforeWaypointProcedure 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.
ConfigurableSurfaceProcedure	getSurfacePath() Get an object that will allow configuration of the surface geometry as it connects with other procedures.
Ellipsoid	getSurfaceShape() Gets the shape of the reference surface over which to define the surface geometry.
WaypointTurnDirection	getTurnDirection() Gets an enumeration indicating whether to force the waypoint to turn in a particular direction.
double	getTurningRadius() Gets the horizontal radius at which to turn before the waypoint, in meters.
Cartographic	getWaypoint() Gets the waypoint location at which the procedure occurs.
void	setSurfaceShape(Ellipsoid value) Sets the shape of the reference surface over which to define the surface geometry.
void	setTurnDirection(WaypointTurnDirection value) Sets an enumeration indicating whether to force the waypoint to turn in a particular direction.
void	setTurningRadius(double value) Sets the horizontal radius at which to turn before the waypoint, in meters.
void	setWaypoint(Cartographic value) Sets the waypoint location at which the procedure occurs.

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

checkForSameDefinition, createConfigurableProfile, getProfile, setProfile, setProfileFromHeight, setProfileFromHeightAboveMeanSeaLevel, setProfileFromHeightAboveSurface, setProfileFromHeightAboveTerrain

Methods inherited from class agi.foundation.routedesign.RouteProcedure

checkForSameDefinition

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

TurnBeforeWaypointProcedure

public TurnBeforeWaypointProcedure()

Create a new instance.

TurnBeforeWaypointProcedure

public TurnBeforeWaypointProcedure(@Nonnull
                                   Cartographic waypoint,
                                   double turnRadius,
                                   double speed)

Create a new instance based on the given parameters over the surface of the Earth (get).

Parameters:

waypoint - The waypoint at which to arrive on the heading toward the next waypoint.

turnRadius - The horizontal turning radius at which to turn when arriving at the waypoint, in meters.

speed - The target speed at which to turn at the waypoint, in meters per second.

TurnBeforeWaypointProcedure

public TurnBeforeWaypointProcedure(double waypointLongitude,
                                   double waypointLatitude,
                                   double turnRadius,
                                   double speed,
                                   double heightAboveSurface,
                                   @Nonnull
                                   RouteHeightReference heightReference)

Create a new instance based on the given parameters over the surface of the Earth (get).

Parameters:

waypointLongitude - The longitude of the waypoint, in radians.

waypointLatitude - The geodetic latitude of the waypoint, in radians.

turnRadius - The horizontal turning radius at which to turn when arriving at the waypoint, in meters.

speed - The target speed at which to turn at the waypoint, in meters per second.

heightAboveSurface - The height above the reference surface at which to arrive at the waypoint, in meters.

heightReference - The reference to use when defining the heightAboveSurface.

TurnBeforeWaypointProcedure

public TurnBeforeWaypointProcedure(double waypointLongitude,
                                   double waypointLatitude,
                                   double turnRadius,
                                   double speed,
                                   double heightAboveSurface,
                                   @Nonnull
                                   TerrainProvider terrain)

Create a new instance based on the given parameters over the surface of the Earth (get).

Parameters:

waypointLongitude - The longitude of the waypoint, in radians.

waypointLatitude - The geodetic latitude of the waypoint, in radians.

turnRadius - The horizontal turning radius at which to turn when arriving at the waypoint, in meters.

speed - The target speed at which to turn at the waypoint, in meters per second.

heightAboveSurface - The height above the reference surface at which to arrive at the waypoint, in meters.

terrain - The terrain surface to use when defining the heightAboveSurface.

Throws:

ArgumentNullException - Thrown when terrain is null.

TurnBeforeWaypointProcedure

public TurnBeforeWaypointProcedure(Ellipsoid surfaceShape,
                                   @Nonnull
                                   Cartographic waypoint,
                                   double turnRadius,
                                   RouteProfile profile)

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

Parameters:

surfaceShape - The shape of the reference surface over which to define the surface geometry.

waypoint - The waypoint at which to arrive on the heading toward the next waypoint.

turnRadius - The horizontal turning radius at which to turn toward the heading toward the next waypoint, in meters.

profile - The profile defining the height and speed during the turn.

TurnBeforeWaypointProcedure

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

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(TurnBeforeWaypointProcedure 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 TurnBeforeWaypointProcedure.checkForSameDefinition(agi.foundation.routedesign.advanced.SimpleRouteProcedure) method.

Overrides:

computeCurrentDefinitionHashCode in class SimpleRouteProcedure

Returns:

The computed hash code.

getTurnDirection

@Nonnull
public final WaypointTurnDirection getTurnDirection()

Gets an enumeration indicating whether to force the waypoint to turn in a particular direction.

setTurnDirection

public final void setTurnDirection(@Nonnull
                                   WaypointTurnDirection value)

Sets an enumeration indicating whether to force the waypoint to turn in a particular direction.

getTurningRadius

public final double getTurningRadius()

Gets the horizontal radius at which to turn before the waypoint, in meters.

setTurningRadius

public final void setTurningRadius(double value)

Sets the horizontal radius at which to turn before the waypoint, in meters.

getSurfaceShape

public final Ellipsoid getSurfaceShape()

Gets the shape of the reference surface over which to define the surface geometry.

setSurfaceShape

public final void setSurfaceShape(Ellipsoid value)

Sets the shape of the reference surface over which to define the surface geometry.

getWaypoint

@Nonnull
public final Cartographic getWaypoint()

Gets the waypoint location at which the procedure occurs.

setWaypoint

public final void setWaypoint(@Nonnull
                              Cartographic value)

Sets the waypoint location at which the procedure occurs.

getSurfacePath

public ConfigurableSurfaceProcedure getSurfacePath()

Get an object that will allow configuration of the surface geometry as it connects with other procedures.

This is used by the RoutePropagator to ensure smooth connection between procedures.

Specified by:

getSurfacePath in class RouteProcedure

Returns:

The configurable surface geometry.