org.lsst.ccs.drivers.reb

Interface ImageClient.Impl

All Known Implementing Classes:

Daq0Client.Images, Daq1Client.Images, Daq2Client.Images, ImageClientDaq1Simulation, PciClient.Images

Enclosing class:

ImageClient

public static interface ImageClient.Impl

Inner interface to support choosing the hardware.

Method Summary

Modifier and Type	Method and Description
void	deleteImageClient() Deletes an object.
default void	deleteImageMetadataRef(Image image) Deletes an image's metadata reference.
boolean	getImage(Image image) Reads an image.
default void	interrupt() Interrupts an image wait.
void	newImageClient(int id, String ifc) Creates a new object.
default void	reset() Resets the front end system.
Image	waitForImage(Image image) Awaits an image.

Method Detail

newImageClient

void newImageClient(int id,
                    String ifc)
             throws REBException

Creates a new object. Creates needed C++ objects.

Parameters:

id - The ID of the REB to connect to

ifc - The name of the partition or interface to use. If null or empty, the default is used if available.

Throws:

REBException

deleteImageClient

void deleteImageClient()

Deletes an object. Deletes referenced C++ objects.

waitForImage

Image waitForImage(Image image)

Awaits an image. Waits until a new image has been generated.

Parameters:

image - An Image object in which to save the reference and metadata for the new image, or null if a new image object is to be created.

Returns:

The Image object containing the new image reference and metadata.

getImage

boolean getImage(Image image)

Reads an image. Gets the pixel data for an image.

Parameters:

image - The Image object containing the valid metadata for an image. If the contained pixel data byte array is not null and is large enough, the pixel data us stored there. Otherwise a new array is created.

Returns:

True if the pixel data was successfully read, false otherwise.

interrupt

default void interrupt()

Interrupts an image wait.

reset

default void reset()

Resets the front end system.

deleteImageMetadataRef

default void deleteImageMetadataRef(Image image)

Deletes an image's metadata reference. Deletes referenced C++ object.

Parameters:

image - The image whose metadata reference is to be deleted.