|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.promethee.api.Shell
org.promethee.api.RunShell
public class RunShell
Open API to launch Promethee grid computations using parametrized input files and wrapped code/model.
Once object instanciated, the run() call will launch all calculations and return a Map of results.
Nested Class Summary |
---|
Nested classes/interfaces inherited from class org.promethee.api.Shell |
---|
Shell.TrapSignalHandler |
Field Summary | |
---|---|
static java.lang.String[] |
MODELS
|
Constructor Summary | |
---|---|
RunShell(java.lang.String _model,
java.io.File... _input)
Constructor of grid computing project. |
Method Summary | |
---|---|
void |
addCacheDirectory(java.io.File dir)
Add a given directory to cache for the project. |
void |
caseModified(int index,
int what)
Called each time the case is modified. |
java.io.File |
defaultArchiveDirectory()
|
java.lang.String[] |
getInputVariables()
Provide information about available input. |
java.lang.String[] |
getOutputAvailable()
Provide information about available output. |
int |
getRetries()
|
static java.lang.String |
gridStatusInformation()
|
java.lang.String |
inputExperimentsInformation()
Convenience method to see experiments to run. |
java.lang.String |
outputInformation()
Provide information about available output. |
java.lang.String |
projectInformation()
Provide information about the whole project. |
void |
redirectOutErr()
to redirect in and err stream in |
java.util.Map<java.lang.String,java.lang.String[]> |
run()
Method to start computing of all experiments |
void |
setInputExperiments(java.util.Map var_values)
Define input sample. |
void |
setInputExperiments(java.util.Map var_values,
boolean group)
Define input sample. |
void |
setOutputExpressions(java.lang.String... custom_outs)
Define output |
void |
setRetries(int retries)
|
void |
shutdown()
|
java.lang.String |
variablesInformation()
Provide information about available input. |
Methods inherited from class org.promethee.api.Shell |
---|
ArrayMapToString, ArrayMapToString, delete, getArchiveDirectory, keys, MapToString, MapToString, setArchiveDirectory, setArchiveDirectory, setConsoleVisible, setMathConsoleVisible, setVerboseLevel, toObject, toString, trap |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static java.lang.String[] MODELS
Constructor Detail |
---|
public RunShell(java.lang.String _model, java.io.File... _input) throws java.lang.Exception
_model
- Name of the model/code to use for computing._input
- List of input files to give as argument to the code/model. These (ASCII) files should contain variables (like $toto).
java.lang.Exception
Method Detail |
---|
public void addCacheDirectory(java.io.File dir)
dir
- Directory to add in cachepublic java.lang.String[] getInputVariables()
public java.lang.String variablesInformation()
public java.lang.String inputExperimentsInformation()
public java.lang.String projectInformation()
public static java.lang.String gridStatusInformation()
public void setInputExperiments(java.util.Map var_values) throws java.lang.Exception
var_values
- Combinations of variables (as String keys) and their values (as String[]) to compute.
java.lang.Exception
setInputExperiments(HashMap var_values, boolean group)
public void setInputExperiments(java.util.Map var_values, boolean group) throws java.lang.Exception
var_values
- Combinations of variables (as String keys) and their values (as String[]) to compute.group
- True means that all multiple var_values values are synchronized with others. False means that number of experiments is the product of all values sizes.
java.lang.Exception
public void setOutputExpressions(java.lang.String... custom_outs)
custom_outs
- Math. expressions of output of interest to compute. Possibly including input variables.public java.lang.String[] getOutputAvailable()
public java.lang.String outputInformation()
public java.io.File defaultArchiveDirectory()
defaultArchiveDirectory
in class Shell
public int getRetries()
public void setRetries(int retries)
retries
- the number of retries for a failed claculationpublic void caseModified(int index, int what)
org.promethee.ui.parameter.Case.Observer
caseModified
in interface org.promethee.ui.parameter.Case.Observer
index
- modified casewhat
- modification typepublic java.util.Map<java.lang.String,java.lang.String[]> run()
public void shutdown()
shutdown
in class Shell
public void redirectOutErr()
redirectOutErr
in class Shell
|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |