org.lsst.ccs.drivers.rcm
Class BaseSet

java.lang.Object
  extended by org.lsst.ccs.drivers.rcm.RegClient
      extended by org.lsst.ccs.drivers.rcm.BaseSet
Direct Known Subclasses:
BoardDacs, Cabac, PowerAdcs, Sequencer, StatusSet, TempAdcs

public class BaseSet
extends RegClient

Base register set access routines.

Author:
Owen Saxton

Field Summary
static int CLOCK_PERIOD_0
          Public constants.
static int CLOCK_PERIOD_1
          Public constants.
static int REG_ID
          Public constants.
static int REG_SCHEMA
          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_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 int VERSION_0
          Public constants.
static int VERSION_1
          Public constants.
static int VERSION_2
          Public constants.
static int VERSION_UNKNOWN
          Public constants.
static int VERSION_UNSET
          Public constants.
 
Constructor Summary
BaseSet()
          Constructors.
BaseSet(RegClient reg)
           
 
Method Summary
 void checkNotVersion(int version)
          Checks for not a particular firmware version
 void checkVersion(int version)
          Checks for a particular firmware 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 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()
          Gets the firmware version.
 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 waitDone(int regSet)
          Waits for a register set to become disabled, i.e.
 
Methods inherited from class org.lsst.ccs.drivers.rcm.RegClient
checkOpen, close, finalize, 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

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

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

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
Constructor Detail

BaseSet

public BaseSet()
Constructors.


BaseSet

public BaseSet(RegClient reg)
Method Detail

getVersion

public int getVersion()
               throws RcmException
Gets the firmware version.

Throws:
RcmException

checkVersion

public void checkVersion(int version)
                  throws RcmException
Checks for a particular firmware version

Throws:
RcmException

checkNotVersion

public void checkNotVersion(int version)
                     throws RcmException
Checks for not a particular firmware version

Throws:
RcmException

enable

public void enable()
            throws RcmException
Enables the time-base.

Throws:
RcmException

disable

public void disable()
             throws RcmException
Disables the time-base.

Throws:
RcmException

getTimeRaw

public long getTimeRaw()
                throws RcmException
Gets the raw time-base value.

Throws:
RcmException

getTime

public long getTime()
             throws RcmException
Gets the time-base value as millisecond Unix time.

Throws:
RcmException

setTimeRaw

public void setTimeRaw(long time)
                throws RcmException
Sets the raw time-base value.

Throws:
RcmException

setTime

public void setTime(long time)
             throws RcmException
Sets the time-base value as millisecond Unix time.

Throws:
RcmException

setTime

public void setTime()
             throws RcmException
Sets the time-base value to the current system time.

Throws:
RcmException

enable

public void enable(int regSet)
            throws RcmException
Enables a register set.

Throws:
RcmException

disable

public void disable(int regSet)
             throws RcmException
Disables a register set.

Throws:
RcmException

waitDone

public void waitDone(int regSet)
              throws RcmException
Waits for a register set to become disabled, i.e. operation done

Throws:
RcmException

getTriggerTimeRaw

public long getTriggerTimeRaw(int regSet)
                       throws RcmException
Gets the raw trigger time for a register set.

Throws:
RcmException

getTriggerTime

public long getTriggerTime(int regSet)
                    throws RcmException
Gets the trigger time for a register set as Unix millisecond time.

Throws:
RcmException


Copyright © 2013 LSST. All Rights Reserved.