Class ExperimentExecutor
Object
ExperimentExecutor
Runs a particular experiment after identifying necessary paths and input files.
- Author:
- Owen Feehan
-
Method Summary
Modifier and TypeMethodDescriptionvoid
executeExperiment
(ExecutionArguments executionArguments, boolean alwaysShowExperimentArguments, Logger logger) Executes an experiment after finding a single experiment XML file, and reading the experiment from this file.getInput()
The input selection parameter.The output selection parameter.getTask()
The task selection parameter.boolean
Whether to open the output directory in the desktop GUI after execution (if supported on the O/S).void
setDefaultBehaviourString
(Optional<String> defaultBehaviourString) If present, a string is printed in the description if the default-experiment is used, otherwise ignored.void
setInput
(SelectParam<Optional<Path>> input) The input selection parameter.void
setOpenInDesktop
(boolean openInDesktop) Whether to open the output directory in the desktop GUI after execution (if supported on the O/S).void
setOutput
(SelectParam<Optional<Path>> output) The output selection parameter.void
setTask
(SelectParam<Optional<Path>> task) The task selection parameter.Gets the path to the task directory.
-
Method Details
-
executeExperiment
public void executeExperiment(ExecutionArguments executionArguments, boolean alwaysShowExperimentArguments, Logger logger) throws ExperimentExecutionException Executes an experiment after finding a single experiment XML file, and reading the experiment from this file.- Parameters:
executionArguments
- theExecutionArguments
for the experimentalwaysShowExperimentArguments
- whether to always show experiment argumentslogger
- theLogger
to use for logging- Throws:
ExperimentExecutionException
- if the execution ends early
-
taskDirectory
Gets the path to the task directory.- Returns:
- the
Path
to the task directory
-
getInput
The input selection parameter. -
setInput
The input selection parameter. -
getOutput
The output selection parameter. -
setOutput
The output selection parameter. -
getTask
The task selection parameter. -
setTask
The task selection parameter. -
isOpenInDesktop
public boolean isOpenInDesktop()Whether to open the output directory in the desktop GUI after execution (if supported on the O/S). -
setOpenInDesktop
public void setOpenInDesktop(boolean openInDesktop) Whether to open the output directory in the desktop GUI after execution (if supported on the O/S). -
setDefaultBehaviourString
If present, a string is printed in the description if the default-experiment is used, otherwise ignored.
-