agi.foundation.routedesign

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

Class CircularHoldProcedure

java.lang.Object

agi.foundation.infrastructure.DefinitionalObject

agi.foundation.routedesign.RouteSegment

agi.foundation.routedesign.RouteProcedure

agi.foundation.routedesign.CircularHoldProcedure

All Implemented Interfaces:

ICloneWithContext, IEnumerateDependencies, IEquatableDefinition, IFreezable

public class CircularHoldProcedure
extends RouteProcedure

A procedure that places the position into a circular path around a given center point at a given turn radius in a given direction. The procedure indicates the minimum number of revolutions or the minimum time that the position should spend in the hold before leaving. The position will enter and leave the hold on tangents to the circular path.

This procedure is illustrated by the following image:

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CircularHoldProcedure.ConfigurationData An enumeration indicating whether the configuration of the hold was successful or whether there was an error.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CircularHoldProcedure() Create a new instance.
	CircularHoldProcedure(Cartographic center, double turningRadius, double minimumRevolutions, ClosedTurnDirection turnDirection, double speed, double height, RouteHeightReference heightReference) Create a new instance based on the given parameters.
protected	CircularHoldProcedure(CircularHoldProcedure existingInstance, CopyContext context) Initializes a new instance as a copy of an existing instance.
	CircularHoldProcedure(Ellipsoid shape, Cartographic center, double turningRadius, double minimumRevolutions, ClosedTurnDirection turnDirection, HoldingPatternProfile profile) Create a new instance based on the given parameters.
	CircularHoldProcedure(Ellipsoid shape, Cartographic center, double turningRadius, Duration minimumTime, ClosedTurnDirection turnDirection, HoldingPatternProfile profile) Create a new instance based on the given parameters.

Method Summary

Modifier and Type	Method and Description
protected boolean	checkForSameDefinition(CircularHoldProcedure 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	getCenter() Gets the location for the center of the circular hold.
double	getMinimumRevolutions() Gets the minimum number of revolutions to perform before leaving the hold.
Duration	getMinimumTime() Gets the minimum time to spend in the hold before leaving.
HoldingPatternProfile	getProfile() Gets the profile to use with this circular hold.
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 the surface path is defined.
ClosedTurnDirection	getTurnDirection() Gets the direction (right or left) of the turn.
double	getTurningRadius() Gets the surface distance from the center of the hold to the circular path.
void	setCenter(Cartographic value) Sets the location for the center of the circular hold.
void	setMinimumRevolutions(double value) Sets the minimum number of revolutions to perform before leaving the hold.
void	setMinimumTime(Duration value) Sets the minimum time to spend in the hold before leaving.
void	setProfile(HoldingPatternProfile value) Sets the profile to use with this circular hold.
void	setSurfaceShape(Ellipsoid value) Sets the shape of the reference surface over which the surface path is defined.
void	setTurnDirection(ClosedTurnDirection value) Sets the direction (right or left) of the turn.
void	setTurningRadius(double value) Sets the surface distance from the center of the hold to the circular path.

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

CircularHoldProcedure

public CircularHoldProcedure()

Create a new instance.

CircularHoldProcedure

public CircularHoldProcedure(@Nonnull
                             Cartographic center,
                             double turningRadius,
                             double minimumRevolutions,
                             @Nonnull
                             ClosedTurnDirection turnDirection,
                             double speed,
                             double height,
                             @Nonnull
                             RouteHeightReference heightReference)

Create a new instance based on the given parameters. The Profile (get / set) property must be set before propagation.

Parameters:

center - The center of the hold.

turningRadius - The radius from the center of the hold to the circular path.

minimumRevolutions - The minimum number of revolutions to spend in the hold before leaving.

turnDirection - An enumeration indicating whether to turn left or turn right.

speed - The speed of the platform during the hold, in meters per second.

height - The height above the reference surface, in meters.

heightReference - The reference surface used to define the height.

CircularHoldProcedure

public CircularHoldProcedure(Ellipsoid shape,
                             @Nonnull
                             Cartographic center,
                             double turningRadius,
                             double minimumRevolutions,
                             @Nonnull
                             ClosedTurnDirection turnDirection,
                             HoldingPatternProfile profile)

Create a new instance based on the given parameters.

Parameters:

shape - The shape of the reference surface over which the surface path is defined.

center - The center of the hold.

turningRadius - The radius from the center of the hold to the circular path.

minimumRevolutions - The minimum number of revolutions to spend in the hold before leaving.

turnDirection - An enumeration indicating whether to turn left or turn right.

profile - The profile defining the height and speed profiles over the course of the hold.

CircularHoldProcedure

public CircularHoldProcedure(Ellipsoid shape,
                             @Nonnull
                             Cartographic center,
                             double turningRadius,
                             @Nonnull
                             Duration minimumTime,
                             @Nonnull
                             ClosedTurnDirection turnDirection,
                             HoldingPatternProfile profile)

Create a new instance based on the given parameters.

Parameters:

shape - The shape of the reference surface over which the surface path is defined.

center - The center of the hold.

turningRadius - The radius from the center of the hold to the circular path.

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

turnDirection - An enumeration indicating whether to turn left or turn right.

profile - The profile defining the height and speed profiles over the course of the hold.

CircularHoldProcedure

protected CircularHoldProcedure(@Nonnull
                                CircularHoldProcedure 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(CircularHoldProcedure 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 CircularHoldProcedure.checkForSameDefinition(agi.foundation.routedesign.RouteProcedure) method.

Overrides:

computeCurrentDefinitionHashCode in class RouteProcedure

Returns:

The computed hash code.

getSurfaceShape

public final Ellipsoid getSurfaceShape()

Gets the shape of the reference surface over which the surface path is defined.

setSurfaceShape

public final void setSurfaceShape(Ellipsoid value)

Sets the shape of the reference surface over which the surface path is defined.

getTurningRadius

public final double getTurningRadius()

Gets the surface distance from the center of the hold to the circular path.

setTurningRadius

public final void setTurningRadius(double value)

Sets the surface distance from the center of the hold to the circular path.

getTurnDirection

@Nonnull
public final ClosedTurnDirection getTurnDirection()

Gets the direction (right or left) of the turn.

setTurnDirection

public final void setTurnDirection(@Nonnull
                                   ClosedTurnDirection value)

Sets the direction (right or left) of the turn.

getMinimumRevolutions

public final double getMinimumRevolutions()

Gets the minimum number of revolutions to perform before leaving the hold. The actual number of revolutions will depend on connection geometry and whether MinimumTime (get / set) requires further revolutions.

setMinimumRevolutions

public final void setMinimumRevolutions(double value)

Sets the minimum number of revolutions to perform before leaving the hold. The actual number of revolutions will depend on connection geometry and whether MinimumTime (get / set) requires further revolutions.

getMinimumTime

@Nonnull
public final Duration getMinimumTime()

Gets the minimum time to spend in the hold before leaving. The actual time spent in the hold will depend on connection geometry and whether further revolutions are required to satisfy the MinimumRevolutions (get / set) property.

setMinimumTime

public final void setMinimumTime(@Nonnull
                                 Duration value)

Sets the minimum time to spend in the hold before leaving. The actual time spent in the hold will depend on connection geometry and whether further revolutions are required to satisfy the MinimumRevolutions (get / set) property.

getCenter

@Nonnull
public final Cartographic getCenter()

Gets the location for the center of the circular hold.

setCenter

public final void setCenter(@Nonnull
                            Cartographic value)

Sets the location for the center of the circular hold.

getProfile

public final HoldingPatternProfile getProfile()

Gets the profile to use with this circular hold. See ConstantHeightProfile.

setProfile

public final void setProfile(HoldingPatternProfile value)

Sets the profile to use with this circular 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.