LandingProcedure

java.lang.Object
- agi.foundation.infrastructure.DefinitionalObject
- - agi.foundation.routedesign.RouteSegment
  - - agi.foundation.routedesign.RouteProcedure
    - - agi.foundation.routedesign.LandingProcedure

All Implemented Interfaces:

ICloneWithContext, IEnumerateDependencies, IEquatableDefinition, IFreezable
```
public class LandingProcedure
extends RouteProcedure
```
Represents a landing trajectory with respect to a runway surface specified by the underlying terrain. The platform will execute a level turn on the approach toward the runway before descending along the glide slope. The platform then rolls to a stop over a given distance. Lastly, if there are any taxi procedures after the landing, the platform will turn toward the next procedure.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class LandingProcedure.ConfigurationData
An enumeration indicating the status of configuring the surface procedure.

Nested Classes
Modifier and Type	Class and Description
`static class`	`LandingProcedure.ConfigurationData` An enumeration indicating the status of configuring the surface procedure.

Constructor Summary

Constructors
Modifier	Constructor and Description
	`LandingProcedure()` Create a new instance.
	`LandingProcedure(Cartographic runwayStartPosition, double runwayHeading, double rollDistance, double startHeight, double stopHeight, double glideSlopeAngle, ProfileDynamics profileDynamics, double speedOnApproach, double finalSpeed, double turningRadiusOnApproach)` Create a landing procedure based on the given parameters with respect to the surface of the `Earth` (`get`).
	`LandingProcedure(Cartographic runwayStartPosition, double runwayHeading, double rollDistance, ProfileDynamics profileDynamics, double initialHeightAboveRunway, double finalHeightAboveRunway, double speedOnApproach, double finalSpeed, double turningRadius)` Create a landing procedure based on the given parameters with respect to the surface of the `Earth` (`get`).
`protected`	`LandingProcedure(LandingProcedure existingInstance, CopyContext context)` Initializes a new instance as a copy of an existing instance.
	`LandingProcedure(TerrainProvider terrainReference, Cartographic runwayStartPosition, double runwayHeading, double rollDistance, double startHeight, double stopHeight, double glideSlopeAngle, ProfileDynamics profileDynamics, double speedOnApproach, double finalSpeed, double turningRadiusOnApproach)` Create a landing procedure based on the given parameters with respect to a terrain surface.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected boolean`	`checkForSameDefinition(LandingProcedure 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.
`double`	`getDescentAngle()` Gets the angle of the glide slope for the landing, in radians.
`ProfileDynamics`	`getDynamics()` Gets the platform dynamics that define the pitch up and push over accelerations to use for the landing descent.
`double`	`getFinalHeightAboveRunway()` Gets the final constant offset above the runway, in meters.
`double`	`getFinalSpeed()` Gets the final target speed at which the platform travels after rolling to a stop at the end of the landing, in meters per second.
`double`	`getInitialHeightAboveRunway()` Gets the height above the runway at which the platform approaches the landing, in meters.
`double`	`getRollDistance()` Gets the distance along the runway it takes to go from the landing speed to the final speed, in meters.
`double`	`getRunwayHeading()` Gets the heading of the runway with respect to north, in radians.
`TerrainProvider`	`getRunwayReferenceSurface()` Gets the terrain reference surface to use to define the heights and the surface of the runway.
`Cartographic`	`getRunwayStartPosition()` Gets the geodetic starting point of the runway.
`double`	`getSpeedOnApproach()` Gets the target speed at which to approach the landing maneuver, in meters per second.
`ConfigurableSurfaceProcedure`	`getSurfacePath()` Get an object that will allow configuration of the surface geometry as it connects with other procedures.
`double`	`getTurningRadiusAfterLanding()` Gets the final turning radius at which to turn toward the next procedure after landing, in meters.
`double`	`getTurningRadiusOnApproach()` Gets the horizontal turning radius at which to turn when approaching the glide plane for landing, in meters.
`void`	`setDescentAngle(double value)` Sets the angle of the glide slope for the landing, in radians.
`void`	`setDynamics(ProfileDynamics value)` Sets the platform dynamics that define the pitch up and push over accelerations to use for the landing descent.
`void`	`setFinalHeightAboveRunway(double value)` Sets the final constant offset above the runway, in meters.
`void`	`setFinalSpeed(double value)` Sets the final target speed at which the platform travels after rolling to a stop at the end of the landing, in meters per second.
`void`	`setInitialHeightAboveRunway(double value)` Sets the height above the runway at which the platform approaches the landing, in meters.
`void`	`setRollDistance(double value)` Sets the distance along the runway it takes to go from the landing speed to the final 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 to use to define the heights and the surface of the runway.
`void`	`setRunwayStartPosition(Cartographic value)` Sets the geodetic starting point of the runway.
`void`	`setSpeedOnApproach(double value)` Sets the target speed at which to approach the landing maneuver, in meters per second.
`void`	`setTurningRadiusAfterLanding(double value)` Sets the final turning radius at which to turn toward the next procedure after landing, in meters.
`void`	`setTurningRadiusOnApproach(double value)` Sets the horizontal turning radius at which to turn when approaching the glide plane for 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 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - LandingProcedure
```
public LandingProcedure()
```
    Create a new instance.
  - LandingProcedure
```
public LandingProcedure(TerrainProvider terrainReference,
                        @Nonnull
                        Cartographic runwayStartPosition,
                        double runwayHeading,
                        double rollDistance,
                        double startHeight,
                        double stopHeight,
                        double glideSlopeAngle,
                        ProfileDynamics profileDynamics,
                        double speedOnApproach,
                        double finalSpeed,
                        double turningRadiusOnApproach)
```
    Create a landing procedure based on the given parameters with respect to a terrain surface.
    
    Parameters:
    
    terrainReference - The terrain reference surface for the runway.
    
    runwayStartPosition - The start position of the runway, including the height offset of the runway above the terrain reference 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.
    
    startHeight - The height above the runway at which the platform approaches the landing, in meters. This represents the height of the center of mass (or center of a 3D model) with respect to the terrain and runway offset specified by the height of the runwayStartPosition.
    
    stopHeight - The final constant offset above the runway, in meters. This represents the height of the center of mass (or center of a 3D model) with respect to the terrain and runway offset specified by the height of the runwayStartPosition.
    
    glideSlopeAngle - The angle at which to glide during descent, in radians. (This will override the descent behavior in the profileDynamics).
    
    profileDynamics - The platform dynamics specifying the push over and pitch up accelerations.
    
    speedOnApproach - The speed at which the platform arrives when approaching the landing, in meters per second.
    
    finalSpeed - The final speed of the platform after rolling to a stop on the runway, in meters per second.
    
    turningRadiusOnApproach - The horizontal turning radius to use when approaching the glide plane for landing, in meters.
  - LandingProcedure
```
public LandingProcedure(@Nonnull
                        Cartographic runwayStartPosition,
                        double runwayHeading,
                        double rollDistance,
                        double startHeight,
                        double stopHeight,
                        double glideSlopeAngle,
                        ProfileDynamics profileDynamics,
                        double speedOnApproach,
                        double finalSpeed,
                        double turningRadiusOnApproach)
```
    Create a landing 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.
    
    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.
    
    startHeight - The height above the runway at which the platform approaches the landing, in meters. This represents the height of the center of mass (or center of a 3D model) with respect to the terrain and runway offset specified by the height of the runwayStartPosition.
    
    stopHeight - The final constant offset above the runway, in meters. This represents the height of the center of mass (or center of a 3D model) with respect to the terrain and runway offset specified by the height of the runwayStartPosition.
    
    glideSlopeAngle - The angle at which to glide during descent, in radians. (This will override the descent behavior in the profileDynamics).
    
    profileDynamics - The platform dynamics specifying the push over and pitch up accelerations.
    
    speedOnApproach - The speed at which the platform arrives when approaching the landing, in meters per second.
    
    finalSpeed - The final speed of the platform after rolling to a stop on the runway, in meters per second.
    
    turningRadiusOnApproach - The horizontal turning radius to use when approaching the glide plane for landing, in meters.
  - LandingProcedure
```
public LandingProcedure(@Nonnull
                        Cartographic runwayStartPosition,
                        double runwayHeading,
                        double rollDistance,
                        ProfileDynamics profileDynamics,
                        double initialHeightAboveRunway,
                        double finalHeightAboveRunway,
                        double speedOnApproach,
                        double finalSpeed,
                        double turningRadius)
```
    Create a landing 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 above the runway at which to end, 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 final speed, in meters.
    
    profileDynamics - The platform dynamics specifying the push over and pitch up accelerations as well as the glide angle based on the vertical ascent and horizontal approach speed.
    
    initialHeightAboveRunway - The height above the runway at which the platform approaches the landing, in meters. This represents the height of the center of mass (or center of a 3D model) with respect to the terrain and runway offset specified by the height of the runwayStartPosition.
    
    finalHeightAboveRunway - The final constant offset above the runway, in meters. This represents the height of the center of mass (or center of a 3D model) with respect to the terrain and runway offset specified by the height of the runwayStartPosition.
    
    speedOnApproach - The initial speed of the platform as it approaches to land, in meters per second.
    
    finalSpeed - 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.
  - LandingProcedure
```
protected LandingProcedure(@Nonnull
                           LandingProcedure 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(LandingProcedure 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 LandingProcedure.checkForSameDefinition(agi.foundation.routedesign.RouteProcedure) method.
    
    Overrides:
    
    computeCurrentDefinitionHashCode in class RouteProcedure
    
    Returns:
    
    The computed hash code.
  - getDynamics
```
public final ProfileDynamics getDynamics()
```
    Gets the platform dynamics that define the pitch up and push over accelerations to use for the landing descent.
  - setDynamics
```
public final void setDynamics(ProfileDynamics value)
```
    Sets the platform dynamics that define the pitch up and push over accelerations to use for the landing descent.
  - getDescentAngle
```
public final double getDescentAngle()
```
    Gets the angle of the glide slope for the landing, in radians. This overrides the value for the descent velocity in the Dynamics (get / set).
  - setDescentAngle
```
public final void setDescentAngle(double value)
```
    Sets the angle of the glide slope for the landing, in radians. This overrides the value for the descent velocity in the Dynamics (get / set).
  - getSpeedOnApproach
```
public final double getSpeedOnApproach()
```
    Gets the target speed at which to approach the landing maneuver, in meters per second.
  - setSpeedOnApproach
```
public final void setSpeedOnApproach(double value)
```
    Sets the target speed at which to approach the landing maneuver, in meters per second.
  - getFinalSpeed
```
public final double getFinalSpeed()
```
    Gets the final target speed at which the platform travels after rolling to a stop at the end of the landing, in meters per second.
  - setFinalSpeed
```
public final void setFinalSpeed(double value)
```
    Sets the final target speed at which the platform travels after rolling to a stop at the end of the landing, in meters per second.
  - getRunwayReferenceSurface
```
public final TerrainProvider getRunwayReferenceSurface()
```
    Gets the terrain reference surface to use to define the heights and the surface of the runway.
  - setRunwayReferenceSurface
```
public final void setRunwayReferenceSurface(TerrainProvider value)
```
    Sets the terrain reference surface to use to define the heights and the surface of the runway.
  - getRunwayStartPosition
```
@Nonnull
public final Cartographic getRunwayStartPosition()
```
    Gets the geodetic starting point of the runway.
  - setRunwayStartPosition
```
public final void setRunwayStartPosition(@Nonnull
                                         Cartographic value)
```
    Sets the geodetic starting point of the runway.
  - 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.
  - getInitialHeightAboveRunway
```
public final double getInitialHeightAboveRunway()
```
    Gets the height above the runway at which the platform approaches the landing, in meters. This represents the height of the center of mass (or center of a 3D model) with respect to the RunwayReferenceSurface (get / set) and runway offset specified by the height of the RunwayStartPosition (get / set).
  - setInitialHeightAboveRunway
```
public final void setInitialHeightAboveRunway(double value)
```
    Sets the height above the runway at which the platform approaches the landing, in meters. This represents the height of the center of mass (or center of a 3D model) with respect to the RunwayReferenceSurface (get / set) and runway offset specified by the height of the RunwayStartPosition (get / set).
  - getFinalHeightAboveRunway
```
public final double getFinalHeightAboveRunway()
```
    Gets the final constant offset above the runway, in meters. This represents the height of the center of mass (or center of a 3D model) with respect to the RunwayReferenceSurface (get / set) and runway offset specified by the height of the RunwayStartPosition (get / set).
  - setFinalHeightAboveRunway
```
public final void setFinalHeightAboveRunway(double value)
```
    Sets the final constant offset above the runway, in meters. This represents the height of the center of mass (or center of a 3D model) with respect to the RunwayReferenceSurface (get / set) and runway offset specified by the height of the RunwayStartPosition (get / set).
  - getTurningRadiusOnApproach
```
public final double getTurningRadiusOnApproach()
```
    Gets the horizontal turning radius at which to turn when approaching the glide plane for landing, in meters.
  - setTurningRadiusOnApproach
```
public final void setTurningRadiusOnApproach(double value)
```
    Sets the horizontal turning radius at which to turn when approaching the glide plane for landing, in meters.
  - getTurningRadiusAfterLanding
```
public final double getTurningRadiusAfterLanding()
```
    Gets the final turning radius at which to turn toward the next procedure after landing, in meters. By default, this is one meter.
  - setTurningRadiusAfterLanding
```
public final void setTurningRadiusAfterLanding(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.
  - getRollDistance
```
public final double getRollDistance()
```
    Gets the distance along the runway it takes to go from the landing speed to the final speed, in meters.
  - setRollDistance
```
public final void setRollDistance(double value)
```
    Sets the distance along the runway it takes to go from the landing speed to the final speed, in meters.
  - 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.

Class LandingProcedure

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class agi.foundation.routedesign.RouteProcedure

Methods inherited from class agi.foundation.routedesign.RouteSegment

Methods inherited from class agi.foundation.infrastructure.DefinitionalObject

Methods inherited from class java.lang.Object

Constructor Detail

LandingProcedure

LandingProcedure

LandingProcedure

LandingProcedure

Method Detail

clone

checkForSameDefinition

checkForSameDefinition

computeCurrentDefinitionHashCode

getDynamics

setDynamics

getDescentAngle

setDescentAngle

getSpeedOnApproach

setSpeedOnApproach

getFinalSpeed

setFinalSpeed

getRunwayReferenceSurface

setRunwayReferenceSurface

getRunwayStartPosition

setRunwayStartPosition

getRunwayHeading

setRunwayHeading

getInitialHeightAboveRunway

setInitialHeightAboveRunway

getFinalHeightAboveRunway

setFinalHeightAboveRunway

getTurningRadiusOnApproach

setTurningRadiusOnApproach

getTurningRadiusAfterLanding

setTurningRadiusAfterLanding

getRollDistance

setRollDistance

getSurfacePath

createConfigurableProfile