org.youscope.plugin.microplatemeasurement

Class MicroplateMeasurementConfiguration

java.lang.Object

org.youscope.common.measurement.MeasurementConfiguration

org.youscope.plugin.microplatemeasurement.MicroplateMeasurementConfiguration

All Implemented Interfaces:

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

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

This class represents the configuration of a user configurable microtiter plate measurement.

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
MicroplateMeasurementConfiguration()

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()
FocusConfiguration	getFocusConfiguration()
JobConfiguration[]	getJobs() Returns the job list which might be edited by the caller.
MicroplatePositionConfiguration	getMicroplatePositions() Returns the used microplate and the measured positions therein.
java.lang.String	getPathOptimizerID() Returns the ID of the optimizer which should be used to minimize the distances between two wells/positions measured.
PeriodConfiguration	getPeriod()
java.lang.String	getStageDevice() Returns the ID of the stage device which should be used to change between wells and positions.
java.lang.String	getStatisticsFileName() Returns the name (without extension) of the file in which statistics of the measurement should be saved to.
int	getTimePerWell()
java.lang.String	getTypeIdentifier() Returns a unique identifier for this configuration type.
boolean	isAllowEditsWhileRunning() Returns true if measurement configuration can be edited while it is running.
void	removeJobAt(int index) Removes the job at the given index.
void	setAllowEditsWhileRunning(boolean allowEditsWhileRunning) Set to true to allow the measurement to be edited while running.
void	setFocusConfiguration(FocusConfiguration focusConfiguration)
void	setJobs(JobConfiguration[] jobs) Sets the job list to the given list.
void	setMicroplatePositions(MicroplatePositionConfiguration microplatePositions) Sets the used microplate and the measured positions therein.
void	setPathOptimizerID(java.lang.String pathOptimizerID) Sets the ID of the optimizer which should be used to minimize the distances between two wells/positions measured.
void	setPeriod(PeriodConfiguration period)
void	setStageDevice(java.lang.String stageDevice) Sets the ID of the stage device which should be used to change between wells and positions.
void	setStatisticsFileName(java.lang.String statisticsFileName) Sets the name (without extension) of the file in which statistics of the measurement should be saved to.
void	setTimePerWell(int timePerWell)

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

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

MicroplateMeasurementConfiguration

public MicroplateMeasurementConfiguration()

Method Detail

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

isAllowEditsWhileRunning

public boolean isAllowEditsWhileRunning()

Returns true if measurement configuration can be edited while it is running.

Returns:

True if measurement can be edited.

setAllowEditsWhileRunning

public void setAllowEditsWhileRunning(boolean allowEditsWhileRunning)

Set to true to allow the measurement to be edited while running.

Parameters:

allowEditsWhileRunning - True if measurement should be changeable while running.

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 MeasurementConfiguration

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 MeasurementConfiguration

Throws:

ConfigurationException

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.

setTimePerWell

public void setTimePerWell(int timePerWell)

Parameters:

timePerWell - the timePerWell to set

getTimePerWell

public int getTimePerWell()

Returns:

the timePerWell

setPeriod

public void setPeriod(PeriodConfiguration period)

Parameters:

period - the period to set

getPeriod

public PeriodConfiguration getPeriod()

Returns:

the period

setFocusConfiguration

public void setFocusConfiguration(FocusConfiguration focusConfiguration)

Parameters:

focusConfiguration - The configuration of the focus used when entering a well. Set to NULL to not set focus.

getFocusConfiguration

public FocusConfiguration getFocusConfiguration()

Returns:

The configuration of the focus used when entering a well. NULL if focus is not set.

setMicroplatePositions

public void setMicroplatePositions(MicroplatePositionConfiguration microplatePositions)

Sets the used microplate and the measured positions therein.

Parameters:

microplatePositions - the configuration of the used microplate and the measured positions therein.

getMicroplatePositions

public MicroplatePositionConfiguration getMicroplatePositions()

Returns the used microplate and the measured positions therein.

Returns:

the configuration of the used microplate and the measured positions therein.

setStatisticsFileName

public void setStatisticsFileName(java.lang.String statisticsFileName)

Sets the name (without extension) of the file in which statistics of the measurement should be saved to. Set to null to not generate statistics.

Parameters:

statisticsFileName - name for the file (without extension) in which statistics should be saved, or null.

getStatisticsFileName

public java.lang.String getStatisticsFileName()

Returns the name (without extension) of the file in which statistics of the measurement should be saved to. Returns null if no statistics are generated.

Returns:

name for the file (without extension) in which statistics should be saved, or null.

setPathOptimizerID

public void setPathOptimizerID(java.lang.String pathOptimizerID)

Sets the ID of the optimizer which should be used to minimize the distances between two wells/positions measured. Set to null to not use any optimized path.

Parameters:

pathOptimizerID - The ID of the path optimizer used, or null

getPathOptimizerID

public java.lang.String getPathOptimizerID()

Returns the ID of the optimizer which should be used to minimize the distances between two wells/positions measured. Returns null if not uses any optimized path.

Returns:

The ID of the path optimizer used, or null

setStageDevice

public void setStageDevice(java.lang.String stageDevice)

Sets the ID of the stage device which should be used to change between wells and positions. Set to NULL to use default stage device.

Parameters:

stageDevice - The ID of the stage device, or NULL.

getStageDevice

public java.lang.String getStageDevice()

Returns the ID of the stage device which should be used to change between wells and positions. Returns NULL to use default stage device.

Returns:

The ID of the stage device, or NULL.