BaseSet (LSST Camera Control Software

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

Direct Known Subclasses:

Asic, AsicAdcs, BoardDacs, PowerAdcs, Sequencer, StatusSet, TempAdcs, TempRtds
```
public class BaseSet
extends RegClient
```
Base register set access routines.

Author:

Owen Saxton

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`CLOCK_PERIOD_0` Public constants.
`static int`	`CLOCK_PERIOD_1` Public constants.
`static int`	`OPTN_ASIC_TEMP` 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_STATUS` 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`	`TYPE_CORNER` Public constants.
`static int`	`TYPE_SCIENCE` Public constants.
`static int`	`TYPE_UNKNOWN` Public constants.
`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_UNKNOWN` Public constants.
`static int`	`VERSION_UNSET` Public constants.
`static int`	`VERSION_UNSUPP` Public constants.

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 a particular option version.
`void`	`checkVersion(int option, int... version)` Checks for a particular option version.
`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.
`long`	`getRebSerial()` Gets the REB serial number.
`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`	`isDcdcSync()` Gets the DC/DC synchronization.
`boolean`	`isVersion(int option, int... version)` Tests for a particular option version.
`void`	`setDcdcSync(boolean enable)` Sets the DC/DC synchronization.
`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`	`setVersions()` Sets the version of each option.
`void`	`waitDone(int regSet)` 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, 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
  - 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_ASIC_TEMP
```
public static final int OPTN_ASIC_TEMP
```
    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
  - VERSION_UNSET
```
public static final int VERSION_UNSET
```
    Public constants.
    
    See Also:
    
    Constant Field Values
  - VERSION_UNKNOWN
```
public static final int VERSION_UNKNOWN
```
    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
  - TYPE_UNKNOWN
```
public static final int TYPE_UNKNOWN
```
    Public constants.
    
    See Also:
    
    Constant Field Values
  - TYPE_SCIENCE
```
public static final int TYPE_SCIENCE
```
    Public constants.
    
    See Also:
    
    Constant Field Values
  - TYPE_CORNER
```
public static final int TYPE_CORNER
```
    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
  - getFwVersion
```
public int getFwVersion()
                 throws REBException
```
    Gets the firmware version.
    
    Returns:
    
    The firmware version 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 the versions match
    
    Throws:
    
    REBException - if the firmware version is not recognized
  - checkVersion
```
public void checkVersion(int option,
                         int... version)
                  throws REBException
```
    Checks for a particular option version.
    
    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 doesn't match the specified version
  - checkNotVersion
```
public void checkNotVersion(int option,
                            int... version)
                     throws REBException
```
    Checks for not a particular option version.
    
    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 the specified version
  - 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
  - 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
  - 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
    
    Parameters:
    
    regSet - The register set identifier
    
    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
  - setVersions
```
public void setVersions()
                 throws REBException
```
    Sets the version of each option.
    
    Throws:
    
    REBException - if the firmware version is not recognized

Class BaseSet

Field Summary

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

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_ASIC_TEMP

OPTN_FAST_ADCS

OPTN_BACK_BIAS

VERSION_UNSET

VERSION_UNKNOWN

VERSION_UNSUPP

VERSION_0

VERSION_1

VERSION_2

VERSION_3

VERSION_4

VERSION_5

TYPE_UNKNOWN

TYPE_SCIENCE

TYPE_CORNER

CLOCK_PERIOD_0

CLOCK_PERIOD_1

SN_READ_OKAY

SN_READ_ERROR

SN_READ_TIMEOUT

SN_VALUE_MASK

Constructor Detail

BaseSet

BaseSet

Method Detail

getFwVersion

getVersion

getVersion

isVersion

checkVersion

checkNotVersion

enable

disable

getTimeRaw

getTime

setTimeRaw

setTime

setTime

enable

disable

waitDone

getTriggerTimeRaw

getTriggerTime

getRebSerial