org.youscope.plugin.nemesys

Class NemesysJobConfiguration

java.lang.Object

org.youscope.common.job.JobConfiguration

org.youscope.plugin.nemesys.NemesysJobConfiguration

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, Configuration, TableConsumerConfiguration, TableProducerConfiguration

public class NemesysJobConfiguration
extends JobConfiguration
implements TableConsumerConfiguration, TableProducerConfiguration

This job takes controls the syringes of a Nemesys device.

Author:

Moritz Lang

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	SCRIPT_ENGINE_TIMETABLE Script engine name representing that the script to control the syringes is a simple time-table, for which an own interpreter is written.
static java.lang.String	TYPE_IDENTIFIER The identifier for this measurement type.

Constructor Summary

Constructors

Constructor and Description
NemesysJobConfiguration()

Method Summary

Modifier and Type	Method and Description
void	checkConfiguration() Checks the current state of the configuration.
TableDefinition	getConsumedTableDefinition() Returns a information about the layout of the tables which are consumed by the TableConsumer, e.g.
java.lang.String	getDescription() Returns a short description of this job.
java.lang.String	getNemesysDevice() Returns the ID of the Nemesys device which should be controlled, or null if yet not set.
TableDefinition	getProducedTableDefinition() Returns the definition of the table layout of the tables produced by this producer, e.g.
java.lang.String	getScript() Returns the script which controls the syringes, i.e.
java.lang.String	getScriptEngine() Returns the name of the script engine with which the script should be executed.
java.lang.String	getTableSaveName() Returns the name (without extension) of the file to which the flow rate and volume information of the syringe pumps should be stored during evaluation.
java.lang.String	getTypeIdentifier() Returns a unique identifier for this configuration type.
void	setNemesysDevice(java.lang.String nemesysDevice) Sets the ID of the Nemesys device which should be controlled.
void	setScript(java.lang.String script) Sets the script which controls the syringes, i.e.
void	setScriptEngine(java.lang.String scriptEngine) Sets the name of the script engine with which the script should be executed.
void	setTableSaveName(java.lang.String tableSaveName) Sets the name (without extension) of the file to which the flow rate and volume information of the syringe pumps should be stored during evaluation.

Methods inherited from class org.youscope.common.job.JobConfiguration

clone, toString

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

TYPE_IDENTIFIER

public static final java.lang.String TYPE_IDENTIFIER

The identifier for this measurement type.

See Also:

Constant Field Values

SCRIPT_ENGINE_TIMETABLE

public static final java.lang.String SCRIPT_ENGINE_TIMETABLE

Script engine name representing that the script to control the syringes is a simple time-table, for which an own interpreter is written.

See Also:

Constant Field Values

Constructor Detail

NemesysJobConfiguration

public NemesysJobConfiguration()

Method Detail

getTypeIdentifier

public java.lang.String getTypeIdentifier()

Description copied from interface: Configuration

Returns a unique identifier for this configuration type. The identifier is used to determine factories and addons to construct and configure jobs, measurements, etc., given a corresponding configuration. Make sure that the ID returned is unique. The returned identifier should conform to "XXX.YYY", where XXX stands for an identifier of the organizational unit or the person who created the configuration (e.g. ETH, Smith, Cindarella), and YYY stands for an identifier of the specific kind of configuration (e.g. AutofocusJob, PlatePosition, MicroplateMeasurement). Optionally, additional hierarchy levels can be defined by additional separators ., e.g. "YouScope.AutofocusJob.Version1.1" The identifier should not contain spaces, non-ASCII characters, or colons (except for hierarchy level separation). Identifiers should start with a capital character, i.e. A-Z. Make sure to not use the same identifier for different configurations, since this might result in unexpected behavior or errors. Make

Specified by:

getTypeIdentifier in interface Configuration

Returns:

Unique identifier of the configuration type.

getDescription

public java.lang.String getDescription()

Description copied from class: JobConfiguration

Returns a short description of this job.

Specified by:

getDescription in class JobConfiguration

Returns:

Short description of the job.

setScript

public void setScript(java.lang.String script)

Sets the script which controls the syringes, i.e. how the flow rates vary over time.

Parameters:

script - The script to set.

getScript

public java.lang.String getScript()

Returns the script which controls the syringes, i.e. how the flow rates vary over time.

Returns:

Nemesys syringe control script.

setScriptEngine

public void setScriptEngine(java.lang.String scriptEngine)

Sets the name of the script engine with which the script should be executed.

Parameters:

scriptEngine - Name of the script engine.

getScriptEngine

public java.lang.String getScriptEngine()

Returns the name of the script engine with which the script should be executed.

Returns:

Name of the script engine.

setNemesysDevice

public void setNemesysDevice(java.lang.String nemesysDevice)

Sets the ID of the Nemesys device which should be controlled. An error will be thrown later in the job initialization if the device does not exist or is not a Nemesys device.

Parameters:

nemesysDevice - The ID of the nemesys device.

getNemesysDevice

public java.lang.String getNemesysDevice()

Returns the ID of the Nemesys device which should be controlled, or null if yet not set.

Returns:

The ID of the nemesys device, or null.

getConsumedTableDefinition

public TableDefinition getConsumedTableDefinition()

Description copied from interface: TableConsumerConfiguration

Returns a information about the layout of the tables which are consumed by the TableConsumer, e.g. the number and types of columns.

Specified by:

getConsumedTableDefinition in interface TableConsumerConfiguration

Returns:

Information about of the layout of the consumed tables.

getProducedTableDefinition

public TableDefinition getProducedTableDefinition()

Description copied from interface: TableProducerConfiguration

Returns the definition of the table layout of the tables produced by this producer, e.g. the number and types of its columns. This function should return the same TableDefinition as is returned by a measurement component created by this configuration, see TableProducer.getProducedTableDefinition().

Specified by:

getProducedTableDefinition in interface TableProducerConfiguration

Returns:

Information about of the produced tables.

setTableSaveName

public void setTableSaveName(java.lang.String tableSaveName)

Sets the name (without extension) of the file to which the flow rate and volume information of the syringe pumps should be stored during evaluation. Set to null to not store anything to a file.

Parameters:

tableSaveName - Name of the file (without extension) where the Nemesys state should be saved, or null.

getTableSaveName

public java.lang.String getTableSaveName()

Returns the name (without extension) of the file to which the flow rate and volume information of the syringe pumps should be stored during evaluation. Returns null if not storing anything to a file.

Returns:

Name of the file (without extension) where the Nemesys state should be saved, or null.

checkConfiguration

public void checkConfiguration()
                        throws ConfigurationException

Description copied from interface: Configuration

Checks the current state of the configuration. If the configuration state is valid, the method returns normally. If not, a 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).

Specified by:

checkConfiguration in interface Configuration

Overrides:

checkConfiguration in class JobConfiguration

Throws:

ConfigurationException