org.youscope.common.measurement

Interface Measurement

All Superinterfaces:

Component, java.rmi.Remote

public interface Measurement
extends Component

Represents a measurement a microscope should do.

Author:

Moritz Lang

Method Summary

Modifier and Type	Method and Description
void	addFinishDeviceSetting(DeviceSetting setting) Adds a device settings which should be applied (once) the measurement ends.
void	addMeasurementListener(MeasurementListener listener) Adds a listener which is notified about the state of the measurement.
MeasurementTask	addMultiplePeriodTask(int[] periods, int breakTime, int startTime) Adds a new task to the measurement so that at times {startTime, startTime + periods[0], startTime + periods[0] + periods[1], ..., startTime + sum_{i=0:size-2}(periods[i]), startTime + sum_{i=0:size-1}(periods[i]) + breakTime, startTime + sum_{i=0:size-1}(periods[i]) + breakTime + periods[0]} the jobs of the task will be executed.
MeasurementTask	addMultiplePeriodTask(int[] periods, int breakTime, int startTime, int numExecutions) Adds a new task to the measurement so that at times {startTime, startTime + periods[0], startTime + periods[0] + periods[1], ..., startTime + sum_{i=0:size-2}(periods[i]), startTime + sum_{i=0:size-1}(periods[i]) + breakTime, startTime + sum_{i=0:size-1}(periods[i]) + breakTime + periods[0]} the jobs of the task will be executed.
void	addStartupDeviceSetting(DeviceSetting setting) Adds a device setting which should be applied (once) the measurement starts.
MeasurementTask	addTask(int period, boolean fixedTimes, int startTime) Adds a new task to the measurement so that at times ( + i * ) ms, i = 0,1,2,..., the jobs of the task will be executed.
MeasurementTask	addTask(int period, boolean fixedTimes, int startTime, int numExecutions) Adds a new task to the measurement so that at times ( + i * ) ms, i = 0,1,2,..., the jobs of the task will be executed.
java.util.Date	getEndTime() Returns the time when the last execution of this measurement stopped regularly, or null, if it did not yet stop regularly.
int	getRuntime() Returns the runtime of the measurement.
MeasurementSaver	getSaver() Returns an interface which defines how (and if) the measurement should be saved.
java.util.Date	getStartTime() Returns the time when the last execution of this measurement started, or null, if it did not yet start.
MeasurementState	getState() Returns the current state of the measurement.
MeasurementTask[]	getTasks() Returns a list of all tasks of this measurement.
java.lang.String	getTypeIdentifier() Returns a previously defined type identifier.
void	interruptMeasurement() Interrupts the execution of the measurement.
boolean	isLockMicroscopeWhileRunning() Returns if write access to the microscope is locked during the measurement.
boolean	isRunning() Returns if measurement is currently running or not.
void	quickStopMeasurement() Stops the execution of the measurement after all queued jobs were finished.
void	removeMeasurementListener(MeasurementListener listener) Removes a previously added listener.
void	setFinishDeviceSettings(DeviceSetting[] settings) Sets the device settings which should be applied (once) the measurement ends.
void	setInitialMeasurementContextProperty(java.lang.String identifier, java.io.Serializable property) Sets a measurement context property.
void	setLockMicroscopeWhileRunning(boolean lock) Sets if write access to the microscope is locked during the measurement.
void	setRuntime(int measurementRuntime) Sets the runtime of the measurement.
void	setStartupDeviceSettings(DeviceSetting[] settings) Sets the device settings which should be applied (once) the measurement starts.
void	setTypeIdentifier(java.lang.String type) Sets an identifier for the type of this measurement.
void	startMeasurement() Starts the execution of the measurement.
void	stopMeasurement() Stops the execution of the measurement after all queued jobs were finished.
void	waitForMeasurementFinish() Stops the execution of the calling thread until the measurement is finished.

Methods inherited from interface org.youscope.common.Component

addMessageListener, getName, getPositionInformation, getUUID, removeMessageListener, setName

Method Detail

isRunning

boolean isRunning()
           throws java.rmi.RemoteException

Returns if measurement is currently running or not.

Returns:

True if measurement is running, false otherwise.

Throws:

java.rmi.RemoteException

quickStopMeasurement

void quickStopMeasurement()
                   throws java.rmi.RemoteException

Stops the execution of the measurement after all queued jobs were finished. Note: If measurement is queued, it gets disabled but not un-queued.

Throws:

java.rmi.RemoteException

setInitialMeasurementContextProperty

void setInitialMeasurementContextProperty(java.lang.String identifier,
                                          java.io.Serializable property)
                                   throws java.rmi.RemoteException

Sets a measurement context property. The measurement context of the measurement will be initialized upon measurement initialization to already contain this context property. A measurement context property can be loaded and overwritten by any other measurement component in the measurement. Any property with the same identifier will be replaced.

Parameters:

identifier - a short identifier for the property.

property - The property which should be saved.

Throws:

java.rmi.RemoteException

getState

MeasurementState getState()
                   throws java.rmi.RemoteException

Returns the current state of the measurement.

Returns:

Current state.

Throws:

java.rmi.RemoteException

startMeasurement

void startMeasurement()
               throws java.rmi.RemoteException

Starts the execution of the measurement. Note: If other measurements are already running, the measurement gets queued.

Throws:

java.rmi.RemoteException

stopMeasurement

void stopMeasurement()
              throws java.rmi.RemoteException

Stops the execution of the measurement after all queued jobs were finished. Note: If measurement is queued, it gets disabled but not un-queued.

Throws:

java.rmi.RemoteException

waitForMeasurementFinish

void waitForMeasurementFinish()
                       throws java.rmi.RemoteException

Stops the execution of the calling thread until the measurement is finished.

Throws:

java.rmi.RemoteException

interruptMeasurement

void interruptMeasurement()
                   throws java.rmi.RemoteException

Interrupts the execution of the measurement. All queued jobs are discarded.

Throws:

java.rmi.RemoteException

addMeasurementListener

void addMeasurementListener(MeasurementListener listener)
                     throws java.rmi.RemoteException

Adds a listener which is notified about the state of the measurement.

Parameters:

listener - Listener which should be notified.

Throws:

java.rmi.RemoteException

removeMeasurementListener

void removeMeasurementListener(MeasurementListener listener)
                        throws java.rmi.RemoteException

Removes a previously added listener.

Parameters:

listener - The listener to remove.

Throws:

java.rmi.RemoteException

setRuntime

void setRuntime(int measurementRuntime)
         throws java.rmi.RemoteException,
                MeasurementRunningException

Sets the runtime of the measurement.

Parameters:

measurementRuntime - Runtime of the measurement in milliseconds. Set to -1 for an infinite runtime.

Throws:

java.rmi.RemoteException

MeasurementRunningException

getRuntime

int getRuntime()
        throws java.rmi.RemoteException

Returns the runtime of the measurement.

Returns:

Runtime of the measurement. A value of -1 corresponds to an infinite runtime.

Throws:

java.rmi.RemoteException

getStartTime

java.util.Date getStartTime()
                     throws java.rmi.RemoteException

Returns the time when the last execution of this measurement started, or null, if it did not yet start.

Returns:

Last measurement start time.

Throws:

java.rmi.RemoteException

getEndTime

java.util.Date getEndTime()
                   throws java.rmi.RemoteException

Returns the time when the last execution of this measurement stopped regularly, or null, if it did not yet stop regularly.

Returns:

Last measurement stop time.

Throws:

java.rmi.RemoteException

setLockMicroscopeWhileRunning

void setLockMicroscopeWhileRunning(boolean lock)
                            throws java.rmi.RemoteException,
                                   MeasurementRunningException

Sets if write access to the microscope is locked during the measurement.

Parameters:

lock - True if should be locked.

Throws:

java.rmi.RemoteException

MeasurementRunningException

isLockMicroscopeWhileRunning

boolean isLockMicroscopeWhileRunning()
                              throws java.rmi.RemoteException

Returns if write access to the microscope is locked during the measurement.

Returns:

True if write access is locked.

Throws:

java.rmi.RemoteException

setTypeIdentifier

void setTypeIdentifier(java.lang.String type)
                throws java.rmi.RemoteException,
                       MeasurementRunningException

Sets an identifier for the type of this measurement. This identifier is usually the same as the one of the configuration.

Parameters:

type - Type identifier.

Throws:

java.rmi.RemoteException

MeasurementRunningException

getTypeIdentifier

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

Returns a previously defined type identifier.

Returns:

Type identifier.

Throws:

java.rmi.RemoteException

getSaver

MeasurementSaver getSaver()
                   throws java.rmi.RemoteException

Returns an interface which defines how (and if) the measurement should be saved.

Returns:

Interface to measurement save options.

Throws:

java.rmi.RemoteException

addTask

MeasurementTask addTask(int period,
                        boolean fixedTimes,
                        int startTime)
                 throws java.rmi.RemoteException,
                        MeasurementRunningException

Adds a new task to the measurement so that at times ( + i * ) ms, i = 0,1,2,..., the jobs of the task will be executed. Same as addTask(period, fixedTimes, startTime, -1).

Parameters:

period - Time between single executions (in milliseconds).

fixedTimes - TRUE if jobs should be done at fixed time intervals, FALSE if job may be delayed if microscope runs slow.

startTime - The time when the jobs are started first (in ms).

Returns:

The newly created task. If not successful, NULL is returned.

Throws:

java.rmi.RemoteException

MeasurementRunningException

addTask

MeasurementTask addTask(int period,
                        boolean fixedTimes,
                        int startTime,
                        int numExecutions)
                 throws java.rmi.RemoteException,
                        MeasurementRunningException

Adds a new task to the measurement so that at times ( + i * ) ms, i = 0,1,2,..., the jobs of the task will be executed. After executions of the task, the task won't be scheduled anymore

Parameters:

period - Time between single executions (in milliseconds).

fixedTimes - TRUE if jobs should be done at fixed time intervals, FALSE if job may be delayed if microscope runs slow.

startTime - The time when the jobs are started first (in ms).

numExecutions - Maximal number of executions. -1 for an infinite amount.

Returns:

The newly created task. If not successful, NULL is returned.

Throws:

java.rmi.RemoteException

MeasurementRunningException

addMultiplePeriodTask

MeasurementTask addMultiplePeriodTask(int[] periods,
                                      int breakTime,
                                      int startTime)
                               throws java.rmi.RemoteException,
                                      MeasurementRunningException

Adds a new task to the measurement so that at times {startTime, startTime + periods[0], startTime + periods[0] + periods[1], ..., startTime + sum_{i=0:size-2}(periods[i]), startTime + sum_{i=0:size-1}(periods[i]) + breakTime, startTime + sum_{i=0:size-1}(periods[i]) + breakTime + periods[0]} the jobs of the task will be executed. Same as addMultiplePeriodTask(periods, breakTime, startTime, -1).

Parameters:

periods - Times between single executions (in milliseconds).

breakTime - After all periods are run through, the job will pause for ms and then start with periods[0] again.

startTime - The time when the jobs should be started first (in ms).

Returns:

The newly created task. If not successful, NULL is returned.

Throws:

java.rmi.RemoteException

MeasurementRunningException

addMultiplePeriodTask

MeasurementTask addMultiplePeriodTask(int[] periods,
                                      int breakTime,
                                      int startTime,
                                      int numExecutions)
                               throws java.rmi.RemoteException,
                                      MeasurementRunningException

Adds a new task to the measurement so that at times {startTime, startTime + periods[0], startTime + periods[0] + periods[1], ..., startTime + sum_{i=0:size-2}(periods[i]), startTime + sum_{i=0:size-1}(periods[i]) + breakTime, startTime + sum_{i=0:size-1}(periods[i]) + breakTime + periods[0]} the jobs of the task will be executed.

Parameters:

periods - Times between single executions (in milliseconds).

breakTime - After all periods are run through, the job will pause for ms and then start with periods[0] again.

startTime - The time when the jobs should be started first (in ms).

numExecutions - Maximal number of executions. -1 for an infinite amount.

Returns:

The newly created task. If not successful, NULL is returned.

Throws:

java.rmi.RemoteException

MeasurementRunningException

getTasks

MeasurementTask[] getTasks()
                    throws java.rmi.RemoteException

Returns a list of all tasks of this measurement.

Returns:

List of tasks.

Throws:

java.rmi.RemoteException

setStartupDeviceSettings

void setStartupDeviceSettings(DeviceSetting[] settings)
                       throws java.rmi.RemoteException,
                              MeasurementRunningException

Sets the device settings which should be applied (once) the measurement starts.

Parameters:

settings - The device settings which should be applied.

Throws:

java.rmi.RemoteException

MeasurementRunningException

setFinishDeviceSettings

void setFinishDeviceSettings(DeviceSetting[] settings)
                      throws java.rmi.RemoteException,
                             MeasurementRunningException

Sets the device settings which should be applied (once) the measurement ends.

Parameters:

settings - The device settings which should be applied.

Throws:

java.rmi.RemoteException

MeasurementRunningException

addStartupDeviceSetting

void addStartupDeviceSetting(DeviceSetting setting)
                      throws java.rmi.RemoteException,
                             MeasurementRunningException

Adds a device setting which should be applied (once) the measurement starts.

Parameters:

setting - The device settings which should be added.

Throws:

java.rmi.RemoteException

MeasurementRunningException

addFinishDeviceSetting

void addFinishDeviceSetting(DeviceSetting setting)
                     throws java.rmi.RemoteException,
                            MeasurementRunningException

Adds a device settings which should be applied (once) the measurement ends.

Parameters:

setting - The device settings which should be added.

Throws:

java.rmi.RemoteException

MeasurementRunningException