org.lsst.ccs.drivers.rcm

Class RegClient

java.lang.Object

org.lsst.ccs.drivers.rcm.RegClient

Direct Known Subclasses:

BaseSet

public class RegClient
extends Object

Java interface to the RCM registers.

Author:

Owen Saxton

Constructor Summary

Constructors

Constructor and Description
RegClient() Constructor.

Method Summary

Methods

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

Constructor Detail

RegClient

public RegClient()

Constructor.

Method Detail

finalize

protected void finalize()
                 throws Throwable

Finalizer.

Overrides:

finalize in class Object

Throws:

Throwable

open

public void open(int id)
          throws RcmException

Opens a connection.

Parameters:

id - The ID of the RCM to connect to

Throws:

RcmException

close

public void close()
           throws RcmException

Closes a connection.

Throws:

RcmException

checkOpen

protected void checkOpen()
                  throws RcmException

Checks that connection is open.

Throws:

RcmException

read

public int read(int address)
         throws RcmException

Reads from a register.

Parameters:

address - The address of the register to read

Returns:

The value contained in the register

Throws:

RcmException

read

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

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:

RcmException

read

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

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:

RcmException

write

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

Writes to a register.

Parameters:

address - The address of the register to write

value - The value to write to the register

Throws:

RcmException

write

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

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:

RcmException

write

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

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:

RcmException

update

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

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:

RcmException

readLong

public long readLong(int address)
              throws RcmException

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:

RcmException

writeLong

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

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:

RcmException