agi.foundation.routedesign.advanced

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

Class SpeedConfigurationResult

java.lang.Object

agi.foundation.routedesign.advanced.SpeedConfigurationResult

public class SpeedConfigurationResult
extends Object

The result of configuring the speed on a given RouteProcedure.

Constructor Summary

Constructors

Constructor and Description
SpeedConfigurationResult(SpeedConfigurationStatus status) Create a new instance based on the given status.
SpeedConfigurationResult(SpeedConfigurationStatus status, Object data) Create a new instance based on the given status and data.

Method Summary

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

SpeedConfigurationResult

public SpeedConfigurationResult(@Nonnull
                                SpeedConfigurationStatus status)

Create a new instance based on the given status.

Parameters:

status - The status of the configuration.

SpeedConfigurationResult

public SpeedConfigurationResult(@Nonnull
                                SpeedConfigurationStatus status,
                                Object data)

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

Parameters:

status - 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 SpeedConfigurationStatus getConnectionStatus()

Gets the status of the given configuration.

getData

public final Object getData()

Gets the diagnostic data associated with the given configuration.