org.youscope.common.configuration

Class FocusConfiguration

java.lang.Object

org.youscope.common.configuration.FocusConfiguration

All Implemented Interfaces:

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

public final class FocusConfiguration
extends java.lang.Object
implements Configuration

Configuration of a focus device (with focus adjustment time).

Author:

Moritz Lang

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
FocusConfiguration() Default constructor.
FocusConfiguration(FocusConfiguration configuration) Copy constructor.
FocusConfiguration(java.lang.String focusDevice) Constructor.
FocusConfiguration(java.lang.String focusDevice, int adjustmentTime) Constructor.

Method Summary

Modifier and Type	Method and Description
void	checkConfiguration() Checks the current state of the configuration.
FocusConfiguration	clone()
boolean	equals(java.lang.Object obj)
int	getAdjustmentTime()
java.lang.String	getFocusDevice()
java.lang.String	getTypeIdentifier() Returns a unique identifier for this configuration type.
int	hashCode()
void	setAdjustmentTime(int adjustmentTime)
void	setFocusDevice(java.lang.String focusDevice)

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

FocusConfiguration

public FocusConfiguration()

Default constructor. Sets focus device to null (i.e. default focus), and adjustment time to 0ms.

FocusConfiguration

public FocusConfiguration(java.lang.String focusDevice)

Constructor. Sets focus adjustment time to 0ms.

Parameters:

focusDevice - The focus device to use (null for default focus device).

FocusConfiguration

public FocusConfiguration(java.lang.String focusDevice,
                          int adjustmentTime)

Constructor.

Parameters:

focusDevice - The focus device to use (null for default focus device).

adjustmentTime - Time in ms after a change of the focus position can be assumed to have taken effect.

FocusConfiguration

public FocusConfiguration(FocusConfiguration configuration)

Copy constructor.

Parameters:

configuration - Focus configuration to copy. If null, same as FocusConfiguration().

Method Detail

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

setAdjustmentTime

public void setAdjustmentTime(int adjustmentTime)

Parameters:

adjustmentTime - the adjustmentTime to set

getFocusDevice

public java.lang.String getFocusDevice()

Returns:

The focus device.

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.

setFocusDevice

public void setFocusDevice(java.lang.String focusDevice)

Parameters:

focusDevice - The focus device.

getAdjustmentTime

public int getAdjustmentTime()

Returns:

the adjustmentTime

clone

public FocusConfiguration clone()

Overrides:

clone in class java.lang.Object

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

Throws:

ConfigurationException