org.youscope.common.job

Interface Job

All Superinterfaces:

Component, java.rmi.Remote

All Known Subinterfaces:

AutoFocusJob, CellDetectionJob, ChangePositionJob, ComposedImagingJob, CompositeJob, ContinuousImagingJob, ControllerJob, CustomJob, DeviceSettingJob, DropletMicrofluidicJob, FluigentJob, FocusingJob, ImagingJob, LiveModifiableJob, NemesysJob, OnixJob, OutOfFocusJob, PlateScanningJob, RepeatJob, ScriptingJob, ShortContinuousImagingJob, SlimJob, StaggeringJob, StatisticsJob, WaitForUserJob, WaitJob

All Known Implementing Classes:

EditableJobContainerAdapter, JobAdapter

public interface Job
extends Component

Base class of all jobs.

Author:

Moritz Lang

Method Summary

Modifier and Type	Method and Description
void	addJobListener(JobListener listener) Adds a listener which should e.g.
void	executeJob(ExecutionInformation executionInformation, Microscope microscope, MeasurementContext measurementContext) Function which is called at every evaluation of the job.
void	initializeJob(Microscope microscope, MeasurementContext measurementContext) Called before the first evaluation of a job in a measurement.
void	removeJobListener(JobListener listener) Removes a previously added listener.
void	uninitializeJob(Microscope microscope, MeasurementContext measurementContext) Called before the first evaluation of a job in a measurement.

Methods inherited from interface org.youscope.common.Component

addMessageListener, getName, getPositionInformation, getUUID, removeMessageListener, setName

Method Detail

addJobListener

void addJobListener(JobListener listener)
             throws java.rmi.RemoteException

Adds a listener which should e.g. be invoked after each evaluation of the job (at the end of the implementation of runJob().

Parameters:

listener - The listener to add.

Throws:

java.rmi.RemoteException

removeJobListener

void removeJobListener(JobListener listener)
                throws java.rmi.RemoteException

Removes a previously added listener.

Parameters:

listener - The listener to be removed.

Throws:

java.rmi.RemoteException

executeJob

void executeJob(ExecutionInformation executionInformation,
                Microscope microscope,
                MeasurementContext measurementContext)
         throws JobException,
                java.lang.InterruptedException,
                java.rmi.RemoteException

Function which is called at every evaluation of the job. If this job contains child jobs, it is responsible to call their respective executeJob() methods. Should not be called directly by client applications.

Parameters:

executionInformation - Information about how many times the job has been executed, and if it is executed in a loop.

microscope - Interface to control and get information of the microscope.

measurementContext - the context of the measurement, allowing to transfer data between measurement components and similar.

Throws:

JobException

java.lang.InterruptedException

java.rmi.RemoteException

initializeJob

void initializeJob(Microscope microscope,
                   MeasurementContext measurementContext)
            throws JobException,
                   java.lang.InterruptedException,
                   java.rmi.RemoteException

Called before the first evaluation of a job in a measurement. If this job contains child jobs, it is responsible to call their respective initializeJob() methods. Should not be called directly by client applications.

Parameters:

microscope - Interface to control and get information of the microscope.

measurementContext - the context of the measurement, allowing to transfer data between measurement components and similar.

Throws:

JobException

java.lang.InterruptedException

java.rmi.RemoteException

uninitializeJob

void uninitializeJob(Microscope microscope,
                     MeasurementContext measurementContext)
              throws JobException,
                     java.lang.InterruptedException,
                     java.rmi.RemoteException

Called before the first evaluation of a job in a measurement. If this job contains child jobs, it is responsible to call their respective uninitializeJob() methods. Should not be called directly by client applications. There is no guarantee that this method is called. Usually it is called when the measurement stops regularly, e.g. by timing out or when the user invokes "stop measurement". However, it is not invoked if the measurement is interrupted or similar.

Parameters:

microscope - Interface to control and get information of the microscope.

measurementContext - the context of the measurement, allowing to transfer data between measurement components and similar.

Throws:

JobException

java.lang.InterruptedException

java.rmi.RemoteException