org.youscope.plugin.dropletmicrofluidics.tablecontroller

Class TableControllerConfiguration

java.lang.Object

org.youscope.common.resource.ResourceConfiguration

org.youscope.addon.dropletmicrofluidics.DropletControllerConfiguration

org.youscope.plugin.dropletmicrofluidics.tablecontroller.TableControllerConfiguration

All Implemented Interfaces:

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

public class TableControllerConfiguration
extends DropletControllerConfiguration

Configuration for the droplet based microfluidic measurements based on a syringe table.

Author:

Moritz Lang

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	TYPE_IDENTIFIER The identifier for this configuration.

Constructor Summary

Constructors

Constructor and Description
TableControllerConfiguration()

Method Summary

Modifier and Type	Method and Description
void	checkConfiguration() Checks the current state of the configuration.
double	getMaxDeltaFlowRate() Maximal flow rate in ul/min for the correction of drolet height.
double	getRatioHeightToVolume() Returns the (estimated) ratio between droplet height in um and the droplet volume in ul.
org.youscope.plugin.dropletmicrofluidics.tablecontroller.SyringeTableRow[]	getSyringeTableRows() Returns a table defining when which syringe should act as an outflow or inflow syringe.
double	getTargetFlowRate() Returns the target flow rate in ul/min.
long	getTimeConstantIntegral() Returns the time constant (in ms) of the integral part of the controller.
long	getTimeConstantProportional() Returns the time constant (in ms) of the proportional part of the controller.
java.lang.String	getTypeIdentifier() Returns a unique identifier for this configuration type.
boolean	isCorrectByOutflow() True if droplet height is corrected by varying outflow, false if varying inflow.
void	setCorrectByOutflow(boolean correctByOutflow) True if droplet height is corrected by varying outflow, false if varying inflow.
void	setMaxDeltaFlowRate(double maxDeltaFlowRate) Maximal flow rate in ul/min for the correction of drolet height.
void	setRatioHeightToVolume(double ratioHeightToVolume) Sets the (estimated) ratio between droplet height in um and the droplet volume in ul.
void	setSyringeTableRows(org.youscope.plugin.dropletmicrofluidics.tablecontroller.SyringeTableRow[] syringeTableRows) Sets a table defining when which syringe should act as an outflow or inflow syringe.
void	setTargetFlowRate(double targetRate) Sets the target flow rate in ul/min
void	setTimeConstantIntegral(long timeConstantIntegral) Sets the time constant (in ms) of the integral part of the controller.
void	setTimeConstantProportional(long timeConstantProportional) Sets the time constant (in ms) of the proportional part of the controller.

Methods inherited from class org.youscope.common.resource.ResourceConfiguration

clone

Methods inherited from class java.lang.Object

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

Field Detail

TYPE_IDENTIFIER

public static final java.lang.String TYPE_IDENTIFIER

The identifier for this configuration.

See Also:

Constant Field Values

Constructor Detail

TableControllerConfiguration

public TableControllerConfiguration()

Method Detail

isCorrectByOutflow

public boolean isCorrectByOutflow()

True if droplet height is corrected by varying outflow, false if varying inflow.

Returns:

true if corrected by outflow.

setCorrectByOutflow

public void setCorrectByOutflow(boolean correctByOutflow)

True if droplet height is corrected by varying outflow, false if varying inflow.

Parameters:

correctByOutflow - true if corrected by outflow.

getRatioHeightToVolume

public double getRatioHeightToVolume()

Returns the (estimated) ratio between droplet height in um and the droplet volume in ul.

Returns:

ratio height to volume.

setRatioHeightToVolume

public void setRatioHeightToVolume(double ratioHeightToVolume)

Sets the (estimated) ratio between droplet height in um and the droplet volume in ul.

Parameters:

ratioHeightToVolume - ratio height to volume.

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

Returns:

Unique identifier of the configuration type.

getTargetFlowRate

public double getTargetFlowRate()

Returns the target flow rate in ul/min.

Returns:

target flow rate.

setTargetFlowRate

public void setTargetFlowRate(double targetRate)

Sets the target flow rate in ul/min

Parameters:

targetRate - flow rate in ul/min

getMaxDeltaFlowRate

public double getMaxDeltaFlowRate()

Maximal flow rate in ul/min for the correction of drolet height. Must be smaller than getTargetFlowRate().

Returns:

maximal correction flow rate.

setMaxDeltaFlowRate

public void setMaxDeltaFlowRate(double maxDeltaFlowRate)

Maximal flow rate in ul/min for the correction of drolet height. Must be smaller than getTargetFlowRate().

Parameters:

maxDeltaFlowRate - maximal correction flow rate.

getTimeConstantProportional

public long getTimeConstantProportional()

Returns the time constant (in ms) of the proportional part of the controller.

Returns:

time constant of proportional part.

setTimeConstantProportional

public void setTimeConstantProportional(long timeConstantProportional)

Sets the time constant (in ms) of the proportional part of the controller.

Parameters:

timeConstantProportional - time constant of proportional part.

getTimeConstantIntegral

public long getTimeConstantIntegral()

Returns the time constant (in ms) of the integral part of the controller.

Returns:

time constant of integral part.

setTimeConstantIntegral

public void setTimeConstantIntegral(long timeConstantIntegral)

Sets the time constant (in ms) of the integral part of the controller.

Parameters:

timeConstantIntegral - time constant of integral part.

getSyringeTableRows

public org.youscope.plugin.dropletmicrofluidics.tablecontroller.SyringeTableRow[] getSyringeTableRows()

Returns a table defining when which syringe should act as an outflow or inflow syringe.

Returns:

syringe table.

setSyringeTableRows

public void setSyringeTableRows(org.youscope.plugin.dropletmicrofluidics.tablecontroller.SyringeTableRow[] syringeTableRows)

Sets a table defining when which syringe should act as an outflow or inflow syringe.

Parameters:

syringeTableRows - syringe table.

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 ResourceConfiguration

Throws:

ConfigurationException