Package com.powsybl.computation

Interface ComputationParameters

All Superinterfaces:

Extendable<ComputationParameters>

All Known Implementing Classes:

ComputationParametersImpl

public interface ComputationParameters
extends Extendable<ComputationParameters>

Author:

Yichen TANG <yichen.tang at rte-france.com>

Method Summary

Modifier and Type	Method	Description
static ComputationParameters	empty()
OptionalLong	getDeadline(String commandId)	Returns an optional describing the total time limit in seconds, the waiting time in queue is included.
OptionalLong	getTimeout(String commandId)	Returns an optional describing the execution time limit in seconds, the waiting time in queue is not included.

Methods inherited from interface com.powsybl.commons.extensions.Extendable

addExtension, getExtension, getExtensionByName, getExtensions, getImplementationName, newExtension, removeExtension

Method Details

getTimeout

OptionalLong getTimeout(String commandId)

Returns an optional describing the execution time limit in seconds, the waiting time in queue is not included. See differences with getDeadline(String)

Parameters:

commandId - id of Command

Returns:

an optional describing seconds

getDeadline

OptionalLong getDeadline(String commandId)

Returns an optional describing the total time limit in seconds, the waiting time in queue is included. See differences with getTimeout(String)

Parameters:

commandId - id of Command

Returns:

an optional describing seconds

empty

static ComputationParameters empty()

Returns:

an empty ComputationParameters, but it supports plugin. See more Extension