org.youscope.plugin.changepositionjob

Class ChangePositionJobConfiguration

java.lang.Object

org.youscope.common.job.JobConfiguration

org.youscope.plugin.changepositionjob.ChangePositionJobConfiguration

All Implemented Interfaces:

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

public class ChangePositionJobConfiguration
extends JobConfiguration

This job/task changes the position of the microscope in regular intervals.

Author:

Moritz Lang

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
ChangePositionJobConfiguration()

Method Summary

Modifier and Type	Method and Description
void	checkConfiguration() Checks the current state of the configuration.
java.lang.Object	clone()
java.lang.String	getDescription() Returns a short description of this job.
java.lang.String	getStageDevice() Returns the stage device which should be moved, or null for the default stage.
java.lang.String	getTypeIdentifier() Returns a unique identifier for this configuration type.
double	getX()
double	getY()
boolean	isAbsolute()
void	setAbsolute(boolean absolute)
void	setStageDevice(java.lang.String stageDevice) Set to the stage device which should be moved, or to null for the default stage.
void	setX(double x)
void	setY(double y)

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

toString

Methods inherited from class java.lang.Object

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

Constructor Detail

ChangePositionJobConfiguration

public ChangePositionJobConfiguration()

Method Detail

setX

public void setX(double x)

Parameters:

x - the x to set

getX

public double getX()

Returns:

the x

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.

setAbsolute

public void setAbsolute(boolean absolute)

Parameters:

absolute - the absolute to set

isAbsolute

public boolean isAbsolute()

Returns:

the absolute

setY

public void setY(double y)

Parameters:

y - the y to set

getY

public double getY()

Returns:

the y

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.

clone

public java.lang.Object clone()
                       throws java.lang.CloneNotSupportedException

Overrides:

clone in class JobConfiguration

Throws:

java.lang.CloneNotSupportedException

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

getStageDevice

public java.lang.String getStageDevice()

Returns the stage device which should be moved, or null for the default stage.

Returns:

Stage device to move.

setStageDevice

public void setStageDevice(java.lang.String stageDevice)

Set to the stage device which should be moved, or to null for the default stage.

Parameters:

stageDevice - Stage which should be moved.