agi.foundation.routedesign

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

Class StationaryHoldProcedure

java.lang.Object

agi.foundation.infrastructure.DefinitionalObject

agi.foundation.routedesign.RouteSegment

agi.foundation.routedesign.RouteProcedure

agi.foundation.routedesign.StationaryHoldProcedure

All Implemented Interfaces:

ICloneWithContext, IEnumerateDependencies, IEquatableDefinition, IFreezable

public class StationaryHoldProcedure
extends RouteProcedure

A procedure that represents a point along the route where a vehicle slows to a stop, waits at the specified location for a specified amount of time, and then speeds up to continue toward the next procedure. Note that this will represent a discontinuity in the geometry of the route and may cause difficulties for other types which require a smooth path and a non-zero velocity vector. Examples include Axes types which use velocity information to orient the vehicle but do not have additional logic to handle stationary objects.

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

Modifier	Constructor and Description
	StationaryHoldProcedure() Create a new instance.
	StationaryHoldProcedure(Cartographic waypoint, Duration holdTime) Create a new instance based on the given parameters over the surface of the Earth (get).
	StationaryHoldProcedure(double waypointLongitude, double waypointLatitude, Duration holdTime, double heightAboveSurface, RouteHeightReference heightReference) Create a new instance based on the given parameters over the surface of the Earth (get).
	StationaryHoldProcedure(double waypointLongitude, double waypointLatitude, Duration holdTime, double heightAboveSurface, TerrainProvider terrainSurface) Create a new instance based on the given parameters over the surface of the Earth (get).
protected	StationaryHoldProcedure(StationaryHoldProcedure 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(RouteProcedure other) Checks to determine if another instance has the same definition as this instance and returns true if it does.
protected boolean	checkForSameDefinition(StationaryHoldProcedure 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.
Duration	getHoldTime() Gets the duration of time to wait at the waypoint.
TerrainProvider	getReferenceSurface() Gets the reference surface above which the height of the profile is defined.
ConfigurableSurfaceProcedure	getSurfacePath() Get an object that will allow configuration of the surface geometry as it connects with other procedures.
Cartographic	getWaypoint() Gets the waypoint location at which to wait.
void	setHoldTime(Duration value) Sets the duration of time to wait at the waypoint.
void	setReferenceSurface(TerrainProvider value) Sets the reference surface above which the height of the profile is defined.
void	setWaypoint(Cartographic value) Sets the waypoint location at which to wait.

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

StationaryHoldProcedure

public StationaryHoldProcedure()

Create a new instance.

StationaryHoldProcedure

public StationaryHoldProcedure(@Nonnull
                               Cartographic waypoint,
                               @Nonnull
                               Duration holdTime)

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

Parameters:

waypoint - The waypoint at which to wait.

holdTime - The duration of time to wait.

StationaryHoldProcedure

public StationaryHoldProcedure(double waypointLongitude,
                               double waypointLatitude,
                               @Nonnull
                               Duration holdTime,
                               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.

holdTime - The duration of time to wait.

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.

StationaryHoldProcedure

public StationaryHoldProcedure(double waypointLongitude,
                               double waypointLatitude,
                               @Nonnull
                               Duration holdTime,
                               double heightAboveSurface,
                               TerrainProvider terrainSurface)

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.

holdTime - The duration of time to wait.

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

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

StationaryHoldProcedure

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

Overrides:

computeCurrentDefinitionHashCode in class RouteProcedure

Returns:

The computed hash code.

getHoldTime

@Nonnull
public final Duration getHoldTime()

Gets the duration of time to wait at the waypoint.

setHoldTime

public final void setHoldTime(@Nonnull
                              Duration value)

Sets the duration of time to wait at the waypoint.

getReferenceSurface

public final TerrainProvider getReferenceSurface()

Gets the reference surface above which the height of the profile is defined.

setReferenceSurface

public final void setReferenceSurface(TerrainProvider value)

Sets the reference surface above which the height of the profile is defined.

getWaypoint

@Nonnull
public final Cartographic getWaypoint()

Gets the waypoint location at which to wait. The height of the waypoint represents the height above the ReferenceSurface (get / set).

setWaypoint

public final void setWaypoint(@Nonnull
                              Cartographic value)

Sets the waypoint location at which to wait. The height of the waypoint represents the height above the ReferenceSurface (get / set).

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.