org.youscope.plugin.usercontrolmeasurement

Class UserControlMeasurementConfiguration

java.lang.Object

org.youscope.common.measurement.MeasurementConfiguration

org.youscope.plugin.usercontrolmeasurement.UserControlMeasurementConfiguration

All Implemented Interfaces:

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

public class UserControlMeasurementConfiguration
extends MeasurementConfiguration
implements java.lang.Cloneable, java.io.Serializable

This class represents the configuration of user-control measurement. In this measurement type, the user can decide when to take where an image.

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

Constructor Summary

Constructors

Constructor and Description
UserControlMeasurementConfiguration()

Method Summary

Modifier and Type	Method and Description
java.lang.String	getStageDevice() Returns the stage device which should be monitored.
double	getStageTolerance() Returns the tolerance for the stage monitoring (in muM).
java.lang.String	getTypeIdentifier() Returns a unique identifier for this configuration type.
void	setStageDevice(java.lang.String stageDevice) Sets the stage device which should be monitored.
void	setStageTolerance(double stageTolerance) Sets the tolerance for the stage monitoring (in muM).

Methods inherited from class org.youscope.common.measurement.MeasurementConfiguration

checkConfiguration, clone, getDeviseSettingsOff, getDeviseSettingsOn, getMeasurementRuntime, getName, getSaveSettings, setDeviseSettingsOff, setDeviseSettingsOn, setMeasurementRuntime, setName, setSaveSettings

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

See Also:

Constant Field Values

Constructor Detail

UserControlMeasurementConfiguration

public UserControlMeasurementConfiguration()

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.

setStageDevice

public void setStageDevice(java.lang.String stageDevice)

Sets the stage device which should be monitored. If the stage device moves less than the tolerance between two successive images, the images are assumed to be made at the same position. Set to null to use the default stage.

Parameters:

stageDevice - ID of the stage to monitor, or null to use the default stage.

getStageDevice

public java.lang.String getStageDevice()

Returns the stage device which should be monitored. If the stage device moves less than the tolerance between two successive images, the images are assumed to be made at the same position. Returns null if the default stage should be used.

Returns:

ID of the stage to monitor, or null to use the default stage.

setStageTolerance

public void setStageTolerance(double stageTolerance)

Sets the tolerance for the stage monitoring (in muM). If the stage device moves less than the tolerance between two successive images, the images are assumed to be made at the same position. Set to a negative value to not monitor the stage.

Parameters:

stageTolerance - Tolerance for stage in muM, or negative number to not monitor stage.

getStageTolerance

public double getStageTolerance()

Returns the tolerance for the stage monitoring (in muM). If the stage device moves less than the tolerance between two successive images, the images are assumed to be made at the same position. Returns a negative value if the stage is not monitored.

Returns:

Tolerance for stage in muM, or negative number if stage is not monitored.