org.youscope.common.image

Interface ImageProducer

All Superinterfaces:

java.rmi.Remote

All Known Subinterfaces:

AutoFocusJob, CellDetectionJob, ComposedImagingJob, ContinuousImagingJob, ImagingJob, OutOfFocusJob, ShortContinuousImagingJob, SlimJob

public interface ImageProducer
extends java.rmi.Remote

Indicates that a given job produces images, and allows to add a listener to obtain produced images.

Author:

langmo

Method Summary

Modifier and Type	Method and Description
void	addImageListener(ImageListener listener) Adds a listener which is invoked if the camera of the microscope made a new picture.
java.lang.String	getImageDescription() Returns a short string describing the images which are made by this job.
int	getNumberOfImages() Returns the number of images which get produced per evaluation of the respective job.
void	removeImageListener(ImageListener listener) Removes a previously added image listener.

Method Detail

addImageListener

void addImageListener(ImageListener listener)
               throws java.rmi.RemoteException

Adds a listener which is invoked if the camera of the microscope made a new picture. A listener can always be added, even if the respective measurement is already running.

Parameters:

listener - Listener which detects new pictures.

Throws:

java.rmi.RemoteException

removeImageListener

void removeImageListener(ImageListener listener)
                  throws java.rmi.RemoteException

Removes a previously added image listener.

Parameters:

listener - Listener which was previously added.

Throws:

java.rmi.RemoteException

getImageDescription

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

Returns a short string describing the images which are made by this job.

Returns:

Description of the image.

Throws:

java.rmi.RemoteException

getNumberOfImages

int getNumberOfImages()
               throws java.rmi.RemoteException

Returns the number of images which get produced per evaluation of the respective job. Typically, this is one. However, some jobs can produce more than one image, and the number of the produced images may or may not depend on the configuration. Some jobs might even produce no images at all for certain configurations (but usually for other configurations they produce images, otherwise this interface would not make sense to implement).

Returns:

Number of produced images. Zero indicate that no images are produced by this job type at all. Negative numbers indicate that the number of images is not known, or that it might even vary.

Throws:

java.rmi.RemoteException