org.lsst.ccs.drivers.reb

Class RegClient

java.lang.Object

org.lsst.ccs.drivers.reb.RegClient

Direct Known Subclasses:

BaseSet

public class RegClient
extends Object

Java interface to the REB registers.

Author:

Owen Saxton

Nested Class Summary

Nested Classes

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

Field Summary

Fields

Modifier and Type	Field and Description
static int	HDW_TYPE_DAQ0 Data fields.
static int	HDW_TYPE_DAQ1 Data fields.
static int	HDW_TYPE_PCI Data fields.
static int	HDW_TYPE_PCI0 Data fields.
static int	HDW_TYPE_PCI1 Data fields.

Constructor Summary

Constructors

Constructor and Description
RegClient() Constructor.

Method Summary

Modifier and Type	Method and Description
protected void	checkOpen() Checks that connection is open.
void	close() Closes a connection.
protected void	finalize() Finalizer.
void	open(int id) Opens a connection using the default network interface.
void	open(int hdw, int id, String ifc) Opens a connection.
void	open(int id, String ifc) Opens a connection using the specified network interface.
int	read(int address) Reads from a register.
void	read(int address, int[] values) Reads from a set of registers.
void	read(int address, int[] values, int offset, int count) Reads from a set of registers.
long	readLong(int address) Reads a register pair as a long value.
void	setClientFactory(ClientFactory clientFactory) Can be used to override the default clientFactory, for example to substitute a clientFactory which simulates real clients.
int	update(int address, int mask, int value) Updates a register.
void	write(int address, int value) Writes to a register.
void	write(int address, int[] values) Writes to a set of registers.
void	write(int address, int[] values, int offset, int count) Writes to a set of registers.
void	writeLong(int address, long value) Writes a long value to a register pair.

Methods inherited from class java.lang.Object

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

Field Detail

HDW_TYPE_DAQ0

public static final int HDW_TYPE_DAQ0

Data fields.

See Also:

Constant Field Values

HDW_TYPE_DAQ1

public static final int HDW_TYPE_DAQ1

Data fields.

See Also:

Constant Field Values

HDW_TYPE_PCI

public static final int HDW_TYPE_PCI

Data fields.

See Also:

Constant Field Values

HDW_TYPE_PCI0

public static final int HDW_TYPE_PCI0

Data fields.

See Also:

Constant Field Values

HDW_TYPE_PCI1

public static final int HDW_TYPE_PCI1

Data fields.

See Also:

Constant Field Values

Constructor Detail

RegClient

public RegClient()

Constructor.

Method Detail

setClientFactory

public void setClientFactory(ClientFactory clientFactory)

Can be used to override the default clientFactory, for example to substitute a clientFactory which simulates real clients.

Parameters:

clientFactory -

finalize

protected void finalize()
                 throws Throwable

Finalizer.

Overrides:

finalize in class Object

Throws:

Throwable

open

public void open(int id)
          throws REBException

Opens a connection using the default network interface.

Parameters:

id - The ID of the REB to connect to

Throws:

REBException

open

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

Opens a connection using the specified network interface.

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

open

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

Opens a connection.

Parameters:

hdw - The hardware type to use (DAQ0, DAQ1 or PCI)

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

close

public void close()
           throws REBException

Closes a connection.

Throws:

REBException

checkOpen

protected void checkOpen()
                  throws REBException

Checks that connection is open.

Throws:

REBException

read

public int read(int address)
         throws REBException

Reads from a register.

Parameters:

address - The address of the register to read

Returns:

The value contained in the register

Throws:

REBException

read

public void read(int address,
                 int[] values,
                 int offset,
                 int count)
          throws REBException

Reads from a set of registers.

Parameters:

address - The address of the first register to read

values - An array to receive the register values

offset - The offset to the array element where the first value is to be put

count - The number of registers to read

Throws:

REBException

read

public void read(int address,
                 int[] values)
          throws REBException

Reads from a set of registers.

Parameters:

address - The address of the first register to read

values - An array to receive the register values. The size of the array determines how many registers to read.

Throws:

REBException

write

public void write(int address,
                  int value)
           throws REBException

Writes to a register.

Parameters:

address - The address of the register to write

value - The value to write to the register

Throws:

REBException

write

public void write(int address,
                  int[] values,
                  int offset,
                  int count)
           throws REBException

Writes to a set of registers.

Parameters:

address - The address of the first register to write

values - An array containing the values to write

offset - The offset to the array element containing the first value to write

count - The number of registers to write

Throws:

REBException

write

public void write(int address,
                  int[] values)
           throws REBException

Writes to a set of registers.

Parameters:

address - The address of the first register to write

values - An array containing the values to write. The size of array is the number of registers to write.

Throws:

REBException

update

public int update(int address,
                  int mask,
                  int value)
           throws REBException

Updates a register.

Parameters:

address - The address of the register to update

mask - A mask in which set bits indicate which bits of value are to be written

value - The value to write to the register

Throws:

REBException

readLong

public long readLong(int address)
              throws REBException

Reads a register pair as a long value.

Parameters:

address - The address of the first register to read

Returns:

The value obtained by combining the values as a little-endian pair

Throws:

REBException

writeLong

public void writeLong(int address,
                      long value)
               throws REBException

Writes a long value to a register pair.

Parameters:

address - The address of the first register to write

value - The value to write, as a little-endian pair

Throws:

REBException