org.lsst.ccs.drivers.reb

Class ImageClient

java.lang.Object

org.lsst.ccs.drivers.reb.ImageClient

public class ImageClient
extends Object

Java interface to the image client routines

Author:

Owen Saxton

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ImageClient.Impl Inner interface to support choosing the hardware.
static interface	ImageClient.Listener Defines the data listener.

Field Summary

Fields

Modifier and Type	Field and Description
static int	HDW_TYPE_DAQ Deprecated.
static int	HDW_TYPE_DAQ0 Deprecated.
static int	HDW_TYPE_DAQ1 Deprecated.
static int	HDW_TYPE_DAQ2 Deprecated.
static int	HDW_TYPE_DAQ4 Deprecated.
static int	HDW_TYPE_PCI Deprecated.
static int	HDW_TYPE_PCI0 Deprecated.
static int	HDW_TYPE_PCI1 Deprecated.

Constructor Summary

Constructors

Constructor and Description
ImageClient(RegClient reg) Constructor.
ImageClient(RegClient reg, String rebid) Constructor.

Method Summary

Modifier and Type	Method and Description
Image	awaitImage(Image image) Awaits an image.
void	clearListener() Clears the data listener.
void	close() Closes a connection.
void	deleteImageMetadataRef(Image image) Deletes an image's metadata reference.
protected void	finalize() Finalizer.
void	interrupt() Interrupts an image wait.
void	open(int id) Deprecated.
void	open(int hdw, int id, String ifc) Opens a connection.
void	open(int id, String part) Opens a DAQ1/2/4 connection.
boolean	readImage(Image image) Reads an image.
void	resetFrontEnd() Resets the front end system.
void	setClientFactory(ClientFactory clientFactory) Sets an alternative client factory.
void	setListener(ImageClient.Listener listener, Image image) Sets the data listener.
void	setRebId(String rebid) Sets the REB ID.

Methods inherited from class java.lang.Object

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

Field Detail

HDW_TYPE_DAQ

@Deprecated
public static final int HDW_TYPE_DAQ

Deprecated.

Data fields.

See Also:

Constant Field Values

HDW_TYPE_DAQ0

@Deprecated
public static final int HDW_TYPE_DAQ0

Deprecated.

Data fields.

See Also:

Constant Field Values

HDW_TYPE_DAQ1

@Deprecated
public static final int HDW_TYPE_DAQ1

Deprecated.

Data fields.

See Also:

Constant Field Values

HDW_TYPE_DAQ2

@Deprecated
public static final int HDW_TYPE_DAQ2

Deprecated.

Data fields.

See Also:

Constant Field Values

HDW_TYPE_DAQ4

@Deprecated
public static final int HDW_TYPE_DAQ4

Deprecated.

Data fields.

See Also:

Constant Field Values

HDW_TYPE_PCI

@Deprecated
public static final int HDW_TYPE_PCI

Deprecated.

Data fields.

See Also:

Constant Field Values

HDW_TYPE_PCI0

@Deprecated
public static final int HDW_TYPE_PCI0

Deprecated.

Data fields.

See Also:

Constant Field Values

HDW_TYPE_PCI1

@Deprecated
public static final int HDW_TYPE_PCI1

Deprecated.

Data fields.

See Also:

Constant Field Values

Constructor Detail

ImageClient

public ImageClient(RegClient reg)

Constructor.

Parameters:

reg - The associated register client

ImageClient

public ImageClient(RegClient reg,
                   String rebid)

Constructor.

Parameters:

reg - The associated register client

rebid - The REB ID (for logging)

Method Detail

finalize

protected void finalize()
                 throws Throwable

Finalizer.

Overrides:

finalize in class Object

Throws:

Throwable

setClientFactory

public void setClientFactory(ClientFactory clientFactory)

Sets an alternative client factory. The client factory is used to create the objects that implement access to either real (by default) or simulated hardware.

Parameters:

clientFactory - The ClientFactory to use

setRebId

public void setRebId(String rebid)

Sets the REB ID.

Parameters:

rebid - The REB ID (for logging)

open

@Deprecated
public void open(int id)
                      throws REBException

Deprecated.

Opens a connection using the default interface.

Parameters:

id - The ID of the REB to connect to

Throws:

REBException

open

public void open(int id,
                 String part)
          throws REBException

Opens a DAQ1/2/4 connection.

Parameters:

id - The ID of the REB to connect to

part - The name of the partition to use.

Throws:

REBException

open

public void open(int hdw,
                 int id,
                 String ifc)
          throws REBException

Opens a connection.

Parameters:

hdw - The hardware type

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

close

public void close()
           throws REBException

Closes a connection.

Throws:

REBException

awaitImage

public Image awaitImage(Image image)
                 throws REBException

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.

Throws:

REBException

readImage

public boolean readImage(Image image)
                  throws REBException

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.

Throws:

REBException

deleteImageMetadataRef

public 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.

interrupt

public void interrupt()
               throws REBException

Interrupts an image wait.

Throws:

REBException

resetFrontEnd

public void resetFrontEnd()
                   throws REBException

Resets the front end system.

Throws:

REBException

setListener

public void setListener(ImageClient.Listener listener,
                        Image image)

Sets the data listener. Sets the data listener object, whose class must implement the Listener interface, and therefore must contain the processImage method. This method is called with a complete Image object as its argument whenever a new image becomes available.

Parameters:

listener - The listener object to be set as the listener. Any existing listener is replaced.

image - An image object to be used to contain received images, or null if a new object is to be created each time.

Throws:

REBException

clearListener

public void clearListener()

Clears the data listener. Clears the data listener object if it exists.

Throws:

REBException