BaseSet (LSST CCS - REB Driver 2.10.0 API)

java.lang.Object
- org.lsst.ccs.drivers.reb.RegClient
- - org.lsst.ccs.drivers.reb.BaseSet

```
public class BaseSet
extends RegClient
```
Base register set access routines.

Author:

Owen Saxton

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class BaseSet.Version
Inner class for version numbers.
- Nested classes/interfaces inherited from class org.lsst.ccs.drivers.reb.RegClient
  RegClient.Impl

Nested Classes
Modifier and Type	Class and Description
`static class`	`BaseSet.Version` Inner class for version numbers.

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`BACK_BIAS_ERROR` Public constants.
`static int`	`BACK_BIAS_OFF` Public constants.
`static int`	`BACK_BIAS_ON` Public constants.
`static int`	`CLOCK_PERIOD_0` Public constants.
`static int`	`CLOCK_PERIOD_1` Public constants.
`static int`	`FW_VERSION_GREB_0` Public constants.
`static int`	`FW_VERSION_GREB_1` Public constants.
`static int`	`FW_VERSION_GREB_2` Public constants.
`static int`	`FW_VERSION_INITIAL` Public constants.
`static int`	`FW_VERSION_REB0_0` Public constants.
`static int`	`FW_VERSION_REB0_1` Public constants.
`static int`	`FW_VERSION_REB1_2` Public constants.
`static int`	`FW_VERSION_REB1_3` Public constants.
`static int`	`FW_VERSION_REB1_4` Public constants.
`static int`	`FW_VERSION_REB3` Public constants.
`static int`	`FW_VERSION_REB4_0` Public constants.
`static int`	`FW_VERSION_REB4_1` Public constants.
`static int`	`FW_VERSION_REB4_2` Public constants.
`static int`	`FW_VERSION_REB5_0` Public constants.
`static int`	`FW_VERSION_REB5_1` Public constants.
`static int`	`FW_VERSION_UNKNOWN` Public constants.
`static int`	`FW_VERSION_UNSET` Public constants.
`static int`	`FW_VERSION_WREB_1` Public constants.
`static int`	`FW_VERSION_WREB_2` Public constants.
`static int`	`FW_VERSION_WREB_3` Public constants.
`static int`	`FW_VERSION_WREB_4` Public constants.
`static int`	`FW_VERSION_WREB_5` Public constants.
`static int`	`MAX_STRIPS` Public constants.
`static int`	`OPTN_ASPIC` Public constants.
`static int`	`OPTN_BACK_BIAS` Public constants.
`static int`	`OPTN_BOARD_DACS` Public constants.
`static int`	`OPTN_BOARD_POWER` Public constants.
`static int`	`OPTN_BOARD_TEMP` Public constants.
`static int`	`OPTN_CABAC` Public constants.
`static int`	`OPTN_CCD_TEMP` Public constants.
`static int`	`OPTN_DCDC_SYNC` Public constants.
`static int`	`OPTN_DREB_SN` Public constants.
`static int`	`OPTN_FAST_ADCS` Public constants.
`static int`	`OPTN_REB_SN` Public constants.
`static int`	`OPTN_SEQUENCER` Public constants.
`static int`	`OPTN_SLOW_ADCS` Public constants.
`static int`	`OPTN_STATUS` Public constants.
`static int`	`REB_TYPE_GUIDER` Public constants.
`static int`	`REB_TYPE_SCIENCE` Public constants.
`static int`	`REB_TYPE_UNKNOWN` Public constants.
`static int`	`REB_TYPE_WAVEFRONT` Public constants.
`static int`	`REG_BACK_BIAS` Public constants.
`static int`	`REG_DCDC_SYNC` Public constants.
`static int`	`REG_ID` Public constants.
`static int`	`REG_SCHEMA` Public constants.
`static int`	`REG_SN_DREB_START` Public constants.
`static int`	`REG_SN_DREB_VALUE` Public constants.
`static int`	`REG_SN_REB_START` Public constants.
`static int`	`REG_SN_REB_VALUE` Public constants.
`static int`	`REG_STATE` Public constants.
`static int`	`REG_TIME_BASE` Public constants.
`static int`	`REG_TRIG_TIME` Public constants.
`static int`	`REG_TRIGGER` Public constants.
`static int`	`REG_VERSION` Public constants.
`static int`	`RSET_FAST_ADCS` Public constants.
`static int`	`RSET_POWER_ADCS` Public constants.
`static int`	`RSET_SEQUENCER` Public constants.
`static int`	`RSET_STATUS` Public constants.
`static int`	`RSET_TEMP_ADCS` Public constants.
`static int`	`RSET_TIME_BASE` Public constants.
`static long`	`SN_READ_ERROR`
`static long`	`SN_READ_OKAY`
`static long`	`SN_READ_TIMEOUT`
`static long`	`SN_VALUE_MASK`
`static int`	`VERSION_0` Public constants.
`static int`	`VERSION_1` Public constants.
`static int`	`VERSION_2` Public constants.
`static int`	`VERSION_3` Public constants.
`static int`	`VERSION_4` Public constants.
`static int`	`VERSION_5` Public constants.
`static int`	`VERSION_6` Public constants.
`static int`	`VERSION_7` Public constants.
`static int`	`VERSION_8` Public constants.
`static int`	`VERSION_UNSUPP` Public constants.

Fields inherited from class org.lsst.ccs.drivers.reb.RegClient
HDW_TYPE_DAQ, HDW_TYPE_DAQ0, HDW_TYPE_DAQ1, HDW_TYPE_DAQ2, HDW_TYPE_DAQ4, HDW_TYPE_PCI, HDW_TYPE_PCI0, HDW_TYPE_PCI1

Constructor Summary

Constructors
Constructor and Description

BaseSet()
Constructor.

BaseSet(RegClient reg)
Constructor.

Constructors
Constructor and Description
`BaseSet()` Constructor.
`BaseSet(RegClient reg)` Constructor.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`checkNotVersion(int option, int... version)` Checks for not particular option versions.
`void`	`checkVersion(int option, int... version)` Checks for particular option versions.
`long`	`convertRawTime(long raw)` Converts a raw time-base value to milliseconds.
`int`	`convertStripNum(int strip)` Converts a canonical strip (CCD) number to its hardware version (or vice versa).
`void`	`disable()` Disables the time-base.
`void`	`disable(int regSet)` Disables a register set.
`void`	`enable()` Enables the time-base.
`void`	`enable(int regSet)` Enables a register set.
`long`	`getDrebSerial()` Gets the DREB serial number.
`int`	`getFwVersion()` Gets the firmware version.
`int`	`getHwVersion()` Gets the hardware version.
`int`	`getNumStrips()` Gets the number of strips.
`long`	`getRebSerial()` Gets the REB serial number.
`int`	`getRebType()` Gets the REB type.
`long`	`getTime()` Gets the time-base value as millisecond Unix time.
`long`	`getTimeRaw()` Gets the raw time-base value.
`long`	`getTriggerTime(int regSet)` Gets the trigger time for a register set as Unix millisecond time.
`long`	`getTriggerTimeRaw(int regSet)` Gets the raw trigger time for a register set.
`int`	`getVersion(int option)` Gets the version of a particular option.
`int`	`getVersion(int option, boolean unsOkay)` Gets the version of a particular option.
`boolean`	`isBackBiasOn()` Gets the back bias setting.
`boolean`	`isDcdcSync()` Gets the DC/DC synchronization.
`boolean`	`isEnabled(int regSet)` Checks whether a register set is enabled.
`boolean`	`isVersion(int option, int... version)` Tests for a particular option version.
`void`	`open(int hdw, int id, String ifc)` Opens a connection.
`void`	`setBackBias(boolean on)` Sets the back bias state.
`void`	`setDcdcSync(boolean enable)` Sets the DC/DC synchronization.
`void`	`setDefaultRebType(int type)` Sets the default REB type.
`void`	`setTime()` Sets the time-base value to the current system time.
`void`	`setTime(long time)` Sets the time-base value as millisecond Unix time.
`void`	`setTimeRaw(long time)` Sets the raw time-base value.
`void`	`throwIncompatException()` Throws incompatible firmware version exception.
`void`	`waitDone(int regSet)` Waits for a register set to become disabled.
`void`	`waitDone(int regSet, int timeout)` Waits for a register set to become disabled.

Methods inherited from class org.lsst.ccs.drivers.reb.RegClient
checkOpen, close, finalize, open, open, read, read, read, readLong, reset, setClientFactory, update, write, write, write, writeLong

Methods inherited from class java.lang.Object
clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - RSET_STATUS
```
public static final int RSET_STATUS
```
    Public constants.
    
    See Also:
    
    Constant Field Values
  - RSET_TIME_BASE
```
public static final int RSET_TIME_BASE
```
    Public constants.
    
    See Also:
    
    Constant Field Values
  - RSET_SEQUENCER
```
public static final int RSET_SEQUENCER
```
    Public constants.
    
    See Also:
    
    Constant Field Values
  - RSET_POWER_ADCS
```
public static final int RSET_POWER_ADCS
```
    Public constants.
    
    See Also:
    
    Constant Field Values
  - RSET_TEMP_ADCS
```
public static final int RSET_TEMP_ADCS
```
    Public constants.
    
    See Also:
    
    Constant Field Values
  - RSET_FAST_ADCS
```
public static final int RSET_FAST_ADCS
```
    Public constants.
    
    See Also:
    
    Constant Field Values
  - REG_SCHEMA
```
public static final int REG_SCHEMA
```
    Public constants.
    
    See Also:
    
    Constant Field Values
  - REG_VERSION
```
public static final int REG_VERSION
```
    Public constants.
    
    See Also:
    
    Constant Field Values
  - REG_ID
```
public static final int REG_ID
```
    Public constants.
    
    See Also:
    
    Constant Field Values
  - REG_TIME_BASE
```
public static final int REG_TIME_BASE
```
    Public constants.
    
    See Also:
    
    Constant Field Values
  - REG_STATE
```
public static final int REG_STATE
```
    Public constants.
    
    See Also:
    
    Constant Field Values
  - REG_TRIGGER
```
public static final int REG_TRIGGER
```
    Public constants.
    
    See Also:
    
    Constant Field Values
  - REG_TRIG_TIME
```
public static final int REG_TRIG_TIME
```
    Public constants.
    
    See Also:
    
    Constant Field Values
  - REG_SN_REB_START
```
public static final int REG_SN_REB_START
```
    Public constants.
    
    See Also:
    
    Constant Field Values
  - REG_SN_REB_VALUE
```
public static final int REG_SN_REB_VALUE
```
    Public constants.
    
    See Also:
    
    Constant Field Values
  - REG_SN_DREB_START
```
public static final int REG_SN_DREB_START
```
    Public constants.
    
    See Also:
    
    Constant Field Values
  - REG_SN_DREB_VALUE
```
public static final int REG_SN_DREB_VALUE
```
    Public constants.
    
    See Also:
    
    Constant Field Values
  - REG_DCDC_SYNC
```
public static final int REG_DCDC_SYNC
```
    Public constants.
    
    See Also:
    
    Constant Field Values
  - REG_BACK_BIAS
```
public static final int REG_BACK_BIAS
```
    Public constants.
    
    See Also:
    
    Constant Field Values
  - BACK_BIAS_ON
```
public static final int BACK_BIAS_ON
```
    Public constants.
    
    See Also:
    
    Constant Field Values
  - BACK_BIAS_OFF
```
public static final int BACK_BIAS_OFF
```
    Public constants.
    
    See Also:
    
    Constant Field Values
  - BACK_BIAS_ERROR
```
public static final int BACK_BIAS_ERROR
```
    Public constants.
    
    See Also:
    
    Constant Field Values
  - REB_TYPE_UNKNOWN
```
public static final int REB_TYPE_UNKNOWN
```
    Public constants.
    
    See Also:
    
    Constant Field Values
  - REB_TYPE_SCIENCE
```
public static final int REB_TYPE_SCIENCE
```
    Public constants.
    
    See Also:
    
    Constant Field Values
  - REB_TYPE_GUIDER
```
public static final int REB_TYPE_GUIDER
```
    Public constants.
    
    See Also:
    
    Constant Field Values
  - REB_TYPE_WAVEFRONT
```
public static final int REB_TYPE_WAVEFRONT
```
    Public constants.
    
    See Also:
    
    Constant Field Values
  - MAX_STRIPS
```
public static final int MAX_STRIPS
```
    Public constants.
    
    See Also:
    
    Constant Field Values
  - OPTN_SEQUENCER
```
public static final int OPTN_SEQUENCER
```
    Public constants.
    
    See Also:
    
    Constant Field Values
  - OPTN_CABAC
```
public static final int OPTN_CABAC
```
    Public constants.
    
    See Also:
    
    Constant Field Values
  - OPTN_ASPIC
```
public static final int OPTN_ASPIC
```
    Public constants.
    
    See Also:
    
    Constant Field Values
  - OPTN_REB_SN
```
public static final int OPTN_REB_SN
```
    Public constants.
    
    See Also:
    
    Constant Field Values
  - OPTN_DREB_SN
```
public static final int OPTN_DREB_SN
```
    Public constants.
    
    See Also:
    
    Constant Field Values
  - OPTN_DCDC_SYNC
```
public static final int OPTN_DCDC_SYNC
```
    Public constants.
    
    See Also:
    
    Constant Field Values
  - OPTN_BOARD_DACS
```
public static final int OPTN_BOARD_DACS
```
    Public constants.
    
    See Also:
    
    Constant Field Values
  - OPTN_BOARD_POWER
```
public static final int OPTN_BOARD_POWER
```
    Public constants.
    
    See Also:
    
    Constant Field Values
  - OPTN_BOARD_TEMP
```
public static final int OPTN_BOARD_TEMP
```
    Public constants.
    
    See Also:
    
    Constant Field Values
  - OPTN_STATUS
```
public static final int OPTN_STATUS
```
    Public constants.
    
    See Also:
    
    Constant Field Values
  - OPTN_CCD_TEMP
```
public static final int OPTN_CCD_TEMP
```
    Public constants.
    
    See Also:
    
    Constant Field Values
  - OPTN_SLOW_ADCS
```
public static final int OPTN_SLOW_ADCS
```
    Public constants.
    
    See Also:
    
    Constant Field Values
  - OPTN_FAST_ADCS
```
public static final int OPTN_FAST_ADCS
```
    Public constants.
    
    See Also:
    
    Constant Field Values
  - OPTN_BACK_BIAS
```
public static final int OPTN_BACK_BIAS
```
    Public constants.
    
    See Also:
    
    Constant Field Values
  - FW_VERSION_INITIAL
```
public static final int FW_VERSION_INITIAL
```
    Public constants.
    
    See Also:
    
    Constant Field Values
  - FW_VERSION_UNSET
```
public static final int FW_VERSION_UNSET
```
    Public constants.
    
    See Also:
    
    Constant Field Values
  - FW_VERSION_UNKNOWN
```
public static final int FW_VERSION_UNKNOWN
```
    Public constants.
    
    See Also:
    
    Constant Field Values
  - FW_VERSION_REB0_0
```
public static final int FW_VERSION_REB0_0
```
    Public constants.
    
    See Also:
    
    Constant Field Values
  - FW_VERSION_REB0_1
```
public static final int FW_VERSION_REB0_1
```
    Public constants.
    
    See Also:
    
    Constant Field Values
  - FW_VERSION_REB1_2
```
public static final int FW_VERSION_REB1_2
```
    Public constants.
    
    See Also:
    
    Constant Field Values
  - FW_VERSION_REB1_3
```
public static final int FW_VERSION_REB1_3
```
    Public constants.
    
    See Also:
    
    Constant Field Values
  - FW_VERSION_REB1_4
```
public static final int FW_VERSION_REB1_4
```
    Public constants.
    
    See Also:
    
    Constant Field Values
  - FW_VERSION_WREB_1
```
public static final int FW_VERSION_WREB_1
```
    Public constants.
    
    See Also:
    
    Constant Field Values
  - FW_VERSION_REB3
```
public static final int FW_VERSION_REB3
```
    Public constants.
    
    See Also:
    
    Constant Field Values
  - FW_VERSION_WREB_2
```
public static final int FW_VERSION_WREB_2
```
    Public constants.
    
    See Also:
    
    Constant Field Values
  - FW_VERSION_REB4_0
```
public static final int FW_VERSION_REB4_0
```
    Public constants.
    
    See Also:
    
    Constant Field Values
  - FW_VERSION_GREB_0
```
public static final int FW_VERSION_GREB_0
```
    Public constants.
    
    See Also:
    
    Constant Field Values
  - FW_VERSION_WREB_3
```
public static final int FW_VERSION_WREB_3
```
    Public constants.
    
    See Also:
    
    Constant Field Values
  - FW_VERSION_REB5_0
```
public static final int FW_VERSION_REB5_0
```
    Public constants.
    
    See Also:
    
    Constant Field Values
  - FW_VERSION_REB4_1
```
public static final int FW_VERSION_REB4_1
```
    Public constants.
    
    See Also:
    
    Constant Field Values
  - FW_VERSION_REB5_1
```
public static final int FW_VERSION_REB5_1
```
    Public constants.
    
    See Also:
    
    Constant Field Values
  - FW_VERSION_GREB_1
```
public static final int FW_VERSION_GREB_1
```
    Public constants.
    
    See Also:
    
    Constant Field Values
  - FW_VERSION_WREB_4
```
public static final int FW_VERSION_WREB_4
```
    Public constants.
    
    See Also:
    
    Constant Field Values
  - FW_VERSION_REB4_2
```
public static final int FW_VERSION_REB4_2
```
    Public constants.
    
    See Also:
    
    Constant Field Values
  - FW_VERSION_GREB_2
```
public static final int FW_VERSION_GREB_2
```
    Public constants.
    
    See Also:
    
    Constant Field Values
  - FW_VERSION_WREB_5
```
public static final int FW_VERSION_WREB_5
```
    Public constants.
    
    See Also:
    
    Constant Field Values
  - VERSION_UNSUPP
```
public static final int VERSION_UNSUPP
```
    Public constants.
    
    See Also:
    
    Constant Field Values
  - VERSION_0
```
public static final int VERSION_0
```
    Public constants.
    
    See Also:
    
    Constant Field Values
  - VERSION_1
```
public static final int VERSION_1
```
    Public constants.
    
    See Also:
    
    Constant Field Values
  - VERSION_2
```
public static final int VERSION_2
```
    Public constants.
    
    See Also:
    
    Constant Field Values
  - VERSION_3
```
public static final int VERSION_3
```
    Public constants.
    
    See Also:
    
    Constant Field Values
  - VERSION_4
```
public static final int VERSION_4
```
    Public constants.
    
    See Also:
    
    Constant Field Values
  - VERSION_5
```
public static final int VERSION_5
```
    Public constants.
    
    See Also:
    
    Constant Field Values
  - VERSION_6
```
public static final int VERSION_6
```
    Public constants.
    
    See Also:
    
    Constant Field Values
  - VERSION_7
```
public static final int VERSION_7
```
    Public constants.
    
    See Also:
    
    Constant Field Values
  - VERSION_8
```
public static final int VERSION_8
```
    Public constants.
    
    See Also:
    
    Constant Field Values
  - CLOCK_PERIOD_0
```
public static final int CLOCK_PERIOD_0
```
    Public constants.
    
    See Also:
    
    Constant Field Values
  - CLOCK_PERIOD_1
```
public static final int CLOCK_PERIOD_1
```
    Public constants.
    
    See Also:
    
    Constant Field Values
  - SN_READ_OKAY
```
public static final long SN_READ_OKAY
```
    See Also:
    
    Constant Field Values
  - SN_READ_ERROR
```
public static final long SN_READ_ERROR
```
    See Also:
    
    Constant Field Values
  - SN_READ_TIMEOUT
```
public static final long SN_READ_TIMEOUT
```
    See Also:
    
    Constant Field Values
  - SN_VALUE_MASK
```
public static final long SN_VALUE_MASK
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - BaseSet
```
public BaseSet()
```
    Constructor.
  - BaseSet
```
public BaseSet(RegClient reg)
```
    Constructor.
    
    Parameters:
    
    reg - The associated register client object
- Method Detail
  - open
```
public void open(int hdw,
                 int id,
                 String ifc)
          throws REBException
```
    Opens a connection.
    
    Overrides:
    
    open in class RegClient
    
    Parameters:
    
    hdw - The hardware type to use (DAQ0, DAQ1, DAQ2, PCI0 or PCI1)
    
    id - The ID of the REB to connect to
    
    ifc - The name of the DAQ2 partition or hardware interface to use.
    
    Throws:
    
    REBException
  - getHwVersion
```
public int getHwVersion()
                 throws REBException
```
    Gets the hardware version.
    
    Returns:
    
    The hardware version number
    
    Throws:
    
    REBException - if the version register can't be read
  - getFwVersion
```
public int getFwVersion()
                 throws REBException
```
    Gets the firmware version.
    
    Returns:
    
    The firmware version number
    
    Throws:
    
    REBException - if the firmware version is unknown
  - getRebType
```
public int getRebType()
               throws REBException
```
    Gets the REB type.
    
    Returns:
    
    The REB type
    
    Throws:
    
    REBException - if the firmware version is unknown
  - setDefaultRebType
```
public void setDefaultRebType(int type)
```
    Sets the default REB type. This is used for version information if no connection is open
    
    Parameters:
    
    type - The REB type to set
  - getNumStrips
```
public int getNumStrips()
                 throws REBException
```
    Gets the number of strips.
    
    Returns:
    
    The number of strips
    
    Throws:
    
    REBException - if the firmware version is unknown
  - convertStripNum
```
public int convertStripNum(int strip)
                    throws REBException
```
    Converts a canonical strip (CCD) number to its hardware version (or vice versa). This is needed because the hardware numbering of strips on science REBs is in the opposite order from the canonical numbering.
    
    Parameters:
    
    strip - The canonical strip number
    
    Returns:
    
    The hardware strip number
    
    Throws:
    
    REBException - if the firmware version is unknown
  - getVersion
```
public int getVersion(int option)
               throws REBException
```
    Gets the version of a particular option.
    
    Parameters:
    
    option - The ID of the option
    
    Returns:
    
    The option version number
    
    Throws:
    
    REBException - if the option ID is invalid or is not supported by the firmware, or the firmware version is unknown
  - getVersion
```
public int getVersion(int option,
                      boolean unsOkay)
               throws REBException
```
    Gets the version of a particular option.
    
    Parameters:
    
    option - The ID of the option
    
    unsOkay - If true, returns VERSION_UNSUPP if unsupported
    
    Returns:
    
    The option version number
    
    Throws:
    
    REBException - if the option ID is invalid or is not supported by the firmware, or the firmware version is unknown
  - isVersion
```
public boolean isVersion(int option,
                         int... version)
                  throws REBException
```
    Tests for a particular option version.
    
    Parameters:
    
    option - The ID of the option
    
    version - The array of possible versions to check against
    
    Returns:
    
    Whether any of the versions match
    
    Throws:
    
    REBException - if the firmware version is not recognized
  - checkVersion
```
public void checkVersion(int option,
                         int... version)
                  throws REBException
```
    Checks for particular option versions.
    
    Parameters:
    
    option - The ID of the option
    
    version - The array of possible versions to check against
    
    Throws:
    
    REBException - if the firmware version is not recognized or matches none of the specified versions
  - checkNotVersion
```
public void checkNotVersion(int option,
                            int... version)
                     throws REBException
```
    Checks for not particular option versions.
    
    Parameters:
    
    option - The ID of the option
    
    version - The array of possible versions to check against
    
    Throws:
    
    REBException - if the firmware version is not recognized or matches any of the specified versions
  - throwIncompatException
```
public void throwIncompatException()
                            throws REBException
```
    Throws incompatible firmware version exception.
    
    Throws:
    
    REBException
  - enable
```
public void enable()
            throws REBException
```
    Enables the time-base.
    
    Throws:
    
    REBException
  - disable
```
public void disable()
             throws REBException
```
    Disables the time-base.
    
    Throws:
    
    REBException
  - getTimeRaw
```
public long getTimeRaw()
                throws REBException
```
    Gets the raw time-base value.
    
    Returns:
    
    The time-base value as clock ticks
    
    Throws:
    
    REBException
  - getTime
```
public long getTime()
             throws REBException
```
    Gets the time-base value as millisecond Unix time.
    
    Returns:
    
    The time-base value as millisecond Unix time
    
    Throws:
    
    REBException
  - convertRawTime
```
public long convertRawTime(long raw)
                    throws REBException
```
    Converts a raw time-base value to milliseconds.
    
    Parameters:
    
    raw - The raw time in clock ticks
    
    Returns:
    
    The time-base value as millisecond Unix time
    
    Throws:
    
    REBException
  - setTimeRaw
```
public void setTimeRaw(long time)
                throws REBException
```
    Sets the raw time-base value.
    
    Parameters:
    
    time - The time-base value as clock ticks
    
    Throws:
    
    REBException
  - setTime
```
public void setTime(long time)
             throws REBException
```
    Sets the time-base value as millisecond Unix time.
    
    Parameters:
    
    time - The time-base value as millisecond Unix time
    
    Throws:
    
    REBException
  - setTime
```
public void setTime()
             throws REBException
```
    Sets the time-base value to the current system time.
    
    Throws:
    
    REBException
  - enable
```
public void enable(int regSet)
            throws REBException
```
    Enables a register set.
    
    Parameters:
    
    regSet - The register set identifier
    
    Throws:
    
    REBException
  - disable
```
public void disable(int regSet)
             throws REBException
```
    Disables a register set.
    
    Parameters:
    
    regSet - The register set identifier
    
    Throws:
    
    REBException
  - isEnabled
```
public boolean isEnabled(int regSet)
                  throws REBException
```
    Checks whether a register set is enabled.
    
    Parameters:
    
    regSet - The register set identifier
    
    Returns:
    
    Whether the register set is enabled
    
    Throws:
    
    REBException
  - waitDone
```
public void waitDone(int regSet)
              throws REBException
```
    Waits for a register set to become disabled. This generally indicates the completion of a read operation. The default timeout of 1 second is used.
    
    Parameters:
    
    regSet - The register set identifier
    
    Throws:
    
    REBException
  - waitDone
```
public void waitDone(int regSet,
                     int timeout)
              throws REBException
```
    Waits for a register set to become disabled. This generally indicates the completion of a read operation
    
    Parameters:
    
    regSet - The register set identifier
    
    timeout - The timeout period (ms)
    
    Throws:
    
    REBException
  - getTriggerTimeRaw
```
public long getTriggerTimeRaw(int regSet)
                       throws REBException
```
    Gets the raw trigger time for a register set.
    
    Parameters:
    
    regSet - The register set identifier
    
    Returns:
    
    The trigger time as clock ticks
    
    Throws:
    
    REBException
  - getTriggerTime
```
public long getTriggerTime(int regSet)
                    throws REBException
```
    Gets the trigger time for a register set as Unix millisecond time.
    
    Parameters:
    
    regSet - The register set identifier
    
    Returns:
    
    The trigger time as Unix millisecond time
    
    Throws:
    
    REBException
  - getRebSerial
```
public long getRebSerial()
                  throws REBException
```
    Gets the REB serial number.
    
    Returns:
    
    The 48-bit REB serial number
    
    Throws:
    
    REBException
  - getDrebSerial
```
public long getDrebSerial()
                   throws REBException
```
    Gets the DREB serial number.
    
    Returns:
    
    The 48-bit DREB serial number
    
    Throws:
    
    REBException
  - setDcdcSync
```
public void setDcdcSync(boolean enable)
                 throws REBException
```
    Sets the DC/DC synchronization.
    
    Parameters:
    
    enable - If true, enable synchronization; otherwise disable it
    
    Throws:
    
    REBException
  - isDcdcSync
```
public boolean isDcdcSync()
                   throws REBException
```
    Gets the DC/DC synchronization.
    
    Returns:
    
    Whether DC/DC synchronization is in effect
    
    Throws:
    
    REBException
  - setBackBias
```
public void setBackBias(boolean on)
                 throws REBException
```
    Sets the back bias state.
    
    Parameters:
    
    on - If true, turn the back bias on; otherwise turn it off
    
    Throws:
    
    REBException
  - isBackBiasOn
```
public boolean isBackBiasOn()
                     throws REBException
```
    Gets the back bias setting.
    
    Returns:
    
    Whether the back bias is turned on
    
    Throws:
    
    REBException

Class BaseSet

Nested Class Summary

Nested classes/interfaces inherited from class org.lsst.ccs.drivers.reb.RegClient

Field Summary

Fields inherited from class org.lsst.ccs.drivers.reb.RegClient

Constructor Summary

Method Summary

Methods inherited from class org.lsst.ccs.drivers.reb.RegClient

Methods inherited from class java.lang.Object

Field Detail

RSET_STATUS

RSET_TIME_BASE

RSET_SEQUENCER

RSET_POWER_ADCS

RSET_TEMP_ADCS

RSET_FAST_ADCS

REG_SCHEMA

REG_VERSION

REG_ID

REG_TIME_BASE

REG_STATE

REG_TRIGGER

REG_TRIG_TIME

REG_SN_REB_START

REG_SN_REB_VALUE

REG_SN_DREB_START

REG_SN_DREB_VALUE

REG_DCDC_SYNC

REG_BACK_BIAS

BACK_BIAS_ON

BACK_BIAS_OFF

BACK_BIAS_ERROR

REB_TYPE_UNKNOWN

REB_TYPE_SCIENCE

REB_TYPE_GUIDER

REB_TYPE_WAVEFRONT

MAX_STRIPS

OPTN_SEQUENCER

OPTN_CABAC

OPTN_ASPIC

OPTN_REB_SN

OPTN_DREB_SN

OPTN_DCDC_SYNC

OPTN_BOARD_DACS

OPTN_BOARD_POWER

OPTN_BOARD_TEMP

OPTN_STATUS

OPTN_CCD_TEMP

OPTN_SLOW_ADCS

OPTN_FAST_ADCS

OPTN_BACK_BIAS

FW_VERSION_INITIAL

FW_VERSION_UNSET

FW_VERSION_UNKNOWN

FW_VERSION_REB0_0

FW_VERSION_REB0_1

FW_VERSION_REB1_2

FW_VERSION_REB1_3

FW_VERSION_REB1_4

FW_VERSION_WREB_1

FW_VERSION_REB3

FW_VERSION_WREB_2

FW_VERSION_REB4_0

FW_VERSION_GREB_0

FW_VERSION_WREB_3

FW_VERSION_REB5_0

FW_VERSION_REB4_1

FW_VERSION_REB5_1

FW_VERSION_GREB_1

FW_VERSION_WREB_4

FW_VERSION_REB4_2

FW_VERSION_GREB_2

FW_VERSION_WREB_5

VERSION_UNSUPP

VERSION_0

VERSION_1

VERSION_2

VERSION_3

VERSION_4

VERSION_5