agi.foundation.routedesign

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

Class StandardTransitionProfile

java.lang.Object

agi.foundation.routedesign.RouteProfile

agi.foundation.routedesign.StandardTransitionProfile

public class StandardTransitionProfile
extends RouteProfile

A profile defined by a set of simple inclines, used to connect two other profiles at different heights or to change the target height for the route. When used as a connection profile, this will attempt to level off at the final target height of the previous profile, based on the given dynamics for ascending and descending. If the surface distance is too short, it will attempt to connect directly or will attempt to reconfigure the surrounding profiles to ensure it does not violate its Dynamics (get / set).

For aircraft, this assumes steady flight and constant pitch rates. The aircraft then pitches up or down based on the acceleration specified in the Dynamics (get / set) to a constant flight path angle. It then accelerates along the incline as necessary to satisfy the initial and final speed.

Constructor Summary

Constructors

Constructor and Description
StandardTransitionProfile() Create a new instance.
StandardTransitionProfile(ProfileDynamics dynamics, ProfileSpeed targetSpeed, double initialHeight, double initialHeightRate, double finalHeight, double finalHeightRate, TerrainProvider heightReference) Create a new instance based on the given parameters to completely define the incline.
StandardTransitionProfile(ProfileDynamics dynamics, ProfileSpeed targetSpeed, TerrainProvider heightReference) Create a new instance based on the given platform properties.

Method Summary

Modifier and Type	Method and Description
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.
boolean	getAllowModificationOfFinalHeight() Gets a value indicating whether to allow changes to the FinalHeight (get / set) while configuring the route.
boolean	getAllowModificationOfInitialHeight() Gets a value indicating whether to allow changes to the InitialHeight (get / set) while configuring the route.
ProfileSpeed	getCruiseSpeed() Gets the speed to use as the target speed at which to traverse along the path.
ProfileDynamics	getDynamics() Gets the set of parameters specifying the achievable accelerations during the profile.
double	getFinalHeight() Gets the final height of the incline with respect to the surface path, in meters.
double	getFinalHeightRate() Gets the final vertical velocity, in meters per second.
ProfileSpeed	getFinalSpeed() Gets the final speed at the end of the profile.
TerrainProvider	getHeightReferenceSurface() Gets the reference surface above which the height is defined.
double	getInitialHeight() Gets the initial height of the incline with respect to the surface path, in meters.
double	getInitialHeightRate() Gets the initial vertical velocity, in meters per second.
ProfileSpeed	getInitialSpeed() Gets the initial speed at the beginning of the profile.
boolean	getUseDirectTransition() Gets a value indicating whether to attempt to transition directly from the initial height to the final height or whether to cruise at the initial height and then ascend or descend to the final height at the rate given by the specified Dynamics (get / set).
void	setAllowModificationOfFinalHeight(boolean value) Sets a value indicating whether to allow changes to the FinalHeight (get / set) while configuring the route.
void	setAllowModificationOfInitialHeight(boolean value) Sets a value indicating whether to allow changes to the InitialHeight (get / set) while configuring the route.
void	setCruiseSpeed(ProfileSpeed value) Sets the speed to use as the target speed at which to traverse along the path.
void	setDynamics(ProfileDynamics value) Sets the set of parameters specifying the achievable accelerations during the profile.
void	setFinalHeight(double value) Sets the final height of the incline with respect to the surface path, in meters.
void	setFinalHeightRate(double value) Sets the final vertical velocity, in meters per second.
void	setFinalSpeed(ProfileSpeed value) Sets the final speed at the end of the profile.
void	setHeightReferenceSurface(TerrainProvider value) Sets the reference surface above which the height is defined.
void	setInitialHeight(double value) Sets the initial height of the incline with respect to the surface path, in meters.
void	setInitialHeightRate(double value) Sets the initial vertical velocity, in meters per second.
void	setInitialSpeed(ProfileSpeed value) Sets the initial speed at the beginning of the profile.
void	setUseDirectTransition(boolean value) Sets a value indicating whether to attempt to transition directly from the initial height to the final height or whether to cruise at the initial height and then ascend or descend to the final height at the rate given by the specified Dynamics (get / set).

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

StandardTransitionProfile

public StandardTransitionProfile()

Create a new instance.

StandardTransitionProfile

public StandardTransitionProfile(ProfileDynamics dynamics,
                                 ProfileSpeed targetSpeed,
                                 TerrainProvider heightReference)

Create a new instance based on the given platform properties.

Parameters:

dynamics - The dynamical properties of the platform.

targetSpeed - The target speed at which to traverse this profile.

heightReference - The reference above which the height of this profile is defined.

StandardTransitionProfile

public StandardTransitionProfile(ProfileDynamics dynamics,
                                 ProfileSpeed targetSpeed,
                                 double initialHeight,
                                 double initialHeightRate,
                                 double finalHeight,
                                 double finalHeightRate,
                                 TerrainProvider heightReference)

Create a new instance based on the given parameters to completely define the incline.

Parameters:

dynamics - The dynamical properties of the position.

targetSpeed - The speed at which to traverse the profile.

initialHeight - The fixed initial height of the incline with respect to the surface, in meters.

initialHeightRate - The initial rate of climb (or descent), in meters per second.

finalHeight - The fixed final height of the incline with respect to the surface, in meters.

finalHeightRate - The final rate of climb (or descent), in meters per second.

heightReference - The reference surface above which to define the incline.

Method Detail

getInitialHeight

public final double getInitialHeight()

Gets the initial height of the incline with respect to the surface path, in meters. If AllowModificationOfInitialHeight (get / set) is false, this height will be fixed during the configuration. Otherwise, the surrounding profiles may modify it to configure the route.

setInitialHeight

public final void setInitialHeight(double value)

Sets the initial height of the incline with respect to the surface path, in meters. If AllowModificationOfInitialHeight (get / set) is false, this height will be fixed during the configuration. Otherwise, the surrounding profiles may modify it to configure the route.

getFinalHeight

public final double getFinalHeight()

Gets the final height of the incline with respect to the surface path, in meters. If AllowModificationOfFinalHeight (get / set) is false, this height will be fixed during the configuration. Otherwise, the surrounding profiles may modify it to configure the route.

setFinalHeight

public final void setFinalHeight(double value)

Sets the final height of the incline with respect to the surface path, in meters. If AllowModificationOfFinalHeight (get / set) is false, this height will be fixed during the configuration. Otherwise, the surrounding profiles may modify it to configure the route.

getInitialHeightRate

public final double getInitialHeightRate()

Gets the initial vertical velocity, in meters per second. If AllowModificationOfInitialHeight (get / set) is false, this height will be fixed during the configuration. Otherwise, the surrounding profiles may modify it to configure the route.

setInitialHeightRate

public final void setInitialHeightRate(double value)

Sets the initial vertical velocity, in meters per second. If AllowModificationOfInitialHeight (get / set) is false, this height will be fixed during the configuration. Otherwise, the surrounding profiles may modify it to configure the route.

getFinalHeightRate

public final double getFinalHeightRate()

Gets the final vertical velocity, in meters per second. If AllowModificationOfInitialHeight (get / set) is false, this height will be fixed during the configuration. Otherwise, the surrounding profiles may modify it to configure the route.

setFinalHeightRate

public final void setFinalHeightRate(double value)

Sets the final vertical velocity, in meters per second. If AllowModificationOfInitialHeight (get / set) is false, this height will be fixed during the configuration. Otherwise, the surrounding profiles may modify it to configure the route.

getAllowModificationOfInitialHeight

public final boolean getAllowModificationOfInitialHeight()

Gets a value indicating whether to allow changes to the InitialHeight (get / set) while configuring the route. By default, this is true.

setAllowModificationOfInitialHeight

public final void setAllowModificationOfInitialHeight(boolean value)

Sets a value indicating whether to allow changes to the InitialHeight (get / set) while configuring the route. By default, this is true.

getAllowModificationOfFinalHeight

public final boolean getAllowModificationOfFinalHeight()

Gets a value indicating whether to allow changes to the FinalHeight (get / set) while configuring the route. By default, this is true.

setAllowModificationOfFinalHeight

public final void setAllowModificationOfFinalHeight(boolean value)

Sets a value indicating whether to allow changes to the FinalHeight (get / set) while configuring the route. By default, this is true.

getUseDirectTransition

public final boolean getUseDirectTransition()

Gets a value indicating whether to attempt to transition directly from the initial height to the final height or whether to cruise at the initial height and then ascend or descend to the final height at the rate given by the specified Dynamics (get / set). By default, this is true.

setUseDirectTransition

public final void setUseDirectTransition(boolean value)

Sets a value indicating whether to attempt to transition directly from the initial height to the final height or whether to cruise at the initial height and then ascend or descend to the final height at the rate given by the specified Dynamics (get / set). By default, this is true.

getHeightReferenceSurface

public final TerrainProvider getHeightReferenceSurface()

Gets the reference surface above which the height is defined.

setHeightReferenceSurface

public final void setHeightReferenceSurface(TerrainProvider value)

Sets the reference surface above which the height is defined.

getDynamics

public final ProfileDynamics getDynamics()

Gets the set of parameters specifying the achievable accelerations during the profile.

setDynamics

public final void setDynamics(ProfileDynamics value)

Sets the set of parameters specifying the achievable accelerations during the profile.

getInitialSpeed

public final ProfileSpeed getInitialSpeed()

Gets the initial speed at the beginning of the profile.

setInitialSpeed

public final void setInitialSpeed(ProfileSpeed value)

Sets the initial speed at the beginning of the profile.

getFinalSpeed

public final ProfileSpeed getFinalSpeed()

Gets the final speed at the end of the profile.

setFinalSpeed

public final void setFinalSpeed(ProfileSpeed value)

Sets the final speed at the end of the profile.

getCruiseSpeed

public final ProfileSpeed getCruiseSpeed()

Gets the speed to use as the target speed at which to traverse along the path.

setCruiseSpeed

public final void setCruiseSpeed(ProfileSpeed value)

Sets the speed to use as the target speed at which to traverse along the path.

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 RouteProfile

Parameters:

surfacePath - The surface path over which the profile is defined.

Returns:

The configurable profile used by the RoutePropagator to configure the route.