org.lsst.ccs.drivers.reb

Interface RegClient.Impl

All Known Implementing Classes:

Daq0Client.Registers, Daq1Client.Registers, Daq2Client.Registers, PciClient.Registers, RegClientDaq1Simulation

Enclosing class:

RegClient

public static interface RegClient.Impl

Inner interface to support choosing the hardware.

Method Summary

Modifier and Type	Method and Description
void	deleteRegClient(long handle) Deletes the object.
long	newRegClient(int id, String ifc) Creates a new register client object.
int	readReg(long handle, int address) Reads from a register.
void	readRegs(long handle, int address, int[] values, int offset, int count) Reads from a set of registers.
default void	reset(long handle, int type) Resets the hardware.
int	updateReg(long handle, int address, int mask, int value) Updates a register.
void	writeReg(long handle, int address, int value) Writes to a register.
void	writeRegs(long handle, int address, int[] values, int offset, int count) Writes to a set of registers.

Method Detail

newRegClient

long newRegClient(int id,
                  String ifc)

Creates a new register client object.

Parameters:

id - The ID of the REB to be accessed by the object

ifc - The name of the partition or hardware interface to use.

Returns:

The handle for the created object

deleteRegClient

void deleteRegClient(long handle)

Deletes the object.

Parameters:

handle - The handle of the register client object

readReg

int readReg(long handle,
            int address)
     throws REBException

Reads from a register.

Parameters:

handle - The handle of the register client object

address - The address of the register to read

Returns:

The value contained in the register

Throws:

REBException

readRegs

void readRegs(long handle,
              int address,
              int[] values,
              int offset,
              int count)
       throws REBException

Reads from a set of registers.

Parameters:

handle - The handle of the register client object

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

writeReg

void writeReg(long handle,
              int address,
              int value)
       throws REBException

Writes to a register.

Parameters:

handle - The handle of the register client object

address - The address of the register to write

value - The value to write to the register

Throws:

REBException

writeRegs

void writeRegs(long handle,
               int address,
               int[] values,
               int offset,
               int count)
        throws REBException

Writes to a set of registers.

Parameters:

handle - The handle of the register client object

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

updateReg

int updateReg(long handle,
              int address,
              int mask,
              int value)
       throws REBException

Updates a register.

Parameters:

handle - The handle of the register client object

address - The address of the register to update

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

value - The value to write to the register

Returns:

The previous register value

Throws:

REBException

reset

default void reset(long handle,
                   int type)
            throws REBException

Resets the hardware.

Parameters:

handle - The handle of the register client object

type - The type of reset to perform

Throws:

REBException