public class ControllerJobConfiguration extends JobConfiguration implements TableProducerConfiguration
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
TYPE_IDENTIFIER
The identifier for this measurement type.
|
Constructor and Description |
---|
ControllerJobConfiguration() |
Modifier and Type | Method and Description |
---|---|
void |
checkConfiguration()
Checks the current state of the configuration.
|
java.lang.String |
getControllerScript()
Returns the script of the controller, i.e.
|
java.lang.String |
getControllerScriptEngine()
Returns the name of the script engine with which the controller script should be executed.
|
java.lang.String |
getControllerTableSaveName()
Returns the name of the file (without file extension) under which the input/output data of the controller should be saved.
|
java.lang.String |
getDescription()
Returns a short description of this job.
|
JobConfiguration |
getInputJob()
Returns the job which is used to produce the input for the controller.
|
JobConfiguration |
getOutputJob()
Returns the job which is used to consume the output of the controller.
|
TableDefinition |
getProducedTableDefinition()
Returns the definition of the table layout of the tables produced by this producer, e.g.
|
java.lang.String |
getTypeIdentifier()
Returns a unique identifier for this configuration type.
|
void |
setControllerScript(java.lang.String controllerScript)
Sets the script of the controller, i.e.
|
void |
setControllerScriptEngine(java.lang.String controllerScriptEngine)
Sets the name of the script engine with which the controller script should be executed.
|
void |
setControllerTableSaveName(java.lang.String controllerTableSaveName)
Sets the name of the file (without file extension) under which the input/output data of the controller should be saved.
|
void |
setInputJob(JobConfiguration inputJob)
Sets the job which should be used to create the table data used as input for the controller.
|
void |
setOutputJob(JobConfiguration outputJob)
Sets the job which should be used to consume the output from the controller.
|
clone, toString
public static final java.lang.String TYPE_IDENTIFIER
public java.lang.String getTypeIdentifier()
Configuration
getTypeIdentifier
in interface Configuration
public JobConfiguration getInputJob()
public void setInputJob(JobConfiguration inputJob) throws java.lang.IllegalArgumentException
TableProducerConfiguration
. If this is not given, an IllegalArgumentException will be thrown.inputJob
- Table data producing job for control algorithm, or null.java.lang.IllegalArgumentException
- If inputJob does not implement TableDataProducerConfiguration.public JobConfiguration getOutputJob()
public void setOutputJob(JobConfiguration outputJob) throws java.lang.IllegalArgumentException
TableConsumerConfiguration
. If this is not given, an IllegalArgumentException will be thrown.outputJob
- output consumer job configuration, or null.java.lang.IllegalArgumentException
- If outputJob does not implement TableConsumerConfiguration.public java.lang.String getDescription()
JobConfiguration
getDescription
in class JobConfiguration
public TableDefinition getProducedTableDefinition()
TableProducerConfiguration
TableProducer.getProducedTableDefinition()
.getProducedTableDefinition
in interface TableProducerConfiguration
public void setControllerScript(java.lang.String controllerScript)
controllerScript
- The script to set.public java.lang.String getControllerScript()
public void setControllerScriptEngine(java.lang.String controllerScriptEngine)
controllerScriptEngine
- Name of the script engine.public java.lang.String getControllerScriptEngine()
public void setControllerTableSaveName(java.lang.String controllerTableSaveName)
controllerTableSaveName
- Name of the file (without extension) for controller I/O saving, or null if it should not be saved.public java.lang.String getControllerTableSaveName()
public void checkConfiguration() throws ConfigurationException
Configuration
ConfigurationException
is thrown describing the error, and what has to be changed in the configuration, by the user,
such that it becomes valid. This error can then e.g. be displayed to the user
(see ConfigurationAddonTools.displayConfigurationInvalid(ConfigurationException, YouScopeClient).checkConfiguration
in interface Configuration
checkConfiguration
in class JobConfiguration
ConfigurationException