org.youscope.serverinterfaces

Interface MeasurementProvider

All Superinterfaces:

java.rmi.Remote

public interface MeasurementProvider
extends java.rmi.Remote

A class being able to construct new measurements.

Author:

Moritz Lang

See Also:

Measurement

Method Summary

Modifier and Type	Method and Description
Measurement	createContinuousMeasurement(java.lang.String cameraID, java.lang.String channelGroup, java.lang.String channel, int imagingPeriod, double exposure, ImageListener imageListener) Convenience function to create a measurement, in which every imagingPeriod ms an image is made in the given channel with the given period, using the default camera.
Measurement	createMeasurement() Creates a new empty measurement.
Measurement	createMeasurement(int measurementRuntime) Creates a new empty measurement.
Measurement	createMeasurement(MeasurementConfiguration configuration) Creates a new measurement from the configuration.
Measurement	createMeasurement(MeasurementConfiguration configuration, CallbackProvider callbackProvider) Creates a new measurement from the configuration.

Method Detail

createMeasurement

Measurement createMeasurement()
                       throws java.rmi.RemoteException

Creates a new empty measurement. Same as createMeasurement(int)(-1).

Returns:

The created measurement.

Throws:

java.rmi.RemoteException

createMeasurement

Measurement createMeasurement(int measurementRuntime)
                       throws java.rmi.RemoteException

Creates a new empty measurement.

Parameters:

measurementRuntime - Runtime of measurement in milliseconds. After this time the measurement will be automatically stopped. Set to -1 for unlimited runtime.

Returns:

The measurement object.

Throws:

java.rmi.RemoteException

createMeasurement

Measurement createMeasurement(MeasurementConfiguration configuration)
                       throws java.rmi.RemoteException,
                              ConfigurationException,
                              ComponentCreationException

Creates a new measurement from the configuration. Same as createMeasurement(MeasurementConfiguration, CallbackProvider)(configuration, null).

Parameters:

configuration - The configuration of the measurement.

Returns:

The newly created measurement.

Throws:

java.rmi.RemoteException

ConfigurationException - Thrown if configuration is invalid.

ComponentCreationException - Thrown if an error occurred in the creation of the components (e.g. jobs) belonging to the measurement.

createMeasurement

Measurement createMeasurement(MeasurementConfiguration configuration,
                              CallbackProvider callbackProvider)
                       throws java.rmi.RemoteException,
                              ConfigurationException,
                              ComponentCreationException

Creates a new measurement from the configuration.

Parameters:

configuration - The configuration of the measurement.

callbackProvider - Provider of callbacks, with which the measurement can send messages to the client, e.g. to prompt the client to graphically display the state of the measurement, or even to manipulate the measurement at runtime.

Returns:

The newly created measurement.

Throws:

java.rmi.RemoteException

ConfigurationException - Thrown if configuration is invalid.

ComponentCreationException - Thrown if an error occurred in the creation of the components (e.g. jobs) belonging to the measurement.

createContinuousMeasurement

Measurement createContinuousMeasurement(java.lang.String cameraID,
                                        java.lang.String channelGroup,
                                        java.lang.String channel,
                                        int imagingPeriod,
                                        double exposure,
                                        ImageListener imageListener)
                                 throws java.rmi.RemoteException,
                                        ComponentCreationException

Convenience function to create a measurement, in which every imagingPeriod ms an image is made in the given channel with the given period, using the default camera. The images made are not saved automatically, but intended to be displayed to the user. Internally, this is done by creating an empty measurement and adding a ContinuousImagingJob with the respective settings to it. This function mainly servers the propose of displaying the current microscope image in a client, a functionality which is so often needed such that a default implementation seemed necessary.

Parameters:

cameraID - The device name of the camera with which it should be imaged. Set to null to use standard camera.

channelGroup - The channel group where the channel is defined.

channel - The channel in which the images should be made.

imagingPeriod - The time between two successive images.

exposure - The exposure time for imaging.

imageListener - Listener to which the images made by the microscope are send.

Returns:

The newly created measurement.

Throws:

java.rmi.RemoteException

ComponentCreationException - Thrown if an error occurred in the creation of the components (e.g. jobs) belonging to the measurement.