org.youscope.plugin.controller

Interface ControllerJob

All Superinterfaces:

Component, Job, JobContainer, java.rmi.Remote, TableProducer

public interface ControllerJob
extends Job, JobContainer, TableProducer

Job which implements a controller, consisting of an input, a control algorithm and an output.

Author:

Moritz Lang

Method Summary

Modifier and Type	Method and Description
java.lang.String	getControllerScripScript() Returns the script of the controller which gets evaluated by the script engine.
java.lang.String	getControllerScriptEngine() Returns the name of the script engine, or null, if script engine is not set.
Job	getInputJob() Returns the job which is used to produce the input for the controller.
Job	getOutputJob() Returns the job which is used to consume the output of the controller.
void	setControllerScript(java.lang.String controllerScript) Sets the script for the controller which gets evaluated by the script engine.
void	setControllerScriptEngine(java.lang.String engine) Sets the script engine with which the scripts should be evaluated.
void	setInputJob(Job inputJob) Sets the job which should be used to create the table data used as input for the controller.
void	setOutputJob(Job outputJob) Sets the job which should be used to consume the output from the controller.

Methods inherited from interface org.youscope.common.job.Job

addJobListener, executeJob, initializeJob, removeJobListener, uninitializeJob

Methods inherited from interface org.youscope.common.Component

addMessageListener, getName, getPositionInformation, getUUID, removeMessageListener, setName

Methods inherited from interface org.youscope.common.job.JobContainer

getJob, getJobs, getNumJobs

Methods inherited from interface org.youscope.common.table.TableProducer

addTableListener, getProducedTableDefinition, removeTableListener

Method Detail

setControllerScriptEngine

void setControllerScriptEngine(java.lang.String engine)
                        throws java.rmi.RemoteException,
                               MeasurementRunningException

Sets the script engine with which the scripts should be evaluated.

Parameters:

engine - The script engine to use.

Throws:

java.rmi.RemoteException

MeasurementRunningException

getControllerScriptEngine

java.lang.String getControllerScriptEngine()
                                    throws java.rmi.RemoteException

Returns the name of the script engine, or null, if script engine is not set.

Returns:

Script engine factory name.

Throws:

java.rmi.RemoteException

setControllerScript

void setControllerScript(java.lang.String controllerScript)
                  throws java.rmi.RemoteException,
                         MeasurementRunningException

Sets the script for the controller which gets evaluated by the script engine.

Parameters:

controllerScript - Controller script to evaluate.

Throws:

java.rmi.RemoteException

MeasurementRunningException

getControllerScripScript

java.lang.String getControllerScripScript()
                                   throws java.rmi.RemoteException

Returns the script of the controller which gets evaluated by the script engine.

Returns:

Script of the controller.

Throws:

java.rmi.RemoteException

getInputJob

Job getInputJob()
         throws java.rmi.RemoteException

Returns the job which is used to produce the input for the controller. It is guaranteed that this job implements the TableDataProducer interface.

Returns:

Table data producing used as input, or null.

Throws:

java.rmi.RemoteException

setInputJob

void setInputJob(Job inputJob)
          throws java.rmi.RemoteException,
                 MeasurementRunningException,
                 java.lang.IllegalArgumentException,
                 java.lang.NullPointerException

Sets the job which should be used to create the table data used as input for the controller. The job must implement the TableProducer. If this is not given, an IllegalArgumentException will be thrown.

Parameters:

inputJob - Table producing job for control algorithm.

Throws:

java.rmi.RemoteException

MeasurementRunningException

java.lang.IllegalArgumentException - If inputJob does not implement TableProducer.

java.lang.NullPointerException - Thrown if inputJob is null.

getOutputJob

Job getOutputJob()
          throws java.rmi.RemoteException

Returns the job which is used to consume the output of the controller. It is guaranteed that this job implements the OutputConsumer interface.

Returns:

Output consumer job, or null if yet not set.

Throws:

java.rmi.RemoteException

setOutputJob

void setOutputJob(Job outputJob)
           throws java.rmi.RemoteException,
                  MeasurementRunningException,
                  java.lang.IllegalArgumentException,
                  java.lang.NullPointerException

Sets the job which should be used to consume the output from the controller. The job must implement the TableProducer. If this is not given, an IllegalArgumentException will be thrown.

Parameters:

outputJob - output consumer job.

Throws:

java.rmi.RemoteException

MeasurementRunningException

java.lang.IllegalArgumentException - If outputJob does not implement TableConsumer.

java.lang.NullPointerException - Thrown if outputJob is null,