agi.foundation.routedesign

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

Class ConstantHeightProfile

java.lang.Object

agi.foundation.routedesign.RouteProfile

agi.foundation.routedesign.advanced.HoldingPatternProfile

agi.foundation.routedesign.ConstantHeightProfile

public class ConstantHeightProfile
extends HoldingPatternProfile

A profile that simply represents a constant height and constant speed with respect to the reference surface of the corresponding surface path.

Constructor Summary

Constructors

Constructor and Description
ConstantHeightProfile() Create a new instance.
ConstantHeightProfile(double speed, double maxAcceleration, double maxDeceleration, double height, RouteHeightReference heightReference) Create a new instance with the given speed and height.
ConstantHeightProfile(double speed, double maxAcceleration, double maxDeceleration, double height, TerrainProvider heightReference) Create a new instance with the given speed and height.
ConstantHeightProfile(double speed, double height, RouteHeightReference heightReference) Create a new instance with the given speed and height.
ConstantHeightProfile(double speed, double height, TerrainProvider heightReference) Create a new instance with the given speed and height.

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	getAllowVariationInHeight() Gets a value indicating whether to allow any variation in the height of the profile or whether to maintain a constant height.
boolean	getAllowVariationInSpeed() Gets a value indicating whether to allow any variation in speed along the profile or whether to maintain a constant speed.
double	getHeight() Gets the constant target height above the reference surface of the surface path, in meters.
TerrainProvider	getHeightReferenceSurface() Gets the reference surface above which the height is defined.
int	getMinimumRevolutionsFromTime(Duration minimumTime, SurfaceSegment initialSegment, SurfaceSegment finalSegment, SurfaceSegment oneRevolutionSegment) Get the minimum number of revolutions required to spend a minimum time in a holding procedure.
double	getSpeed() Gets the target speed along the path, in meters per second.
double	getThrustAcceleration() Gets the value of the acceleration to use when increasing the speed, in meters per second squared.
double	getThrustDeceleration() Gets the value of the acceleration to use when decreasing the speed, in meters per second squared.
void	setAllowVariationInHeight(boolean value) Sets a value indicating whether to allow any variation in the height of the profile or whether to maintain a constant height.
void	setAllowVariationInSpeed(boolean value) Sets a value indicating whether to allow any variation in speed along the profile or whether to maintain a constant speed.
void	setHeight(double value) Sets the constant target height above the reference surface of the surface path, in meters.
void	setHeightReferenceSurface(TerrainProvider value) Sets the reference surface above which the height is defined.
void	setSpeed(double value) Sets the target speed along the path, in meters per second.
void	setThrustAcceleration(double value) Sets the value of the acceleration to use when increasing the speed, in meters per second squared.
void	setThrustDeceleration(double value) Sets the value of the acceleration to use when decreasing the speed, in meters per second squared.

Methods inherited from class java.lang.Object

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

Constructor Detail

ConstantHeightProfile

public ConstantHeightProfile()

Create a new instance.

ConstantHeightProfile

public ConstantHeightProfile(double speed,
                             double height,
                             TerrainProvider heightReference)

Create a new instance with the given speed and height. The profile is set such that it cannot be modified (the AllowVariationInSpeed (get / set) and AllowVariationInHeight (get / set) properties return false).

Parameters:

speed - The target total speed at which to travel along the surface path.

height - The constant height above the reference surface of the surface path.

heightReference - The reference surface above which the profile is defined.

ConstantHeightProfile

public ConstantHeightProfile(double speed,
                             double height,
                             @Nonnull
                             RouteHeightReference heightReference)

Create a new instance with the given speed and height. The profile is set such that it cannot be modified (the AllowVariationInSpeed (get / set) and AllowVariationInHeight (get / set) properties return false).

Parameters:

speed - The target total speed at which to travel along the surface path.

height - The constant height above the reference surface of the surface path.

heightReference - The reference surface above which the profile is defined.

ConstantHeightProfile

public ConstantHeightProfile(double speed,
                             double maxAcceleration,
                             double maxDeceleration,
                             double height,
                             @Nonnull
                             RouteHeightReference heightReference)

Create a new instance with the given speed and height. With this constructor, the speed and height can be adjusted by the route (the AllowVariationInSpeed (get / set) and AllowVariationInHeight (get / set) properties return true).

Parameters:

speed - The target total speed at which to travel along the surface path.

maxAcceleration - The maximum acceleration to use over the course of the profile.

maxDeceleration - The maximum deceleration to use over the course of the profile.

height - The constant height above the reference surface of the surface path.

heightReference - The reference surface above which the profile is defined.

ConstantHeightProfile

public ConstantHeightProfile(double speed,
                             double maxAcceleration,
                             double maxDeceleration,
                             double height,
                             TerrainProvider heightReference)

Create a new instance with the given speed and height. With this constructor, the speed and height can be adjusted by the route (the AllowVariationInSpeed (get / set) and AllowVariationInHeight (get / set) properties return true).

Parameters:

speed - The target total speed at which to travel along the surface path.

maxAcceleration - The maximum acceleration to use over the course of the profile.

maxDeceleration - The maximum deceleration to use over the course of the profile.

height - The constant height above the reference surface of the surface path.

heightReference - The reference surface above which the profile is defined.

Method Detail

getHeight

public final double getHeight()

Gets the constant target height above the reference surface of the surface path, in meters. If AllowVariationInHeight (get / set) is set to true, the RoutePropagator will try to match the height as closely as possible, but will allow changes if necessary.

setHeight

public final void setHeight(double value)

Sets the constant target height above the reference surface of the surface path, in meters. If AllowVariationInHeight (get / set) is set to true, the RoutePropagator will try to match the height as closely as possible, but will allow changes if necessary.

getThrustAcceleration

public final double getThrustAcceleration()

Gets the value of the acceleration to use when increasing the speed, in meters per second squared.

setThrustAcceleration

public final void setThrustAcceleration(double value)

Sets the value of the acceleration to use when increasing the speed, in meters per second squared.

getThrustDeceleration

public final double getThrustDeceleration()

Gets the value of the acceleration to use when decreasing the speed, in meters per second squared.

setThrustDeceleration

public final void setThrustDeceleration(double value)

Sets the value of the acceleration to use when decreasing the speed, in meters per second squared.

getSpeed

public final double getSpeed()

Gets the target speed along the path, in meters per second. If AllowVariationInSpeed (get / set) is set to true, the RoutePropagator will try to match the speed as closely as possible, but will allow changes if necessary.

setSpeed

public final void setSpeed(double value)

Sets the target speed along the path, in meters per second. If AllowVariationInSpeed (get / set) is set to true, the RoutePropagator will try to match the speed as closely as possible, but will allow changes if necessary.

getAllowVariationInSpeed

public final boolean getAllowVariationInSpeed()

Gets a value indicating whether to allow any variation in speed along the profile or whether to maintain a constant speed. By default, this value is false to maintain constant speed.

setAllowVariationInSpeed

public final void setAllowVariationInSpeed(boolean value)

Sets a value indicating whether to allow any variation in speed along the profile or whether to maintain a constant speed. By default, this value is false to maintain constant speed.

getAllowVariationInHeight

public final boolean getAllowVariationInHeight()

Gets a value indicating whether to allow any variation in the height of the profile or whether to maintain a constant height. By default, this value is true to allow the height to be adjusted as necessary by surrounding profiles.

setAllowVariationInHeight

public final void setAllowVariationInHeight(boolean value)

Sets a value indicating whether to allow any variation in the height of the profile or whether to maintain a constant height. By default, this value is true to allow the height to be adjusted as necessary by surrounding profiles.

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.

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.

getMinimumRevolutionsFromTime

public int getMinimumRevolutionsFromTime(@Nonnull
                                         Duration minimumTime,
                                         SurfaceSegment initialSegment,
                                         SurfaceSegment finalSegment,
                                         SurfaceSegment oneRevolutionSegment)

Get the minimum number of revolutions required to spend a minimum time in a holding procedure.

Specified by:

getMinimumRevolutionsFromTime in class HoldingPatternProfile

Parameters:

minimumTime - Minimum time to spend in the holding pattern.

initialSegment - The initial segment required to enter into the hold.

finalSegment - The final segment required to exit the hold.

oneRevolutionSegment - The segment signifying one revolution around the hold.

Returns:

The number of revolutions necessary to fulfill the minimum time condition.