org.lsst.ccs.drivers.reb

Class PciClient.Images

java.lang.Object

org.lsst.ccs.drivers.reb.PciClient.Images

All Implemented Interfaces:

ImageClient.Impl

Enclosing class:

PciClient

public static class PciClient.Images
extends Object
implements ImageClient.Impl

Image interface.

Method Summary

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

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

newImageClient

public void newImageClient(int id,
                           String ifc)
                    throws REBException

Description copied from interface: ImageClient.Impl

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

Specified by:

newImageClient in interface ImageClient.Impl

Parameters:

id - The ID of the REB to connect to

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

Throws:

REBException

newImageClient1

public void newImageClient1(int id,
                            String ifc,
                            int version)

deleteImageClient

public void deleteImageClient()

Description copied from interface: ImageClient.Impl

Deletes an object. Deletes referenced C++ objects.

Specified by:

deleteImageClient in interface ImageClient.Impl

deleteImageClient1

public void deleteImageClient1()

waitForImage

public Image waitForImage(Image image)

Description copied from interface: ImageClient.Impl

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

Specified by:

waitForImage in interface ImageClient.Impl

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

public boolean getImage(Image image)

Description copied from interface: ImageClient.Impl

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

Specified by:

getImage in interface ImageClient.Impl

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.

reset

public void reset()

Description copied from interface: ImageClient.Impl

Resets the front end system.

Specified by:

reset in interface ImageClient.Impl

deleteImageMetadataRef

public void deleteImageMetadataRef(Image image)

Description copied from interface: ImageClient.Impl

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

Specified by:

deleteImageMetadataRef in interface ImageClient.Impl

Parameters:

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