agi.foundation.routedesign.advanced

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

Enum HeightConfigurationStatus

java.lang.Object

java.lang.Enum<HeightConfigurationStatus>

agi.foundation.routedesign.advanced.HeightConfigurationStatus

All Implemented Interfaces:

Enumeration, Serializable, Comparable<HeightConfigurationStatus>

public enum HeightConfigurationStatus
extends Enum<HeightConfigurationStatus>
implements Enumeration

An enumeration indicating the status of the configuration of height information between route segments.

Enum Constant Summary

Enum Constants

Enum Constant and Description
BOTH_HEIGHTS_CHANGED Both the previous and the next height was changed in order to configure the current profile successfully.
HEIGHTS_MATCH The heights and height rates match.
NEXT_HEIGHT_CHANGED The next height was changed in order to configure the current profile successfully.
NEXT_HEIGHT_RATES_DO_NOT_MATCH Due to the geometry of the current route, the propagator was unable to connect the height rates of two profiles.
NO_HEIGHT_CONNECTION_POSSIBLE Due to the geometry of the current route profile, no configuration was possible without discontinuities.
OTHER_CONFIGURATION_ERROR An error occurred while configuring a particular RouteProfile.
PREVIOUS_HEIGHT_CHANGED The previous height was changed in order to configure the current profile successfully.
PREVIOUS_HEIGHT_RATES_DO_NOT_MATCH Due to the geometry of the current route, the propagator was unable to connect the height rates of two profiles.
VIOLATES_PROFILE_DYNAMICS Due to the geometry of the current route profile, the configuration could not find a profile geometry that satisfies the specified ProfileDynamics while changing the height.

Method Summary

Modifier and Type	Method and Description
static HeightConfigurationStatus	getDefault() Get the enum constant that is considered to be the default.
static HeightConfigurationStatus	getFromValue(int value) Get the enum constant that is associated with the given numeric value.
int	getValue() Get the numeric value associated with this enum constant.
static HeightConfigurationStatus	valueOf(String name) Returns the enum constant of this type with the specified name.
static HeightConfigurationStatus[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

HEIGHTS_MATCH

public static final HeightConfigurationStatus HEIGHTS_MATCH

The heights and height rates match.

PREVIOUS_HEIGHT_CHANGED

public static final HeightConfigurationStatus PREVIOUS_HEIGHT_CHANGED

The previous height was changed in order to configure the current profile successfully. If route configuration was unsuccessful, this may represent a discontinuity.

NEXT_HEIGHT_CHANGED

public static final HeightConfigurationStatus NEXT_HEIGHT_CHANGED

The next height was changed in order to configure the current profile successfully. If route configuration was unsuccessful, this may represent a discontinuity.

BOTH_HEIGHTS_CHANGED

public static final HeightConfigurationStatus BOTH_HEIGHTS_CHANGED

Both the previous and the next height was changed in order to configure the current profile successfully. If route configuration was unsuccessful, either the initial or final height may have a discontinuity.

NO_HEIGHT_CONNECTION_POSSIBLE

public static final HeightConfigurationStatus NO_HEIGHT_CONNECTION_POSSIBLE

Due to the geometry of the current route profile, no configuration was possible without discontinuities. This usually occurs when two procedures are too close together without being able to configure them appropriately or when there is an error with the settings of the current profile.

PREVIOUS_HEIGHT_RATES_DO_NOT_MATCH

public static final HeightConfigurationStatus PREVIOUS_HEIGHT_RATES_DO_NOT_MATCH

Due to the geometry of the current route, the propagator was unable to connect the height rates of two profiles. This usually occurs when two ConstantHeightProfiles are used adjacent to each other with different HeightReferenceSurfaces. In this case, the "constant" heights do not connect smoothly due to the different height rates of the underlying terrain.

NEXT_HEIGHT_RATES_DO_NOT_MATCH

public static final HeightConfigurationStatus NEXT_HEIGHT_RATES_DO_NOT_MATCH

Due to the geometry of the current route, the propagator was unable to connect the height rates of two profiles. This usually occurs when two ConstantHeightProfiles are used adjacent to each other with different HeightReferenceSurfaces. In this case, the "constant" heights do not connect smoothly due to the different height rates of the underlying terrain.

VIOLATES_PROFILE_DYNAMICS

public static final HeightConfigurationStatus VIOLATES_PROFILE_DYNAMICS

Due to the geometry of the current route profile, the configuration could not find a profile geometry that satisfies the specified ProfileDynamics while changing the height.

OTHER_CONFIGURATION_ERROR

public static final HeightConfigurationStatus OTHER_CONFIGURATION_ERROR

An error occurred while configuring a particular RouteProfile. Check the settings on the profile to make sure that they are feasible and that they are compatible with the surrounding connection profile behavior. See the Data (get) on the corresponding HeightConfigurationResult for more information.

Method Detail

values

public static HeightConfigurationStatus[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (HeightConfigurationStatus c : HeightConfigurationStatus.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static HeightConfigurationStatus valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

getValue

public int getValue()

Get the numeric value associated with this enum constant.

Specified by:

getValue in interface Enumeration

Returns:

A numeric value.

getFromValue

@Nonnull
public static HeightConfigurationStatus getFromValue(int value)

Get the enum constant that is associated with the given numeric value.

Parameters:

value - a numeric value.

Returns:

The enum constant associated with value.

getDefault

@Nonnull
public static HeightConfigurationStatus getDefault()

Get the enum constant that is considered to be the default.

Returns:

The default enum constant.