agi.foundation.routedesign.advanced

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

Class SurfaceConfigurationResult

java.lang.Object

agi.foundation.routedesign.advanced.SurfaceConfigurationResult

public class SurfaceConfigurationResult
extends Object

The result of configuring the surface geometry on a given RouteProcedure.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
SurfaceConnectionStatus	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

SurfaceConfigurationResult

public SurfaceConfigurationResult(@Nonnull
                                  SurfaceConnectionStatus connectionStatus)

Create a new instance based on the given status.

Parameters:

connectionStatus - The status of the configuration.

SurfaceConfigurationResult

public SurfaceConfigurationResult(@Nonnull
                                  SurfaceConnectionStatus 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 SurfaceConnectionStatus getConnectionStatus()

Gets the status of the given configuration.

getData

public final Object getData()

Gets the diagnostic data associated with the given configuration.