com.powsybl.security.distributed

Class SecurityAnalysisCommandOptions

java.lang.Object

com.powsybl.security.distributed.SecurityAnalysisCommandOptions

public class SecurityAnalysisCommandOptions
extends java.lang.Object

Utility class to programmatically generate an itools security-analysis command with its various options. Currently supported options are : - the Path to case file - an optional Path to contingencies file - an optional Path to parameters file - an optional Path to output file - an optional format for the output file - a list of requested result extensions - a list of violation types of interest - an optional task count

Author:

Sylvain Leclerc

Constructor Summary

Constructors

Constructor and Description
SecurityAnalysisCommandOptions()

Method Summary

Modifier and Type	Method and Description
SecurityAnalysisCommandOptions	absolutePaths(boolean absolutePaths)
SecurityAnalysisCommandOptions	caseFile(java.nio.file.Path caseFile)
SecurityAnalysisCommandOptions	contingenciesFile(java.nio.file.Path contingenciesFile)
SecurityAnalysisCommandOptions	id(java.lang.String id)
SecurityAnalysisCommandOptions	itoolsCommand(java.lang.String itoolsCommand)
SecurityAnalysisCommandOptions	logFile(java.util.function.Function<java.lang.Integer,java.nio.file.Path> logFile)
SecurityAnalysisCommandOptions	logFile(java.nio.file.Path logFile)
SecurityAnalysisCommandOptions	outputFile(java.util.function.Function<java.lang.Integer,java.nio.file.Path> outputFile, java.lang.String format)
SecurityAnalysisCommandOptions	outputFile(java.nio.file.Path outputFile, java.lang.String format)
SecurityAnalysisCommandOptions	parametersFile(java.nio.file.Path parametersFile)
SecurityAnalysisCommandOptions	resultExtension(java.lang.String extensionName)
SecurityAnalysisCommandOptions	resultExtensions(java.util.Collection<java.lang.String> extensionNames)
SecurityAnalysisCommandOptions	task(java.util.function.Function<java.lang.Integer,Partition> task)
SecurityAnalysisCommandOptions	task(Partition task)
SecurityAnalysisCommandOptions	taskBasedOnIndex(int taskCount)
SecurityAnalysisCommandOptions	taskCount(int taskCount)
SimpleCommand	toCommand()
SecurityAnalysisCommandOptions	violationType(LimitViolationType violationType)
SecurityAnalysisCommandOptions	violationTypes(java.util.Collection<LimitViolationType> violationTypes)

Methods inherited from class java.lang.Object

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

Constructor Detail

SecurityAnalysisCommandOptions

public SecurityAnalysisCommandOptions()

Method Detail

itoolsCommand

public SecurityAnalysisCommandOptions itoolsCommand(java.lang.String itoolsCommand)

id

public SecurityAnalysisCommandOptions id(java.lang.String id)

absolutePaths

public SecurityAnalysisCommandOptions absolutePaths(boolean absolutePaths)

caseFile

public SecurityAnalysisCommandOptions caseFile(java.nio.file.Path caseFile)

contingenciesFile

public SecurityAnalysisCommandOptions contingenciesFile(java.nio.file.Path contingenciesFile)

parametersFile

public SecurityAnalysisCommandOptions parametersFile(java.nio.file.Path parametersFile)

taskCount

public SecurityAnalysisCommandOptions taskCount(int taskCount)

outputFile

public SecurityAnalysisCommandOptions outputFile(java.util.function.Function<java.lang.Integer,java.nio.file.Path> outputFile,
                                                 java.lang.String format)

logFile

public SecurityAnalysisCommandOptions logFile(java.nio.file.Path logFile)

logFile

public SecurityAnalysisCommandOptions logFile(java.util.function.Function<java.lang.Integer,java.nio.file.Path> logFile)

outputFile

public SecurityAnalysisCommandOptions outputFile(java.nio.file.Path outputFile,
                                                 java.lang.String format)

taskBasedOnIndex

public SecurityAnalysisCommandOptions taskBasedOnIndex(int taskCount)

task

public SecurityAnalysisCommandOptions task(java.util.function.Function<java.lang.Integer,Partition> task)

task

public SecurityAnalysisCommandOptions task(Partition task)

resultExtension

public SecurityAnalysisCommandOptions resultExtension(java.lang.String extensionName)

resultExtensions

public SecurityAnalysisCommandOptions resultExtensions(java.util.Collection<java.lang.String> extensionNames)

violationType

public SecurityAnalysisCommandOptions violationType(LimitViolationType violationType)

violationTypes

public SecurityAnalysisCommandOptions violationTypes(java.util.Collection<LimitViolationType> violationTypes)

toCommand

public SimpleCommand toCommand()