org.lsst.ccs.drivers.reb

Class GlobalClient

java.lang.Object

org.lsst.ccs.drivers.reb.GlobalClient

public class GlobalClient
extends Object

Java interface to the global client routines

Author:

Owen Saxton

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	GlobalClient.Impl Inner interface to support choosing the hardware.

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
GlobalClient()

Method Summary

Modifier and Type	Method and Description
long	acquireImage(String name) Acquires an image (by setting the trigger).
long	acquireImage(String name, String folder, int opcode, String annotation, int... ids) Acquires an image (by setting the trigger).
void	close() Closes a connection.
protected void	finalize() Finalizer.
int	getHwType() Gets the hardware type.
void	open(int hdw, int[] ids, String[] ifcs) Opens a connection to a set of REBs, i.e.
void	open(String part) Opens a connection to a DAQ V2/4 partition.
void	setClientFactory(ClientFactory clientFactory) Sets an alternative client factory.
void	setRegisterlist(int rebType, int[] registers) Sets the list of registers to be read when the image is acquired.
long	startSequencer(int opcode) Starts the sequencer.

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.

See Also:

Constant Field Values

HDW_TYPE_DAQ0

@Deprecated
public static final int HDW_TYPE_DAQ0

Deprecated.

See Also:

Constant Field Values

HDW_TYPE_DAQ1

@Deprecated
public static final int HDW_TYPE_DAQ1

Deprecated.

See Also:

Constant Field Values

HDW_TYPE_DAQ2

@Deprecated
public static final int HDW_TYPE_DAQ2

Deprecated.

See Also:

Constant Field Values

HDW_TYPE_DAQ4

@Deprecated
public static final int HDW_TYPE_DAQ4

Deprecated.

See Also:

Constant Field Values

HDW_TYPE_PCI0

@Deprecated
public static final int HDW_TYPE_PCI0

Deprecated.

See Also:

Constant Field Values

HDW_TYPE_PCI1

@Deprecated
public static final int HDW_TYPE_PCI1

Deprecated.

See Also:

Constant Field Values

HDW_TYPE_PCI

@Deprecated
public static final int HDW_TYPE_PCI

Deprecated.

See Also:

Constant Field Values

Constructor Detail

GlobalClient

public GlobalClient()

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

open

public void open(String part)
          throws REBException

Opens a connection to a DAQ V2/4 partition.

Parameters:

part - The partition name

Throws:

REBException

open

public void open(int hdw,
                 int[] ids,
                 String[] ifcs)
          throws REBException

Opens a connection to a set of REBs, i.e. a non DAQ 2/4 system.

Parameters:

hdw - The hardware type

ids - The array of IDs of the REBs to connect to

ifcs - The names of the hardware interfaces to use for the corresponding IDs. If null, or an element is null or empty, the default interface is used.

Throws:

REBException

close

public void close()
           throws REBException

Closes a connection.

Throws:

REBException

getHwType

public int getHwType()
              throws REBException

Gets the hardware type.

Returns:

The encoded hardware type

Throws:

REBException

setRegisterlist

public void setRegisterlist(int rebType,
                            int[] registers)
                     throws REBException

Sets the list of registers to be read when the image is acquired.

Parameters:

rebType - The encoded REB type

registers - The array of register addresses

Throws:

REBException

acquireImage

public long acquireImage(String name)
                  throws REBException

Acquires an image (by setting the trigger).

Parameters:

name - The name of the image

Returns:

The trigger time (nsec since the Epoch)

Throws:

REBException

acquireImage

public long acquireImage(String name,
                         String folder,
                         int opcode,
                         String annotation,
                         int... ids)
                  throws REBException

Acquires an image (by setting the trigger).

Parameters:

name - The name of the image

folder - The image folder to use

opcode - The sequencer opcode

annotation - The annotation for the image

ids - An array of REB ids to use; if empty, use the whole partition

Returns:

The trigger time (nsec since the Epoch)

Throws:

REBException

startSequencer

public long startSequencer(int opcode)
                    throws REBException

Starts the sequencer.

Parameters:

opcode - The sequencer opcode

Returns:

The trigger time (nsec since the Epoch)

Throws:

REBException