Package com.powsybl.computation.local

Class LocalComputationManager

java.lang.Object

com.powsybl.computation.local.LocalComputationManager

All Implemented Interfaces:

ComputationManager, AutoCloseable

public class LocalComputationManager
extends Object
implements ComputationManager

Author:

Geoffroy Jamgotchian

Constructor Summary

Constructors

Constructor	Description
LocalComputationManager()
LocalComputationManager(PlatformConfig platformConfig)
LocalComputationManager(LocalComputationConfig config)
LocalComputationManager(LocalComputationConfig config, LocalCommandExecutor localCommandExecutor, Executor executor)
LocalComputationManager(LocalComputationConfig config, Executor executor)
LocalComputationManager(Path localDir)
LocalComputationManager(Executor executor)

Method Summary

Modifier and Type	Method	Description
void	close()
<R> CompletableFuture<R>	execute(ExecutionEnvironment environment, ExecutionHandler<R> handler)	Submits for execution commands defined by the specified ExecutionHandler, using the specified ExecutionEnvironment.
<R> CompletableFuture<R>	execute(ExecutionEnvironment environment, ExecutionHandler<R> handler, ComputationParameters parameters)	Submits for execution commands defined by the specified ExecutionHandler, using the specified ExecutionEnvironment.
static ComputationManager	getDefault()
Executor	getExecutor()	An executor which may be used to perform expensive processing inside this JVM.
Path	getLocalDir()
ComputationResourcesStatus	getResourcesStatus()
String	getVersion()
OutputStream	newCommonFile(String fileName)

Methods inherited from class java.lang.Object

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

Constructor Detail

LocalComputationManager

public LocalComputationManager()
                        throws IOException

Throws:

IOException

LocalComputationManager

public LocalComputationManager(Executor executor)
                        throws IOException

Throws:

IOException

LocalComputationManager

public LocalComputationManager(PlatformConfig platformConfig)
                        throws IOException

Throws:

IOException

LocalComputationManager

public LocalComputationManager(Path localDir)
                        throws IOException

Throws:

IOException

LocalComputationManager

public LocalComputationManager(LocalComputationConfig config)
                        throws IOException

Throws:

IOException

LocalComputationManager

public LocalComputationManager(LocalComputationConfig config,
                               Executor executor)
                        throws IOException

Throws:

IOException

LocalComputationManager

public LocalComputationManager(LocalComputationConfig config,
                               LocalCommandExecutor localCommandExecutor,
                               Executor executor)
                        throws IOException

Throws:

IOException

Method Detail

getDefault

public static ComputationManager getDefault()

getVersion

public String getVersion()

Specified by:

getVersion in interface ComputationManager

getLocalDir

public Path getLocalDir()

Specified by:

getLocalDir in interface ComputationManager

newCommonFile

public OutputStream newCommonFile(String fileName)
                           throws IOException

Specified by:

newCommonFile in interface ComputationManager

Throws:

IOException

execute

public <R> CompletableFuture<R> execute(ExecutionEnvironment environment,
                                        ExecutionHandler<R> handler)

Description copied from interface: ComputationManager

Submits for execution commands defined by the specified ExecutionHandler, using the specified ExecutionEnvironment.

The result of type ComputationManager will be provided asynchronously through the returned CompletableFuture.

Specified by:

execute in interface ComputationManager

Type Parameters:

R - the type of the result expected from the commands execution.

Parameters:

environment - specifies environment details such as the working directory prefix and environment variables.

handler - defines the commands to be executed together with preprocessing and postprocessing.

Returns:

the result of the commands execution, as provided by the execution handler.

execute

public <R> CompletableFuture<R> execute(ExecutionEnvironment environment,
                                        ExecutionHandler<R> handler,
                                        ComputationParameters parameters)

Description copied from interface: ComputationManager

Submits for execution commands defined by the specified ExecutionHandler, using the specified ExecutionEnvironment.

The result of type ComputationManager will be provided asynchronously through the returned CompletableFuture.

Additional technical parameters may be provided through the ComputationParameters.

Specified by:

execute in interface ComputationManager

Type Parameters:

R - the type of the result expected from the commands execution.

Parameters:

environment - specifies environment details such as the working directory prefix and environment variables.

handler - defines the commands to be executed together with preprocessing and postprocessing.

parameters - defines additional technical parameters

Returns:

the result of the commands execution, as provided by the execution handler.

getResourcesStatus

public ComputationResourcesStatus getResourcesStatus()

Specified by:

getResourcesStatus in interface ComputationManager

getExecutor

public Executor getExecutor()

Description copied from interface: ComputationManager

An executor which may be used to perform expensive processing inside this JVM.

Specified by:

getExecutor in interface ComputationManager

Returns:

an executor which may be used to perform expensive processing inside this JVM.

close

public void close()

Specified by:

close in interface AutoCloseable

Specified by:

close in interface ComputationManager