org.youscope.plugin.dropletmicrofluidics

Class DropletMicrofluidicJobConfiguration

java.lang.Object

org.youscope.common.job.JobConfiguration

org.youscope.plugin.dropletmicrofluidics.DropletMicrofluidicJobConfiguration

All Implemented Interfaces:

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

public class DropletMicrofluidicJobConfiguration
extends JobConfiguration
implements TableProducerConfiguration

Configuration for a job which automatically searches for the focal plane.

Author:

Moritz Lang

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	DROPLET_TABLE_DEFAULT_NAME Default name for droplet table.
static java.lang.String	TYPE_IDENTIFIER The identifier for this job type.

Constructor Summary

Constructors

Constructor and Description
DropletMicrofluidicJobConfiguration() Constructor.

Method Summary

Modifier and Type	Method and Description
void	checkConfiguration() Checks the current state of the configuration.
AutoFocusJobConfiguration	getAutofocusConfiguration() Returns the configuration for the autofocus.
DropletControllerConfiguration	getControllerConfiguration() Returns the configuration of the controll algorithm.
java.lang.String	getDescription() Returns a short description of this job.
java.lang.String	getDropletTableSaveName() Returns the file name (without extension) under which the droplet table should be saved.
java.lang.String	getNemesysDevice() Returns the name of the Nemesys device.
DropletObserverConfiguration	getObserverConfiguration() Returns the configuration of the observer of the droplet heights.
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	setAutofocusConfiguration(AutoFocusJobConfiguration autofocusConfiguration) Sets the configuration for the autofocus.
void	setControllerConfiguration(DropletControllerConfiguration controllerConfiguration) Sets the configuration of the controll algorithm.
void	setDropletTableSaveName(java.lang.String dropletTableSaveName) Sets the file name (without extension) under which the droplet table should be saved.
void	setNemesysDevice(java.lang.String nemesysDevice) Sets the name of the Nemesys device.
void	setObserverConfiguration(DropletObserverConfiguration observerConfiguration) Sets the configuration of the observer of the droplet heights.

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 job type.

See Also:

Constant Field Values

DROPLET_TABLE_DEFAULT_NAME

public static final java.lang.String DROPLET_TABLE_DEFAULT_NAME

Default name for droplet table.

See Also:

Constant Field Values

Constructor Detail

DropletMicrofluidicJobConfiguration

public DropletMicrofluidicJobConfiguration()

Constructor.

Method Detail

getDropletTableSaveName

public java.lang.String getDropletTableSaveName()

Returns the file name (without extension) under which the droplet table should be saved. Returns null if droplet table is not saved.

Returns:

Droplet table save name, or null.

setDropletTableSaveName

public void setDropletTableSaveName(java.lang.String dropletTableSaveName)

Sets the file name (without extension) under which the droplet table should be saved. Set to null to not save droplet table.

Parameters:

dropletTableSaveName - Droplet table save name, or null.

getNemesysDevice

public java.lang.String getNemesysDevice()

Returns the name of the Nemesys device. Initially null, i.e. unset.

Returns:

nemesys device name.

setNemesysDevice

public void setNemesysDevice(java.lang.String nemesysDevice)

Sets the name of the Nemesys device.

Parameters:

nemesysDevice - nemesys device name.

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.

getAutofocusConfiguration

public AutoFocusJobConfiguration getAutofocusConfiguration()

Returns the configuration for the autofocus.

Returns:

AUtofocus configuration.

setAutofocusConfiguration

public void setAutofocusConfiguration(AutoFocusJobConfiguration autofocusConfiguration)

Sets the configuration for the autofocus.

Parameters:

autofocusConfiguration - Autofocus configuration.

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.

getControllerConfiguration

public DropletControllerConfiguration getControllerConfiguration()

Returns the configuration of the controll algorithm.

Returns:

Control algorithm configuration.

setControllerConfiguration

public void setControllerConfiguration(DropletControllerConfiguration controllerConfiguration)

Sets the configuration of the controll algorithm.

Parameters:

controllerConfiguration - Control algorithm configuration.

getObserverConfiguration

public DropletObserverConfiguration getObserverConfiguration()

Returns the configuration of the observer of the droplet heights.

Returns:

Droplet height observer.

setObserverConfiguration

public void setObserverConfiguration(DropletObserverConfiguration observerConfiguration)

Sets the configuration of the observer of the droplet heights.

Parameters:

observerConfiguration - Droplet height observer configuraion.

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.

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