org.youscope.plugin.composedimaging

Class StaggeringJobConfiguration

java.lang.Object

org.youscope.common.job.JobConfiguration

org.youscope.plugin.composedimaging.StaggeringJobConfiguration

All Implemented Interfaces:

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

public class StaggeringJobConfiguration
extends JobConfiguration
implements JobContainerConfiguration

Author:

langmo

See Also:

Serialized Form

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor and Description
StaggeringJobConfiguration()

Method Summary

Modifier and Type	Method and Description
void	addJob(JobConfiguration job) Adds a job to the job list.
void	addJob(JobConfiguration job, int index) Adds a job to the job list.
void	checkConfiguration() Checks the current state of the configuration.
void	clearJobs() Removes all jobs from the job list.
java.lang.Object	clone()
double	getDeltaX()
double	getDeltaY()
java.lang.String	getDescription() Returns a short description of this job.
JobConfiguration[]	getJobs() Returns the job list which might be edited by the caller.
int	getNumIterationsBreak() Returns the number of iterations for which nothing should be done before imaging in the next iteration the defined number of tiles.
int	getNumTilesPerIteration() Returns the number of tiles which should be imaged per iteration.
int	getNumTilesX()
int	getNumTilesY()
java.lang.String	getTypeIdentifier() Returns a unique identifier for this configuration type.
void	removeJobAt(int index) Removes the job at the given index.
void	setDeltaX(double deltaX)
void	setDeltaY(double deltaY)
void	setJobs(JobConfiguration[] jobs) Sets the job list to the given list.
void	setNumIterationsBreak(int numIterationsBreak) Set the number of iterations for which nothing should be done before imaging in the next iteration the defined number of tiles.
void	setNumTilesPerIteration(int numTilesPerIteration) Set the number of tiles which should be imaged per iteration.
void	setNumTilesX(int nx)
void	setNumTilesY(int ny)

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

Field Detail

TYPE_IDENTIFIER

public static final java.lang.String TYPE_IDENTIFIER

The identifier for this job type.

See Also:

Constant Field Values

Constructor Detail

StaggeringJobConfiguration

public StaggeringJobConfiguration()

Method Detail

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.

setNumTilesPerIteration

public void setNumTilesPerIteration(int numTilesPerIteration)

Set the number of tiles which should be imaged per iteration. Set to -1 to image all tiles.

Parameters:

numTilesPerIteration - Number of tiles per iteration

setNumIterationsBreak

public void setNumIterationsBreak(int numIterationsBreak)

Set the number of iterations for which nothing should be done before imaging in the next iteration the defined number of tiles.

Parameters:

numIterationsBreak - Number of iterations which should be waited.

getNumTilesPerIteration

public int getNumTilesPerIteration()

Returns the number of tiles which should be imaged per iteration. Returns -1 to image all tiles.

Returns:

Number of tiles per iteration

getNumIterationsBreak

public int getNumIterationsBreak()

Returns the number of iterations for which nothing should be done before imaging in the next iteration the defined number of tiles.

Returns:

Number of iterations which should be waited.

setNumTilesX

public void setNumTilesX(int nx)

Parameters:

nx - number of tiles in x-direction

getNumTilesX

public int getNumTilesX()

Returns:

number of tiles in x-direction

setNumTilesY

public void setNumTilesY(int ny)

Parameters:

ny - number of tiles in y-direction

getNumTilesY

public int getNumTilesY()

Returns:

number of tiles in y-direction

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.

clone

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

Overrides:

clone in class JobConfiguration

Throws:

java.lang.CloneNotSupportedException

getJobs

public JobConfiguration[] getJobs()

Description copied from interface: JobContainerConfiguration

Returns the job list which might be edited by the caller.

Specified by:

getJobs in interface JobContainerConfiguration

Returns:

Job list.

setJobs

public void setJobs(JobConfiguration[] jobs)

Description copied from interface: JobContainerConfiguration

Sets the job list to the given list.

Specified by:

setJobs in interface JobContainerConfiguration

Parameters:

jobs - New job list.

addJob

public void addJob(JobConfiguration job)

Description copied from interface: JobContainerConfiguration

Adds a job to the job list.

Specified by:

addJob in interface JobContainerConfiguration

Parameters:

job - Job to be added.

clearJobs

public void clearJobs()

Description copied from interface: JobContainerConfiguration

Removes all jobs from the job list.

Specified by:

clearJobs in interface JobContainerConfiguration

removeJobAt

public void removeJobAt(int index)

Description copied from interface: JobContainerConfiguration

Removes the job at the given index.

Specified by:

removeJobAt in interface JobContainerConfiguration

Parameters:

index - Index of the job to be removed.

addJob

public void addJob(JobConfiguration job,
                   int index)

Description copied from interface: JobContainerConfiguration

Adds a job to the job list. The job is added such that it has the given index. Jobs having a higher or equal index before the operation are moved downwards.

Specified by:

addJob in interface JobContainerConfiguration

Parameters:

job - Job to be added.

index - Index where the job should be added.

setDeltaX

public void setDeltaX(double deltaX)

Parameters:

deltaX - Distance between neighboring tiles in the x-direction in micro m.

getDeltaX

public double getDeltaX()

Returns:

Distance between neighboring tiles in the x-direction in micro m.

setDeltaY

public void setDeltaY(double deltaY)

Parameters:

deltaY - Distance between neighboring tiles in the y-direction in micro m.

getDeltaY

public double getDeltaY()

Returns:

Distance between neighboring tiles in the y-direction in micro m.

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