Package repast.simphony.batch.ssh
Class Configuration
- java.lang.Object
-
- repast.simphony.batch.ssh.Configuration
-
public class Configuration extends Object
Configuration data loaded from a config file for configuring batch run execution.- Author:
- Nick Collier
-
-
Field Summary
Fields Modifier and Type Field Description static String
BATCH_PARAMS_KEY
static String
CONCATENATE
static String
HEADER
static String
LOCAL_PREFIX
static String
MA_KEY
static String
OUT_DIR_KEY
static String
PATH
static String
PATTERN
static String
PATTERN_PREFIX
static String
POLL_INTERVAL_KEY
static String
REMOTE_PREFIX
static String
SESSION_HOST
static String
SESSION_INSTANCES
static String
SESSION_KEY_FILE
static String
SESSION_USER
static String
SSH_DIR_KEY
static String
VM_ARGS_KEY
-
Constructor Summary
Constructors Constructor Description Configuration(String file)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description String
getBatchParamsFile()
Gets the path to the batch parameter file to use in the batch runs.String
getModelArchive()
Gets the path to the model archive.String
getOutputDir()
Gets the directory into which the aggregated session output will be written.List<OutputPattern>
getOutputPatterns()
Gets the output patterns for this configuration.float
getPollFrequency()
Gets how often, in seconds, to poll remotes to see if they are done.int
getRemoteCount()
Gets the numer of specified remote locations to run the model.String
getSSHKeyDir()
Gets the directory where the ssh keys for the user are located.String
getVMArguments()
Gets any arguments to pass the VM that runs the model.Iterable<? extends Session>
sessions()
Gets an iterable over the sessions described in this Configuration.
-
-
-
Field Detail
-
MA_KEY
public static final String MA_KEY
- See Also:
- Constant Field Values
-
SSH_DIR_KEY
public static final String SSH_DIR_KEY
- See Also:
- Constant Field Values
-
OUT_DIR_KEY
public static final String OUT_DIR_KEY
- See Also:
- Constant Field Values
-
BATCH_PARAMS_KEY
public static final String BATCH_PARAMS_KEY
- See Also:
- Constant Field Values
-
POLL_INTERVAL_KEY
public static final String POLL_INTERVAL_KEY
- See Also:
- Constant Field Values
-
VM_ARGS_KEY
public static final String VM_ARGS_KEY
- See Also:
- Constant Field Values
-
LOCAL_PREFIX
public static final String LOCAL_PREFIX
- See Also:
- Constant Field Values
-
REMOTE_PREFIX
public static final String REMOTE_PREFIX
- See Also:
- Constant Field Values
-
SESSION_USER
public static final String SESSION_USER
- See Also:
- Constant Field Values
-
SESSION_HOST
public static final String SESSION_HOST
- See Also:
- Constant Field Values
-
SESSION_INSTANCES
public static final String SESSION_INSTANCES
- See Also:
- Constant Field Values
-
SESSION_KEY_FILE
public static final String SESSION_KEY_FILE
- See Also:
- Constant Field Values
-
PATTERN_PREFIX
public static final String PATTERN_PREFIX
- See Also:
- Constant Field Values
-
PATTERN
public static final String PATTERN
- See Also:
- Constant Field Values
-
PATH
public static final String PATH
- See Also:
- Constant Field Values
-
HEADER
public static final String HEADER
- See Also:
- Constant Field Values
-
CONCATENATE
public static final String CONCATENATE
- See Also:
- Constant Field Values
-
-
Constructor Detail
-
Configuration
public Configuration(String file) throws IOException
- Throws:
IOException
-
-
Method Detail
-
getOutputPatterns
public List<OutputPattern> getOutputPatterns()
Gets the output patterns for this configuration. The output patterns should be specified in "glob" format using only "/".- Returns:
- the output patterns for this configuration.
-
getModelArchive
public String getModelArchive()
Gets the path to the model archive.- Returns:
- the path to the model archive.
-
getBatchParamsFile
public String getBatchParamsFile()
Gets the path to the batch parameter file to use in the batch runs.- Returns:
- the path to the batch parameter file to use in the batch runs.
-
getSSHKeyDir
public String getSSHKeyDir()
Gets the directory where the ssh keys for the user are located.- Returns:
- the directory where the ssh keys for the user are located.
-
getOutputDir
public String getOutputDir()
Gets the directory into which the aggregated session output will be written.- Returns:
- he directory into which the aggregated session output will be written.
-
getPollFrequency
public float getPollFrequency()
Gets how often, in seconds, to poll remotes to see if they are done.- Returns:
-
getRemoteCount
public int getRemoteCount()
Gets the numer of specified remote locations to run the model.- Returns:
- the numer of specified remote locations to run the model.
-
getVMArguments
public String getVMArguments()
Gets any arguments to pass the VM that runs the model.- Returns:
- any arguments to pass the VM that runs the model.
-
-