Package com.powsybl.computation

Interface SimpleCommand

All Superinterfaces:

Command

public interface SimpleCommand
extends Command

A single command to be executed, defined by its program name and a list of arguments. The actual values of arguments may depend on the execution number, when several executions are submitted to a ComputationManager.

A timeout for the execution of this command may be specified.

Author:

Geoffroy Jamgotchian <geoffroy.jamgotchian at rte-france.com>

Method Summary

Modifier and Type	Method	Description
List<String>	getArgs(int executionNumber)	The list of arguments to be passed to the program, for the specified execution number.
String	getProgram()	Define the name of the program to be executed.
int	getTimeout()	Deprecated. ComputationParameters.getTimeout(java.lang.String) should be used instead.

Methods inherited from interface com.powsybl.computation.Command

getId, getInputFiles, getOutputFiles, getType, toString

Method Details

getProgram

String getProgram()

Define the name of the program to be executed.

Returns:

the name of the program to be executed.

getArgs

List<String> getArgs(int executionNumber)

The list of arguments to be passed to the program, for the specified execution number.

Parameters:

executionNumber - execution number for which arguments are requested.

Returns:

the list of arguments to be passed to the program, for the specified execution number.

getTimeout

@Deprecated(since="2.5.0")
int getTimeout()

Deprecated.

ComputationParameters.getTimeout(java.lang.String) should be used instead. A timeout in milliseconds for this command execution. If less than zero, the execution time should be considered as unlimited.

Returns:

the timeout in milliseconds for this command execution.