org.youscope.common.scripting

Interface ScriptImageStorage

All Superinterfaces:

java.rmi.Remote

public interface ScriptImageStorage
extends java.rmi.Remote

Author:

langmo

Method Summary

Modifier and Type	Method and Description
int	getLastImageBitDepth() Gets bit depth of last image.
int	getLastImageBytesPerPixel() Returns how many bytes correspond to one pixel.
java.lang.String	getLastImageCoding() Returns a string describing the data type to which the result of getLastImagePixels() has to be converted.
int	getLastImageHeight() Gets the heigt of the last image.
java.lang.Object	getLastImagePixels() Returns the pixels of the last image made.
int	getLastImageWidth() Gets the width of the last image.
java.lang.Object	getNewImagePixels(int timeout) Waits for new image data to arrive and returns the pixels of the newly arrived image.

Method Detail

getLastImagePixels

java.lang.Object getLastImagePixels()
                             throws java.rmi.RemoteException

Returns the pixels of the last image made.

Returns:

pixels of image.

Throws:

java.rmi.RemoteException

getNewImagePixels

java.lang.Object getNewImagePixels(int timeout)
                            throws java.rmi.RemoteException

Waits for new image data to arrive and returns the pixels of the newly arrived image. Makes only sense if job was started asynchrony.

Parameters:

timeout - Maximal time in ms to wait.

Returns:

pixels of image.

Throws:

java.rmi.RemoteException

getLastImageWidth

int getLastImageWidth()
               throws java.rmi.RemoteException

Gets the width of the last image.

Returns:

Width of image.

Throws:

java.rmi.RemoteException

getLastImageHeight

int getLastImageHeight()
                throws java.rmi.RemoteException

Gets the heigt of the last image.

Returns:

Height of image.

Throws:

java.rmi.RemoteException

getLastImageBitDepth

int getLastImageBitDepth()
                  throws java.rmi.RemoteException

Gets bit depth of last image.

Returns:

Bit depth.

Throws:

java.rmi.RemoteException

getLastImageBytesPerPixel

int getLastImageBytesPerPixel()
                       throws java.rmi.RemoteException

Returns how many bytes correspond to one pixel. Thus, gives - together with getLastImageCoding() - information on to which data type the result of getLastImagePixels() has to be converted.

Returns:

Bytes per pixel.

Throws:

java.rmi.RemoteException

getLastImageCoding

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

Returns a string describing the data type to which the result of getLastImagePixels() has to be converted.

Returns:

Data type of pixels.

Throws:

java.rmi.RemoteException