agi.foundation.routedesign

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

Class TakeoffProcedure

java.lang.Object

agi.foundation.infrastructure.DefinitionalObject

agi.foundation.routedesign.RouteSegment

agi.foundation.routedesign.RouteProcedure

agi.foundation.routedesign.TakeoffProcedure

All Implemented Interfaces:

ICloneWithContext, IEnumerateDependencies, IEquatableDefinition, IFreezable

public class TakeoffProcedure
extends RouteProcedure

Represents a takeoff trajectory with respect to a runway surface specified by the underlying terrain. If there is a taxi prior to the runway, the platform will turn onto the runway's heading. Then, the platform rolls a given distance before taking off to reach the target height. Lastly, the platform will execute a level turn toward the next procedure.

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

Modifier	Constructor and Description
	TakeoffProcedure() Create a new instance with default values.
	TakeoffProcedure(Cartographic runwayStartPosition, double runwayHeading, double rollDistance, double climbAngle, double pitchUpAcceleration, double pitchDownAcceleration, double startHeightAboveRunway, double stopHeightAboveRunway, double startSpeed, double takeoffSpeed, double turningRadiusToNext) Create a takeoff procedure based on the given parameters with respect to the surface of the Earth (get).
	TakeoffProcedure(Cartographic runwayStartPosition, double runwayHeading, double rollDistance, ProfileDynamics takeoffDynamics, double startHeightAboveRunway, double stopHeightAboveRunway, double startSpeed, double takeoffSpeed, double turningRadius) Create a takeoff procedure based on the given parameters with respect to the surface of the Earth (get).
protected	TakeoffProcedure(TakeoffProcedure existingInstance, CopyContext context) Initializes a new instance as a copy of an existing instance.
	TakeoffProcedure(TerrainProvider runwayTerrainProvider, double runwayStartLongitude, double runwayStartLatitude, double initialHeightAboveRunway, double finalHeightAboveRunway, double runwayHeading, double rollDistance, double climbAngle, double pitchUpAcceleration, double pitchDownAcceleration, double startSpeed, double takeoffSpeed, double turningRadius) Create a takeoff procedure based on the given parameters with respect to a terrain surface.

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(TakeoffProcedure 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.
double	getClimbAngle() Gets the angle at which to climb during takeoff, in radians.
ProfileDynamics	getDynamics() Gets the parameters to use to define the acceleration and pitch rates during takeoff.
double	getFinalHeightAboveRunway() Gets the final height above the runway at which to level off, in meters.
double	getInitialHeightAboveRunway() Gets the initial height offset above the runway, in meters.
double	getInitialSpeed() Gets the speed at which the platform is moving at the start of the runway, in meters per second.
double	getRollDistance() Gets the distance required to go from the initial speed to the takeoff speed, in meters.
double	getRunwayHeading() Gets the heading of the runway with respect to north, in radians.
TerrainProvider	getRunwayReferenceSurface() Gets the terrain reference surface for the runway.
Cartographic	getRunwayStartPosition() Gets the position of the start of the runway.
ConfigurableSurfaceProcedure	getSurfacePath() Get an object that will allow configuration of the surface geometry as it connects with other procedures.
double	getTakeoffSpeed() Gets the speed after the specified RollDistance (get / set) at which the platform begins to takeoff, in meters per second.
double	getTurningRadiusAfterTakeoff() Gets the horizontal turning radius at which to turn when approaching the glide plane for landing, in meters.
double	getTurningRadiusBeforeTakeoff() Gets the final turning radius at which to turn toward the next procedure after landing, in meters.
void	setClimbAngle(double value) Sets the angle at which to climb during takeoff, in radians.
void	setDynamics(ProfileDynamics value) Sets the parameters to use to define the acceleration and pitch rates during takeoff.
void	setFinalHeightAboveRunway(double value) Sets the final height above the runway at which to level off, in meters.
void	setInitialHeightAboveRunway(double value) Sets the initial height offset above the runway, in meters.
void	setInitialSpeed(double value) Sets the speed at which the platform is moving at the start of the runway, in meters per second.
void	setRollDistance(double value) Sets the distance required to go from the initial speed to the takeoff speed, in meters.
void	setRunwayHeading(double value) Sets the heading of the runway with respect to north, in radians.
void	setRunwayReferenceSurface(TerrainProvider value) Sets the terrain reference surface for the runway.
void	setRunwayStartPosition(Cartographic value) Sets the position of the start of the runway.
void	setTakeoffSpeed(double value) Sets the speed after the specified RollDistance (get / set) at which the platform begins to takeoff, in meters per second.
void	setTurningRadiusAfterTakeoff(double value) Sets the horizontal turning radius at which to turn when approaching the glide plane for landing, in meters.
void	setTurningRadiusBeforeTakeoff(double value) Sets the final turning radius at which to turn toward the next procedure after landing, 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

TakeoffProcedure

public TakeoffProcedure()

Create a new instance with default values. The position of the runway must be set prior to propagation.

The default values are:

Property	Default Value
RunwayReferenceSurface (get / set)	Earth's ellipsoid reference surface
InitialHeightAboveRunway (get / set)	0.0
FinalHeightAboveRunway (get / set)	15.0 meters
RunwayHeading (get / set)	0.0 (north)
RollDistance (get / set)	1000 meters
ClimbAngle (get / set)	π/12 (15 degrees)
PitchUpAcceleration (get / set)	Constants.EarthSurfaceGravity
PushOverAcceleration (get / set)	Constants.EarthSurfaceGravity
InitialSpeed (get / set)	0.0
TakeoffSpeed (get / set)	25.0 meters per second
TurningRadiusAfterTakeoff (get / set)	100 meters

TakeoffProcedure

public TakeoffProcedure(TerrainProvider runwayTerrainProvider,
                        double runwayStartLongitude,
                        double runwayStartLatitude,
                        double initialHeightAboveRunway,
                        double finalHeightAboveRunway,
                        double runwayHeading,
                        double rollDistance,
                        double climbAngle,
                        double pitchUpAcceleration,
                        double pitchDownAcceleration,
                        double startSpeed,
                        double takeoffSpeed,
                        double turningRadius)

Create a takeoff procedure based on the given parameters with respect to a terrain surface.

Parameters:

runwayTerrainProvider - The terrain reference surface for the runway.

runwayStartLongitude - The longitude at the start of the runway, in radians.

runwayStartLatitude - The geodetic latitude at the start of the runway, in radians.

initialHeightAboveRunway - The initial offset above the terrain at the start of the runway, in meters.

finalHeightAboveRunway - The final height with respect to the terrain at which to level off after takeoff, in meters.

runwayHeading - The heading of the runway with respect to north, in radians.

rollDistance - The distance along the runway that the platform needs to reach the takeoffSpeed, in meters.

climbAngle - The angle at which to climb during takeoff, in radians.

pitchUpAcceleration - The acceleration at which to pitch up when taking off, in meters/sec/sec.

pitchDownAcceleration - The acceleration at which to pitch down after reaching the desired height, in meters/sec/sec.

startSpeed - The speed at which the platform is moving at the start of the runway, in meters per second.

takeoffSpeed - The speed achieved at the end of the rollDistance to use during the climb, in meters per second.

turningRadius - The horizontal turning radius to use after leveling off to turn to the next procedure, in meters.

TakeoffProcedure

public TakeoffProcedure(@Nonnull
                        Cartographic runwayStartPosition,
                        double runwayHeading,
                        double rollDistance,
                        ProfileDynamics takeoffDynamics,
                        double startHeightAboveRunway,
                        double stopHeightAboveRunway,
                        double startSpeed,
                        double takeoffSpeed,
                        double turningRadius)

Create a takeoff procedure based on the given parameters with respect to the surface of the Earth (get). If MeanSeaLevel (get / set) is available on the definition of Earth in the CalculationContext, the specified heights will be with respect to sea level.

Parameters:

runwayStartPosition - The start position of the runway, including the height of the runway above the terrain surface.

runwayHeading - The heading of the runway with respect to north, in radians.

rollDistance - The distance along the runway that the platform needs to reach the final speed, in meters.

takeoffDynamics - The platform dynamics specifying the push over and pitch up accelerations as well as the climb angle based on the vertical ascent and horizontal takeoff speed.

startHeightAboveRunway - The height above the runway at which to takeoff, in meters.

stopHeightAboveRunway - The height above the runway at which to level off, in meters.

startSpeed - The initial speed at which the platform moves along the runway before accelerating to the takeoffSpeed, in meters per second.

takeoffSpeed - The speed at the end of the rollDistance at which the platform takes off, in meters per second.

turningRadius - The horizontal radius at which to turn toward the next procedure, in meters.

TakeoffProcedure

public TakeoffProcedure(@Nonnull
                        Cartographic runwayStartPosition,
                        double runwayHeading,
                        double rollDistance,
                        double climbAngle,
                        double pitchUpAcceleration,
                        double pitchDownAcceleration,
                        double startHeightAboveRunway,
                        double stopHeightAboveRunway,
                        double startSpeed,
                        double takeoffSpeed,
                        double turningRadiusToNext)

Create a takeoff procedure based on the given parameters with respect to the surface of the Earth (get). If MeanSeaLevel (get / set) is available on the definition of Earth in the CalculationContext, the specified heights will be with respect to sea level.

Parameters:

runwayStartPosition - The start position of the runway, including the height of the runway above the terrain surface.

runwayHeading - The heading of the runway with respect to north, in radians.

rollDistance - The distance along the runway that the platform needs to reach the final speed, in meters.

climbAngle - The angle at which to climb, in radians.

pitchUpAcceleration - The acceleration to use when pitching up during takeoff, in meters/sec/sec.

pitchDownAcceleration - The acceleration to use when pitching down to level off, in meters/sec/sec.

startHeightAboveRunway - The initial height above the surface of the runway at which to take off, in meters.

stopHeightAboveRunway - The final height above the surface of the runway at which to level off, in meters.

startSpeed - The initial speed at which the platform moves along the runway before accelerating to the takeoffSpeed, in meters per second.

takeoffSpeed - The speed at the end of the rollDistance at which the platform takes off, in meters per second.

turningRadiusToNext - The horizontal radius at which to turn toward the next procedure, in meters.

TakeoffProcedure

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

Overrides:

computeCurrentDefinitionHashCode in class RouteProcedure

Returns:

The computed hash code.

getRunwayReferenceSurface

public final TerrainProvider getRunwayReferenceSurface()

Gets the terrain reference surface for the runway. The runway is positioned at a constant offset from the terrain according to the height of the RunwayStartPosition (get / set), and the height of the platform is positioned above that runway height by an offset defined by InitialHeightAboveRunway (get / set).

setRunwayReferenceSurface

public final void setRunwayReferenceSurface(TerrainProvider value)

Sets the terrain reference surface for the runway. The runway is positioned at a constant offset from the terrain according to the height of the RunwayStartPosition (get / set), and the height of the platform is positioned above that runway height by an offset defined by InitialHeightAboveRunway (get / set).

getRunwayStartPosition

@Nonnull
public final Cartographic getRunwayStartPosition()

Gets the position of the start of the runway. The Height (get) of the position represents an additional offset for the runway above the terrain surface, in meters.

setRunwayStartPosition

public final void setRunwayStartPosition(@Nonnull
                                         Cartographic value)

Sets the position of the start of the runway. The Height (get) of the position represents an additional offset for the runway above the terrain surface, in meters.

getRunwayHeading

public final double getRunwayHeading()

Gets the heading of the runway with respect to north, in radians.

setRunwayHeading

public final void setRunwayHeading(double value)

Sets the heading of the runway with respect to north, in radians.

getClimbAngle

public final double getClimbAngle()

Gets the angle at which to climb during takeoff, in radians. This will override the AscentSpeed (get / set).

setClimbAngle

public final void setClimbAngle(double value)

Sets the angle at which to climb during takeoff, in radians. This will override the AscentSpeed (get / set).

getRollDistance

public final double getRollDistance()

Gets the distance required to go from the initial speed to the takeoff speed, in meters.

setRollDistance

public final void setRollDistance(double value)

Sets the distance required to go from the initial speed to the takeoff speed, in meters.

getInitialHeightAboveRunway

public final double getInitialHeightAboveRunway()

Gets the initial height offset above the runway, in meters. The runway height is specified by the height of the RunwayStartPosition (get / set) above the RunwayReferenceSurface (get / set) (at the initial position).

setInitialHeightAboveRunway

public final void setInitialHeightAboveRunway(double value)

Sets the initial height offset above the runway, in meters. The runway height is specified by the height of the RunwayStartPosition (get / set) above the RunwayReferenceSurface (get / set) (at the initial position).

getFinalHeightAboveRunway

public final double getFinalHeightAboveRunway()

Gets the final height above the runway at which to level off, in meters. The runway height is specified by the height of the RunwayStartPosition (get / set) above the RunwayReferenceSurface (get / set) (at the takeoff position).

setFinalHeightAboveRunway

public final void setFinalHeightAboveRunway(double value)

Sets the final height above the runway at which to level off, in meters. The runway height is specified by the height of the RunwayStartPosition (get / set) above the RunwayReferenceSurface (get / set) (at the takeoff position).

getInitialSpeed

public final double getInitialSpeed()

Gets the speed at which the platform is moving at the start of the runway, in meters per second.

setInitialSpeed

public final void setInitialSpeed(double value)

Sets the speed at which the platform is moving at the start of the runway, in meters per second.

getTakeoffSpeed

public final double getTakeoffSpeed()

Gets the speed after the specified RollDistance (get / set) at which the platform begins to takeoff, in meters per second.

setTakeoffSpeed

public final void setTakeoffSpeed(double value)

Sets the speed after the specified RollDistance (get / set) at which the platform begins to takeoff, in meters per second.

getTurningRadiusAfterTakeoff

public final double getTurningRadiusAfterTakeoff()

Gets the horizontal turning radius at which to turn when approaching the glide plane for landing, in meters.

setTurningRadiusAfterTakeoff

public final void setTurningRadiusAfterTakeoff(double value)

Sets the horizontal turning radius at which to turn when approaching the glide plane for landing, in meters.

getTurningRadiusBeforeTakeoff

public final double getTurningRadiusBeforeTakeoff()

Gets the final turning radius at which to turn toward the next procedure after landing, in meters. By default, this is one meter.

setTurningRadiusBeforeTakeoff

public final void setTurningRadiusBeforeTakeoff(double value)

Sets the final turning radius at which to turn toward the next procedure after landing, in meters. By default, this is one meter.

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.

getDynamics

public final ProfileDynamics getDynamics()

Gets the parameters to use to define the acceleration and pitch rates during takeoff.

setDynamics

public final void setDynamics(ProfileDynamics value)

Sets the parameters to use to define the acceleration and pitch rates during takeoff.