org.youscope.plugin.oscillatinginput

Class OscillatingDeviceJobConfiguration

java.lang.Object

org.youscope.common.job.JobConfiguration

org.youscope.plugin.oscillatinginput.OscillatingDeviceJobConfiguration

All Implemented Interfaces:

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

public class OscillatingDeviceJobConfiguration
extends JobConfiguration

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

Method Summary

Modifier and Type	Method and Description
java.lang.Object	clone()
java.lang.String	getDescription() Returns a short description of this job.
java.lang.String	getDevice()
double	getInitialPhase() Returns the initial phase of the oscillations in rad.
double	getMaxValue()
double	getMinValue()
int	getPeriodLength()
java.lang.String	getProperty()
java.lang.String	getTypeIdentifier() Returns a unique identifier for this configuration type.
void	setDevice(java.lang.String device)
void	setInitialPhase(double initialPhase) Sets the initial phase of the oscillations in rad.
void	setMaxValue(double maxValue)
void	setMinValue(double minValue)
void	setPeriodLength(int periodLength) Sets the period length in seconds.
void	setProperty(java.lang.String property)

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

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

OscillatingDeviceJobConfiguration

public OscillatingDeviceJobConfiguration()

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.

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.

setDevice

public void setDevice(java.lang.String device)

Parameters:

device - the device which owns a property which should oscillate.

getDevice

public java.lang.String getDevice()

Returns:

the device which owns a property which should oscillate.

setProperty

public void setProperty(java.lang.String property)

Parameters:

property - the property which should oscillate.

getProperty

public java.lang.String getProperty()

Returns:

the property which should oscillate.

setMaxValue

public void setMaxValue(double maxValue)

Parameters:

maxValue - the maximal value the property should be during oscillations.

getMaxValue

public double getMaxValue()

Returns:

the maximal value the property should be during oscillations.

setMinValue

public void setMinValue(double minValue)

Parameters:

minValue - the minimal value the property should be during oscillations.

getMinValue

public double getMinValue()

Returns:

the minimal value the property should be during oscillations.

setPeriodLength

public void setPeriodLength(int periodLength)

Sets the period length in seconds.

Parameters:

periodLength - Period length in seconds.

getPeriodLength

public int getPeriodLength()

Returns:

Period length in seconds.

setInitialPhase

public void setInitialPhase(double initialPhase)

Sets the initial phase of the oscillations in rad.

Parameters:

initialPhase - Initial phase in rad.

getInitialPhase

public double getInitialPhase()

Returns the initial phase of the oscillations in rad.

Returns:

Initial phase in rad.

clone

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

Overrides:

clone in class JobConfiguration

Throws:

java.lang.CloneNotSupportedException