org.youscope.common.scripting

Interface ScriptInterface

All Superinterfaces:

java.rmi.Remote

public interface ScriptInterface
extends java.rmi.Remote

Author:

langmo

Method Summary

Modifier and Type	Method and Description
ScriptImageStorage	createImageStorage(ImageProducer job) Creates a new storage class which stores images from an imaging job such that the script can get the image data.
ScriptingJob	getScriptingJob() Returns the currently executed scripting job.
void	println(java.lang.String text) Prints the string in the client console.
void	startJob(Job job) Starts the measurement job.

Method Detail

startJob

void startJob(Job job)
       throws java.rmi.RemoteException,
              MicroscopeScriptException

Starts the measurement job.

Parameters:

job - Job to start.

Throws:

java.rmi.RemoteException

MicroscopeScriptException

println

void println(java.lang.String text)
      throws java.rmi.RemoteException

Prints the string in the client console.

Parameters:

text - Text to print.

Throws:

java.rmi.RemoteException

createImageStorage

ScriptImageStorage createImageStorage(ImageProducer job)
                               throws java.rmi.RemoteException

Creates a new storage class which stores images from an imaging job such that the script can get the image data.

Parameters:

job - The image producing job.

Returns:

Image storage class.

Throws:

java.rmi.RemoteException

getScriptingJob

ScriptingJob getScriptingJob()
                      throws java.rmi.RemoteException

Returns the currently executed scripting job.

Returns:

Currently executed scripting job.

Throws:

java.rmi.RemoteException