org.lsst.ccs.drivers.reb

Class PciClient.Registers

java.lang.Object

org.lsst.ccs.drivers.reb.PciClient.Registers

All Implemented Interfaces:

RegClient.Impl

Enclosing class:

PciClient

public static class PciClient.Registers
extends Object
implements RegClient.Impl

Register interface.

Method Summary

Modifier and Type	Method and Description
void	deleteRegClient(long handle) Deletes the object.
void	deleteRegClient1(long handle)
long	newRegClient(int id, String ifc) Creates a new register client object.
long	newRegClient1(int id, String ifc)
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.
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.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.lsst.ccs.drivers.reb.RegClient.Impl

reset

Method Detail

newRegClient

public long newRegClient(int id,
                         String ifc)

Description copied from interface: RegClient.Impl

Creates a new register client object.

Specified by:

newRegClient in interface RegClient.Impl

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

newRegClient1

public long newRegClient1(int id,
                          String ifc)

deleteRegClient

public void deleteRegClient(long handle)

Description copied from interface: RegClient.Impl

Deletes the object.

Specified by:

deleteRegClient in interface RegClient.Impl

Parameters:

handle - The handle of the register client object

deleteRegClient1

public void deleteRegClient1(long handle)

readReg

public int readReg(long handle,
                   int address)
            throws REBException

Description copied from interface: RegClient.Impl

Reads from a register.

Specified by:

readReg in interface RegClient.Impl

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

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

Description copied from interface: RegClient.Impl

Reads from a set of registers.

Specified by:

readRegs in interface RegClient.Impl

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

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

Description copied from interface: RegClient.Impl

Writes to a register.

Specified by:

writeReg in interface RegClient.Impl

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

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

Description copied from interface: RegClient.Impl

Writes to a set of registers.

Specified by:

writeRegs in interface RegClient.Impl

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

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

Description copied from interface: RegClient.Impl

Updates a register.

Specified by:

updateReg in interface RegClient.Impl

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