public abstract class Experiment extends AnchorBean<Experiment> implements AssociateXMLUponLoad
It is an atomic unit of execution in the Anchor framework in many contexts.
Constructor and Description |
---|
Experiment() |
Modifier and Type | Method and Description |
---|---|
void |
associateXML(org.apache.commons.configuration.XMLConfiguration xmlConfiguration)
Associated an XML configuration with an object.
|
abstract Optional<Path> |
executeExperiment(ExecutionArguments arguments)
Executes the experiment.
|
org.apache.commons.configuration.XMLConfiguration |
getXMLConfiguration()
The configuration of experiment serialized into XML form.
|
abstract boolean |
useDetailedLogging()
Whether to log in more or less detail.
|
checkMisconfigured, describeBean, describeChildren, duplicateBean, fields, findFieldsOfClass, getBeanName, getLocalPath, localise, toString
public abstract Optional<Path> executeExperiment(ExecutionArguments arguments) throws ExperimentExecutionException
arguments
- arguments that may influence how the experiment is run.ExperimentExecutionException
- if an error occurs executing the experiment.public org.apache.commons.configuration.XMLConfiguration getXMLConfiguration()
public void associateXML(org.apache.commons.configuration.XMLConfiguration xmlConfiguration)
AssociateXMLUponLoad
associateXML
in interface AssociateXMLUponLoad
xmlConfiguration
- the xml-configuration to associate with an object.public abstract boolean useDetailedLogging()
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.
Copyright © 2010–2023 Owen Feehan, ETH Zurich, University of Zurich, Hoffmann-La Roche. All rights reserved.