agi.foundation.routedesign

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

Class RacetrackHoldProcedure

java.lang.Object

agi.foundation.infrastructure.DefinitionalObject

agi.foundation.routedesign.RouteSegment

agi.foundation.routedesign.RouteProcedure

agi.foundation.routedesign.RacetrackHoldProcedure

All Implemented Interfaces:

ICloneWithContext, IEnumerateDependencies, IEquatableDefinition, IFreezable

public class RacetrackHoldProcedure
extends RouteProcedure

A procedure defined by two circular turns connected by straight segments with entry and exit occurring at either circle or at additional turns occurring at the beginning or ends of the straight segments. The RoutePropagator will attempt to connect the previous procedure with the nearest entry arc on the racetrack and leave at the exit arc nearest to the next procedure.

This procedure is illustrated by the following image:

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

Modifier	Constructor and Description
	RacetrackHoldProcedure() Create a new instance.
	RacetrackHoldProcedure(Ellipsoid surfaceShape, Cartographic centerOfTurnOne, Cartographic centerOfTurnTwo, double turningRadius, double minimumRevolutions, ClosedTurnDirection turnDirection, double speed, double height, RouteHeightReference heightReference) Create a new instance based on the given parameters.
	RacetrackHoldProcedure(Ellipsoid surfaceShape, Cartographic centerOfTurnOne, Cartographic centerOfTurnTwo, double turningRadius, Duration minimumTime, ClosedTurnDirection turnDirection, HoldingPatternProfile profile) Create a new instance based on the given parameters.
	RacetrackHoldProcedure(Ellipsoid surfaceShape, Cartographic center, double headingAlongTrack, double lengthBetweenTurns, double turnRadius, double minimumRevolutions, ClosedTurnDirection turnDirection, double speed, double height, RouteHeightReference heightReference) Create a new instance based on the given parameters.
	RacetrackHoldProcedure(Ellipsoid surfaceShape, Cartographic center, double headingAlongTrack, double lengthBetweenTurns, double turnRadius, Duration minimumTime, ClosedTurnDirection turnDirection, HoldingPatternProfile profile) Create a new instance based on the given parameters.
protected	RacetrackHoldProcedure(RacetrackHoldProcedure 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(RacetrackHoldProcedure other) Checks to determine if another instance has the same definition as this instance and returns true if it does.
protected boolean	checkForSameDefinition(RouteProcedure 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.
Cartographic	getCenterOfTurnOne() Gets the center of the first racetrack turn.
Cartographic	getCenterOfTurnTwo() Gets the center of the second racetrack turn.
boolean	getConstrainEntryAndExitToTrackArcs() Gets a value indicating whether to ignore the additional entry and exit turns, restricting the entry and exit to be tangent to the two turns in the racetrack.
double	getMinimumRevolutions() Gets the minimum number of complete revolutions around the racetrack to make prior to leaving.
Duration	getMinimumTime() Gets the minimum time to spend in the hold before leaving.
HoldingPatternProfile	getProfile() Gets the profile to use for this racetrack hold.
ConfigurableSurfaceProcedure	getSurfacePath() Get an object that will allow configuration of the surface geometry as it connects with other procedures.
Ellipsoid	getSurfaceShape() Gets the reference surface over which to define the geometry.
ClosedTurnDirection	getTurnDirection() Gets the direction in which the racetrack turns.
double	getTurningRadiusForEntryAndExit() Gets the turning radius used to enter and exit the racetrack, in meters.
double	getTurningRadiusForHold() Gets the radius of the circular arcs at either end of the racetrack, in meters.
void	setCenterOfTurnOne(Cartographic value) Sets the center of the first racetrack turn.
void	setCenterOfTurnTwo(Cartographic value) Sets the center of the second racetrack turn.
void	setConstrainEntryAndExitToTrackArcs(boolean value) Sets a value indicating whether to ignore the additional entry and exit turns, restricting the entry and exit to be tangent to the two turns in the racetrack.
void	setMinimumRevolutions(double value) Sets the minimum number of complete revolutions around the racetrack to make prior to leaving.
void	setMinimumTime(Duration value) Sets the minimum time to spend in the hold before leaving.
void	setProfile(HoldingPatternProfile value) Sets the profile to use for this racetrack hold.
void	setSurfaceShape(Ellipsoid value) Sets the reference surface over which to define the geometry.
void	setTurnDirection(ClosedTurnDirection value) Sets the direction in which the racetrack turns.
void	setTurningRadiusForEntryAndExit(double value) Sets the turning radius used to enter and exit the racetrack, in meters.
void	setTurningRadiusForHold(double value) Sets the radius of the circular arcs at either end of the racetrack, in meters.

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

RacetrackHoldProcedure

public RacetrackHoldProcedure()

Create a new instance.

RacetrackHoldProcedure

public RacetrackHoldProcedure(Ellipsoid surfaceShape,
                              @Nonnull
                              Cartographic center,
                              double headingAlongTrack,
                              double lengthBetweenTurns,
                              double turnRadius,
                              double minimumRevolutions,
                              @Nonnull
                              ClosedTurnDirection turnDirection,
                              double speed,
                              double height,
                              @Nonnull
                              RouteHeightReference heightReference)

Create a new instance based on the given parameters.

Parameters:

surfaceShape - The reference surface over which to define the procedure.

center - The center of the racetrack hold.

headingAlongTrack - The heading along straight segment.

lengthBetweenTurns - The length of the straight segment or the distance between the centers of the two circular turns.

turnRadius - The turning radius used for all the turns, in meters.

minimumRevolutions - A scalar indicating the minimum number of times to make a complete revolution around the racetrack.

turnDirection - The turn direction to use for the racetrack turns.

speed - The speed at which to traverse the racetrack, in meters per second.

height - The height with respect to the heightReference, in meters.

heightReference - An enumeration indicating which reference the height is defined with respect to.

RacetrackHoldProcedure

public RacetrackHoldProcedure(Ellipsoid surfaceShape,
                              @Nonnull
                              Cartographic centerOfTurnOne,
                              @Nonnull
                              Cartographic centerOfTurnTwo,
                              double turningRadius,
                              double minimumRevolutions,
                              @Nonnull
                              ClosedTurnDirection turnDirection,
                              double speed,
                              double height,
                              @Nonnull
                              RouteHeightReference heightReference)

Create a new instance based on the given parameters.

Parameters:

surfaceShape - The reference surface over which to define the procedure.

centerOfTurnOne - The center of the first circular turn.

centerOfTurnTwo - The center of the second circular turn.

turningRadius - The turning radius used for all the turns, in meters.

minimumRevolutions - A scalar indicating the minimum number of times to make a complete revolution around the racetrack.

turnDirection - The turn direction to use for the racetrack turns.

speed - The speed at which to traverse the racetrack, in meters per second.

height - The height with respect to the heightReference, in meters.

heightReference - An enumeration indicating which reference the height is defined with respect to.

RacetrackHoldProcedure

public RacetrackHoldProcedure(Ellipsoid surfaceShape,
                              @Nonnull
                              Cartographic center,
                              double headingAlongTrack,
                              double lengthBetweenTurns,
                              double turnRadius,
                              @Nonnull
                              Duration minimumTime,
                              @Nonnull
                              ClosedTurnDirection turnDirection,
                              HoldingPatternProfile profile)

Create a new instance based on the given parameters.

Parameters:

surfaceShape - The reference surface over which to define the procedure.

center - The center of the racetrack hold.

headingAlongTrack - The heading along straight segment.

lengthBetweenTurns - The length of the straight segment or the distance between the centers of the two circular turns.

turnRadius - The turning radius used for all the turns, in meters.

minimumTime - The minimum time to spend in the racetrack hold before leaving.

turnDirection - The turn direction to use for the racetrack turns.

profile - The profile defining the vertical and time dynamic geometry for the procedure.

RacetrackHoldProcedure

public RacetrackHoldProcedure(Ellipsoid surfaceShape,
                              @Nonnull
                              Cartographic centerOfTurnOne,
                              @Nonnull
                              Cartographic centerOfTurnTwo,
                              double turningRadius,
                              @Nonnull
                              Duration minimumTime,
                              @Nonnull
                              ClosedTurnDirection turnDirection,
                              HoldingPatternProfile profile)

Create a new instance based on the given parameters.

Parameters:

surfaceShape - The reference surface over which to define the procedure.

centerOfTurnOne - The center of the first circular turn.

centerOfTurnTwo - The center of the second circular turn.

turningRadius - The turning radius used for all the turns, in meters.

minimumTime - The minimum time to spend in the racetrack hold before leaving.

turnDirection - The turn direction to use for the racetrack turns.

profile - The profile defining the vertical and time dynamic geometry for the procedure.

RacetrackHoldProcedure

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

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

Overrides:

computeCurrentDefinitionHashCode in class RouteProcedure

Returns:

The computed hash code.

getMinimumRevolutions

public final double getMinimumRevolutions()

Gets the minimum number of complete revolutions around the racetrack to make prior to leaving. The number of revolutions may be more if the MinimumTime (get / set) condition is not met.

setMinimumRevolutions

public final void setMinimumRevolutions(double value)

Sets the minimum number of complete revolutions around the racetrack to make prior to leaving. The number of revolutions may be more if the MinimumTime (get / set) condition is not met.

getMinimumTime

@Nonnull
public final Duration getMinimumTime()

Gets the minimum time to spend in the hold before leaving. The time spent in the hold may be more if the number of MinimumRevolutions (get / set) is not met.

setMinimumTime

public final void setMinimumTime(@Nonnull
                                 Duration value)

Sets the minimum time to spend in the hold before leaving. The time spent in the hold may be more if the number of MinimumRevolutions (get / set) is not met.

getSurfaceShape

public final Ellipsoid getSurfaceShape()

Gets the reference surface over which to define the geometry.

setSurfaceShape

public final void setSurfaceShape(Ellipsoid value)

Sets the reference surface over which to define the geometry.

getCenterOfTurnOne

@Nonnull
public final Cartographic getCenterOfTurnOne()

Gets the center of the first racetrack turn.

setCenterOfTurnOne

public final void setCenterOfTurnOne(@Nonnull
                                     Cartographic value)

Sets the center of the first racetrack turn.

getCenterOfTurnTwo

@Nonnull
public final Cartographic getCenterOfTurnTwo()

Gets the center of the second racetrack turn.

setCenterOfTurnTwo

public final void setCenterOfTurnTwo(@Nonnull
                                     Cartographic value)

Sets the center of the second racetrack turn.

getTurnDirection

@Nonnull
public final ClosedTurnDirection getTurnDirection()

Gets the direction in which the racetrack turns.

setTurnDirection

public final void setTurnDirection(@Nonnull
                                   ClosedTurnDirection value)

Sets the direction in which the racetrack turns.

getTurningRadiusForHold

public final double getTurningRadiusForHold()

Gets the radius of the circular arcs at either end of the racetrack, in meters.

setTurningRadiusForHold

public final void setTurningRadiusForHold(double value)

Sets the radius of the circular arcs at either end of the racetrack, in meters.

getTurningRadiusForEntryAndExit

public final double getTurningRadiusForEntryAndExit()

Gets the turning radius used to enter and exit the racetrack, in meters.

setTurningRadiusForEntryAndExit

public final void setTurningRadiusForEntryAndExit(double value)

Sets the turning radius used to enter and exit the racetrack, in meters.

getConstrainEntryAndExitToTrackArcs

public final boolean getConstrainEntryAndExitToTrackArcs()

Gets a value indicating whether to ignore the additional entry and exit turns, restricting the entry and exit to be tangent to the two turns in the racetrack. By default, this is set to false.

setConstrainEntryAndExitToTrackArcs

public final void setConstrainEntryAndExitToTrackArcs(boolean value)

Sets a value indicating whether to ignore the additional entry and exit turns, restricting the entry and exit to be tangent to the two turns in the racetrack. By default, this is set to false.

getProfile

public final HoldingPatternProfile getProfile()

Gets the profile to use for this racetrack hold. See ConstantHeightProfile.

setProfile

public final void setProfile(HoldingPatternProfile value)

Sets the profile to use for this racetrack hold. See ConstantHeightProfile.

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.

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.