agi.foundation.routedesign.advanced

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

Class HeightConfigurationResult

java.lang.Object

agi.foundation.routedesign.advanced.HeightConfigurationResult

public class HeightConfigurationResult
extends Object

The result of configuring the height on a given RouteProcedure.

Constructor Summary

Constructors

Constructor and Description
HeightConfigurationResult(HeightConfigurationStatus connectionStatus) Create a new instance based on the given status.
HeightConfigurationResult(HeightConfigurationStatus connectionStatus, Object data) Create a new instance based on the given status and data.

Method Summary

Modifier and Type	Method and Description
HeightConfigurationStatus	getConnectionStatus() Gets the status of the given configuration.
Object	getData() Gets the diagnostic data associated with the given configuration.

Methods inherited from class java.lang.Object

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

Constructor Detail

HeightConfigurationResult

public HeightConfigurationResult(@Nonnull
                                 HeightConfigurationStatus connectionStatus)

Create a new instance based on the given status.

Parameters:

connectionStatus - The status of the configuration.

HeightConfigurationResult

public HeightConfigurationResult(@Nonnull
                                 HeightConfigurationStatus connectionStatus,
                                 Object data)

Create a new instance based on the given status and data.

Parameters:

connectionStatus - The status of the configuration.

data - An object containing additional diagnostic information. See the documentation for the particular type of RouteSegment corresponding to this instance for more information on what the data contains.

Method Detail

getConnectionStatus

@Nonnull
public final HeightConfigurationStatus getConnectionStatus()

Gets the status of the given configuration.

getData

public final Object getData()

Gets the diagnostic data associated with the given configuration.