org.youscope.common.job.basicjobs

Interface FocusingJob

All Superinterfaces:

Component, Job, java.rmi.Remote

public interface FocusingJob
extends Job

Author:

langmo

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	DEFAULT_TYPE_IDENTIFIER The type identifier of the default implementation of this job.

Method Summary

Modifier and Type	Method and Description
int	getFocusAdjustmentTime() Returns the focus adjustment time (the time the microscope is paused after the new focus position was set) in ms.
java.lang.String	getFocusDevice() Returns the focus device name for which the position should be changed.
double	getPosition() Gets the position/offset of the focus/autofocus device.
boolean	isRelative() Returns true if the offset is relative to the current offset, false otherwise.
void	setFocusAdjustmentTime(int adjustmentTime) Sets the focus adjustment time (the time the microscope is paused after the new focus position was set) in ms.
void	setFocusDevice(java.lang.String focusDevice) Sets the focus device name for which the position should be changed.
void	setPosition(double position, boolean relative) Sets the position the focus/autofocus should go to.

Methods inherited from interface org.youscope.common.job.Job

addJobListener, executeJob, initializeJob, removeJobListener, uninitializeJob

Methods inherited from interface org.youscope.common.Component

addMessageListener, getName, getPositionInformation, getUUID, removeMessageListener, setName

Field Detail

DEFAULT_TYPE_IDENTIFIER

static final java.lang.String DEFAULT_TYPE_IDENTIFIER

The type identifier of the default implementation of this job. Basic jobs are considered such essential to YouScope such that their interfaces are made part of the shared library. However, their implementation are not, and there might be several addons providing (different) implementations of this job. Most of these implementations, however, are specific for a given application and not general. The addon exposing this identifier should be general, that is, every other part of YouScope accessing this job over the default identifier is expecting the job to behave in the general way. Only one implementation (addon) should expose the default identifier. Typically, this implementation is already part of YouScope, such that implementing this addon is not necessary. However, there might be cases when the default implementation should be overwritten, which is why the interface, but not the implementation is part of YouScope's core elements. In this case, the default implementation already part of YouScope should be removed (i.e. the corresponding default plug-in deleted).

See Also:

Constant Field Values

Method Detail

getFocusAdjustmentTime

int getFocusAdjustmentTime()
                    throws java.rmi.RemoteException

Returns the focus adjustment time (the time the microscope is paused after the new focus position was set) in ms.

Returns:

Focus adjustment time.

Throws:

java.rmi.RemoteException

setFocusAdjustmentTime

void setFocusAdjustmentTime(int adjustmentTime)
                     throws java.rmi.RemoteException,
                            MeasurementRunningException

Sets the focus adjustment time (the time the microscope is paused after the new focus position was set) in ms.

Parameters:

adjustmentTime - Focus adjustment time.

Throws:

java.rmi.RemoteException

MeasurementRunningException

getPosition

double getPosition()
            throws java.rmi.RemoteException

Gets the position/offset of the focus/autofocus device.

Returns:

The offset.

Throws:

java.rmi.RemoteException

setPosition

void setPosition(double position,
                 boolean relative)
          throws java.rmi.RemoteException,
                 MeasurementRunningException

Sets the position the focus/autofocus should go to.

Parameters:

position - The position.

relative - True if position is relative to the current position, false if it is an absolute position.

Throws:

java.rmi.RemoteException

MeasurementRunningException

isRelative

boolean isRelative()
            throws java.rmi.RemoteException

Returns true if the offset is relative to the current offset, false otherwise.

Returns:

True if offset is relative.

Throws:

java.rmi.RemoteException

getFocusDevice

java.lang.String getFocusDevice()
                         throws java.rmi.RemoteException

Returns the focus device name for which the position should be changed.

Returns:

Focus device name, or null, if the currently active focus device should be changed.

Throws:

java.rmi.RemoteException

setFocusDevice

void setFocusDevice(java.lang.String focusDevice)
             throws java.rmi.RemoteException,
                    MeasurementRunningException

Sets the focus device name for which the position should be changed. Initialized to be null.

Parameters:

focusDevice - Focus device name, or null, if the currently active focus device should be changed.

Throws:

java.rmi.RemoteException

MeasurementRunningException