org.youscope.plugin.focusingjob

Class FocusingJobConfiguration

java.lang.Object

org.youscope.common.job.JobConfiguration

org.youscope.plugin.focusingjob.FocusingJobConfiguration

All Implemented Interfaces:

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

public class FocusingJobConfiguration
extends JobConfiguration

Configuration of a job setting the focus.

Author:

Moritz Lang

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
FocusingJobConfiguration()

Method Summary

Modifier and Type	Method and Description
java.lang.Object	clone()
java.lang.String	getDescription() Returns a short description of this job.
FocusConfiguration	getFocusConfiguration()
double	getPosition()
java.lang.String	getTypeIdentifier() Returns a unique identifier for this configuration type.
boolean	isRelative() Returns true if the focus position is an offset to the current focus position.
void	setFocusConfiguration(FocusConfiguration focusConfiguration)
void	setPosition(double position)
void	setRelative(boolean relative) Set to true if the focus position is an offset to the current focus position.

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

checkConfiguration, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

FocusingJobConfiguration

public FocusingJobConfiguration()

Method Detail

setFocusConfiguration

public void setFocusConfiguration(FocusConfiguration focusConfiguration)

Parameters:

focusConfiguration - The configuration of the focus .

getFocusConfiguration

public FocusConfiguration getFocusConfiguration()

Returns:

The configuration of the focus.

isRelative

public boolean isRelative()

Returns true if the focus position is an offset to the current focus position. Returns false if the focus position is an absolute value.

Returns:

true if relative focus position, false if absolute focus position.

setRelative

public void setRelative(boolean relative)

Set to true if the focus position is an offset to the current focus position. Set to false if the focus position is an absolute value.

Parameters:

relative - true if relative focus position, false if absolute focus position.

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.

setPosition

public void setPosition(double position)

Parameters:

position - the position to set

getPosition

public double getPosition()

Returns:

the position

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