org.youscope.common.task

Class VaryingPeriodConfiguration

java.lang.Object

org.youscope.common.task.PeriodConfiguration

org.youscope.common.task.VaryingPeriodConfiguration

All Implemented Interfaces:

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

public class VaryingPeriodConfiguration
extends PeriodConfiguration

This class represents a varying period length. The actual period length for a given iteration is a member of an array of predefined period lengths.

Author:

Moritz Lang

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
VaryingPeriodConfiguration()

Method Summary

Modifier and Type	Method and Description
void	checkConfiguration() Checks the current state of the configuration.
java.lang.Object	clone()
int	getBreakTime() Returns the additional time which should be waited after iterating through all periods.
int[]	getPeriods() Returns the periods.
java.lang.String	getTypeIdentifier() Returns a unique identifier for this configuration type.
void	setBreakTime(int breakTime) Sets an additional time which should be waited after iterating through all periods.
void	setPeriods(int[] periods) Sets the periods.

Methods inherited from class org.youscope.common.task.PeriodConfiguration

getNumExecutions, getStartTime, setNumExecutions, setStartTime

Methods inherited from class java.lang.Object

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

Constructor Detail

VaryingPeriodConfiguration

public VaryingPeriodConfiguration()

Method Detail

setBreakTime

public void setBreakTime(int breakTime)

Sets an additional time which should be waited after iterating through all periods. Default is 0.

Parameters:

breakTime - Wait time in ms.

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.

getBreakTime

public int getBreakTime()

Returns the additional time which should be waited after iterating through all periods. Default is 0.

Returns:

Wait time in ms.

setPeriods

public void setPeriods(int[] periods)

Sets the periods. Setting it to null has no effect.

Parameters:

periods - the periods to set (in ms).

getPeriods

public int[] getPeriods()

Returns the periods.

Returns:

the periods to set (in ms).

clone

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

Overrides:

clone in class PeriodConfiguration

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 PeriodConfiguration

Throws:

ConfigurationException