org.youscope.common.job.basicjobs

Interface ContinuousImagingJob

All Superinterfaces:

Component, ImageProducer, Job, java.rmi.Remote

public interface ContinuousImagingJob
extends Job, ImageProducer

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
java.lang.String	getCamera() Returns the name of the camera with which it is imaged.
java.lang.String[]	getCameras() Gets the cameras.
java.lang.String	getChannel() Gets the channel.
java.lang.String	getChannelGroup() Gets the channel group.
double	getExposure() Gets the exposure.
double[]	getExposures() Gets the exposures of the initialized cameras.
boolean	isBurstImaging() Returns if the imaging is done in burst mode.
void	setBurstImaging(boolean burst) Sets if the images are produced in burst mode.
void	setCamera(java.lang.String camera) Sets the camera with which it should be imaged.
void	setCameras(java.lang.String[] cameras) Sets the cameras with which it should be imaged.
void	setChannel(java.lang.String deviceGroup, java.lang.String channel) Sets the channel.
void	setExposure(double exposure) Sets the exposure.
void	setExposures(double[] exposures) Sets the exposures of the cameras.
void	setImageDescription(java.lang.String description) Sets a short string describing the images which are made by this job.

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

Methods inherited from interface org.youscope.common.image.ImageProducer

addImageListener, getImageDescription, getNumberOfImages, removeImageListener

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

setChannel

void setChannel(java.lang.String deviceGroup,
                java.lang.String channel)
         throws java.rmi.RemoteException,
                MeasurementRunningException

Sets the channel.

Parameters:

deviceGroup - The device group where the channel is defined.

channel - The channel.

Throws:

java.rmi.RemoteException

MeasurementRunningException

getChannel

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

Gets the channel.

Returns:

The channel.

Throws:

java.rmi.RemoteException

getChannelGroup

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

Gets the channel group.

Returns:

The channel group.

Throws:

java.rmi.RemoteException

setExposure

void setExposure(double exposure)
          throws java.rmi.RemoteException,
                 MeasurementRunningException

Sets the exposure. If more than one camera is initialized, it sets the exposure of all cameras. Set to -1 if exposure should not be set.

Parameters:

exposure - The exposure.

Throws:

java.rmi.RemoteException

MeasurementRunningException

getExposure

double getExposure()
            throws java.rmi.RemoteException

Gets the exposure. If more than one camera is initialized, returns the exposure of the first camera.

Returns:

The exposure.

Throws:

java.rmi.RemoteException

setExposures

void setExposures(double[] exposures)
           throws java.rmi.RemoteException,
                  MeasurementRunningException,
                  java.lang.IllegalArgumentException

Sets the exposures of the cameras. Should have the same size as cameras, otherwise an exception is thrown. Each element can be set to -1 to not set the exposure for the given camera.

Parameters:

exposures - The exposures.

Throws:

java.rmi.RemoteException

MeasurementRunningException

java.lang.IllegalArgumentException - Thrown if number of elements in exposure array is unequal to the number of cameras.

getExposures

double[] getExposures()
               throws java.rmi.RemoteException

Gets the exposures of the initialized cameras.

Returns:

The exposures.

Throws:

java.rmi.RemoteException

setImageDescription

void setImageDescription(java.lang.String description)
                  throws java.rmi.RemoteException,
                         MeasurementRunningException

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

Parameters:

description - The description which should be returned for the images produced by this job, or null, to switch to the default description.

Throws:

java.rmi.RemoteException

MeasurementRunningException

setCameras

void setCameras(java.lang.String[] cameras)
         throws java.rmi.RemoteException,
                MeasurementRunningException

Sets the cameras with which it should be imaged. If set to null, the default (currently initialized) camera is used. Each camera should only appear ones in the array. One element of the array can be NULL, such that the default camera is used.

Parameters:

cameras - Device names of the cameras

Throws:

java.rmi.RemoteException

MeasurementRunningException

setCamera

void setCamera(java.lang.String camera)
        throws java.rmi.RemoteException,
               MeasurementRunningException

Sets the camera with which it should be imaged. If set to null, the default (currently initialized) camera is used.

Parameters:

camera - Device name of the camera, or null to use default camera.

Throws:

java.rmi.RemoteException

MeasurementRunningException

getCameras

java.lang.String[] getCameras()
                       throws java.rmi.RemoteException

Gets the cameras.

Returns:

The cameras.

Throws:

java.rmi.RemoteException

getCamera

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

Returns the name of the camera with which it is imaged. Might return null if the default camera is used. If more than one camera is used, returns the first camera.

Returns:

The cameras.

Throws:

java.rmi.RemoteException

isBurstImaging

boolean isBurstImaging()
                throws java.rmi.RemoteException

Returns if the imaging is done in burst mode. This corresponds to that the job queries for all images in the image buffer, not only for the newest one, every time it is executed.

Returns:

True if in burst mode, false otherwise.

Throws:

java.rmi.RemoteException

setBurstImaging

void setBurstImaging(boolean burst)
              throws java.rmi.RemoteException,
                     MeasurementRunningException

Sets if the images are produced in burst mode. This corresponds to that the job queries for all images in the image buffer, not only for the newest one, every time it is executed. Default is false.

Parameters:

burst - True if burst imaging should be activated, false if not.

Throws:

java.rmi.RemoteException

MeasurementRunningException