public abstract class OutputExperiment extends Experiment
Experiment
that produces output files, as defined by a OutputManager
.Modifier and Type | Field and Description |
---|---|
static String |
OUTPUT_EXECUTION_TIME
The name for the output that records the total execution-time of the experiment.
|
Constructor and Description |
---|
OutputExperiment() |
Modifier and Type | Method and Description |
---|---|
protected abstract MultiLevelOutputEnabled |
defaultOutputs()
If specified, default rules for determine which outputs are enabled or not.
|
Optional<Path> |
executeExperiment(ExecutionArguments arguments)
Executes the experiment for given arguments.
|
protected abstract Optional<TaskStatistics> |
executeExperimentWithParameters(ParametersExperiment parameters)
Executes the experiment for parameters.
|
ExperimentIdentifier |
getExperimentIdentifier()
A name for the experiment.
|
LoggingDestination |
getLogExperiment()
Where log messages that do not pertain to a specific job (input) appear.
|
OutputManager |
getOutput()
The output-manager that specifies how/where/which elements occur duing outputting.
|
boolean |
isForceDetailedLogging()
Whether more detailed log-messages around each experiment occur.
|
void |
setExperimentIdentifier(ExperimentIdentifier experimentIdentifier)
A name for the experiment.
|
void |
setForceDetailedLogging(boolean forceDetailedLogging)
Whether more detailed log-messages around each experiment occur.
|
void |
setLogExperiment(LoggingDestination logExperiment)
Where log messages that do not pertain to a specific job (input) appear.
|
void |
setOutput(OutputManager output)
The output-manager that specifies how/where/which elements occur duing outputting.
|
boolean |
useDetailedLogging()
Whether to log in more or less detail.
|
associateXML, getXMLConfiguration
checkMisconfigured, describeBean, describeChildren, duplicateBean, fields, findFieldsOfClass, getBeanName, getLocalPath, localise, toString
public static final String OUTPUT_EXECUTION_TIME
public Optional<Path> executeExperiment(ExecutionArguments arguments) throws ExperimentExecutionException
executeExperiment
in class Experiment
arguments
- additional run-time configuration/parameters that influences the experiment.ExperimentExecutionException
- if an error occurs executing the experiment.public boolean useDetailedLogging()
Experiment
It's appropriate to perform more detailed logging for a lengthier experiment, but something quick and simple is preferable for a short job, which may only be outputted to the console.
useDetailedLogging
in class Experiment
protected abstract Optional<TaskStatistics> executeExperimentWithParameters(ParametersExperiment parameters) throws ExperimentExecutionException
parameters
- a combination of run-time and bean-time specified elements used in the
experiment.ExperimentExecutionException
- if anything occurs stop the experiment finishing its
executionprotected abstract MultiLevelOutputEnabled defaultOutputs()
public OutputManager getOutput()
public void setOutput(OutputManager output)
public LoggingDestination getLogExperiment()
Note that in the case of a InputOutputExperiment
an additional log will be created
for each specific job.
public void setLogExperiment(LoggingDestination logExperiment)
Note that in the case of a InputOutputExperiment
an additional log will be created
for each specific job.
public ExperimentIdentifier getExperimentIdentifier()
public void setExperimentIdentifier(ExperimentIdentifier experimentIdentifier)
public boolean isForceDetailedLogging()
if true, then detailed messages around each experiment (name, time, start-stop events etc.) are ALWAYS displayed if false, these will sometimes be hidden (e.g. if the execution of each file is very quick)
public void setForceDetailedLogging(boolean forceDetailedLogging)
if true, then detailed messages around each experiment (name, time, start-stop events etc.) are ALWAYS displayed if false, these will sometimes be hidden (e.g. if the execution of each file is very quick)
Copyright © 2010–2023 Owen Feehan, ETH Zurich, University of Zurich, Hoffmann-La Roche. All rights reserved.