org.youscope.common.task

Class RegularPeriodConfiguration

java.lang.Object

org.youscope.common.task.PeriodConfiguration

org.youscope.common.task.RegularPeriodConfiguration

All Implemented Interfaces:

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

public class RegularPeriodConfiguration
extends PeriodConfiguration

Configurations of how often and when a task should be executed. The task is executed, after an initial delay, regularly every getPeriod() ms. However, this period can be measured in two ways: (i) The period should be as precisely as possible, such that the duration between two executions of the jobs of the same task has mean getPeriod() and minimal variance. Or, (ii), the period can be measured between the end of the execution of the last job of the task in the previous iteration, and the beginning of the execution of the first task of the next execution. The latter allows to define periods way smaller than the microscope is able to execute the jobs of the task, effectively implementing tasks which execute as fast as possible, or tasks which execution times can be delayed if the microscope is occupied with tasks which cannot be delayed.

Author:

Moritz Lang

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
RegularPeriodConfiguration()

Method Summary

Modifier and Type	Method and Description
void	checkConfiguration() Checks the current state of the configuration.
java.lang.Object	clone()
int	getPeriod()
java.lang.String	getTypeIdentifier() Returns a unique identifier for this configuration type.
boolean	isFixedTimes()
void	setFixedTimes(boolean fixedTimes)
void	setPeriod(int period)

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

RegularPeriodConfiguration

public RegularPeriodConfiguration()

Method Detail

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.

setFixedTimes

public void setFixedTimes(boolean fixedTimes)

Parameters:

fixedTimes - the fixedTimes to set

isFixedTimes

public boolean isFixedTimes()

Returns:

the fixedTimes

setPeriod

public void setPeriod(int period)

Parameters:

period - the period to set

getPeriod

public int getPeriod()

Returns:

the period

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