org.lsst.ccs.drivers.rcm

Class StatusSet

java.lang.Object

org.lsst.ccs.drivers.rcm.RegClient

org.lsst.ccs.drivers.rcm.BaseSet

org.lsst.ccs.drivers.rcm.StatusSet

public class StatusSet
extends BaseSet

RCM status block access routines.

Author:

Owen Saxton

Field Summary

Fields

Modifier and Type	Field and Description
static int	NUM_STAT_REG Public constants.
static int	OFF_STAT_BUFFSTAT Public constants.
static int	OFF_STAT_CERR_CNT Public constants.
static int	OFF_STAT_LDWN_CNT Public constants.
static int	OFF_STAT_LERR_CNT Public constants.
static int	OFF_STAT_LINKSTAT Public constants.
static int	OFF_STAT_RX_CNTS Public constants.
static int	OFF_STAT_TX_CNTS Public constants.
static int	OFF_STAT_VERSION Public constants.
static int	REG_STATUS Public constants.
static int	REG_STATUS_0 Public constants.

Fields inherited from class org.lsst.ccs.drivers.rcm.BaseSet

CLOCK_PERIOD_0, CLOCK_PERIOD_1, REG_DCDC_SYNC, REG_ID, REG_SCHEMA, REG_SN_DREB_START, REG_SN_DREB_VALUE, REG_SN_REB_START, REG_SN_REB_VALUE, REG_STATE, REG_TIME_BASE, REG_TRIG_TIME, REG_TRIGGER, REG_VERSION, RSET_POWER_ADCS, RSET_SEQUENCER, RSET_STATUS, RSET_TEMP_ADCS, RSET_TIME_BASE, SN_READ_ERROR, SN_READ_OKAY, SN_READ_TIMEOUT, SN_VALUE_MASK, VERSION_0, VERSION_1, VERSION_2, VERSION_3, VERSION_CURR, VERSION_UNKNOWN, VERSION_UNSET

Constructor Summary

Constructors

Constructor and Description
StatusSet() Constructors.
StatusSet(RegClient reg)

Method Summary

Methods

Modifier and Type	Method and Description
void	disable() Disables the status block.
void	enable() Enables the status block.
long	getTriggerTime() Gets the status block trigger time.
Status	readStatus() Reads the status block.

Methods inherited from class org.lsst.ccs.drivers.rcm.BaseSet

checkNotVersion, checkVersion, checkVersion, disable, enable, getDrebSN, getRebSN, getTime, getTimeRaw, getTriggerTime, getTriggerTimeRaw, getVersion, isDcdcSync, setDcdcSync, setTime, setTime, setTimeRaw, waitDone

Methods inherited from class org.lsst.ccs.drivers.rcm.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

REG_STATUS_0

public static final int REG_STATUS_0

Public constants.

See Also:

Constant Field Values

REG_STATUS

public static final int REG_STATUS

Public constants.

See Also:

Constant Field Values

OFF_STAT_VERSION

public static final int OFF_STAT_VERSION

Public constants.

See Also:

Constant Field Values

OFF_STAT_LINKSTAT

public static final int OFF_STAT_LINKSTAT

Public constants.

See Also:

Constant Field Values

OFF_STAT_CERR_CNT

public static final int OFF_STAT_CERR_CNT

Public constants.

See Also:

Constant Field Values

OFF_STAT_LDWN_CNT

public static final int OFF_STAT_LDWN_CNT

Public constants.

See Also:

Constant Field Values

OFF_STAT_LERR_CNT

public static final int OFF_STAT_LERR_CNT

Public constants.

See Also:

Constant Field Values

OFF_STAT_BUFFSTAT

public static final int OFF_STAT_BUFFSTAT

Public constants.

See Also:

Constant Field Values

OFF_STAT_RX_CNTS

public static final int OFF_STAT_RX_CNTS

Public constants.

See Also:

Constant Field Values

OFF_STAT_TX_CNTS

public static final int OFF_STAT_TX_CNTS

Public constants.

See Also:

Constant Field Values

NUM_STAT_REG

public static final int NUM_STAT_REG

Public constants.

See Also:

Constant Field Values

Constructor Detail

StatusSet

public StatusSet()

Constructors.

StatusSet

public StatusSet(RegClient reg)

Method Detail

enable

public void enable()
            throws RcmException

Enables the status block.

Overrides:

enable in class BaseSet

Throws:

RcmException

disable

public void disable()
             throws RcmException

Disables the status block.

Overrides:

disable in class BaseSet

Throws:

RcmException

getTriggerTime

public long getTriggerTime()
                    throws RcmException

Gets the status block trigger time.

Returns:

The Unix millisecond time of the last status block trigger

Throws:

RcmException

readStatus

public Status readStatus()
                  throws RcmException

Reads the status block.

Returns:

The contents of the status block, as a Status object

Throws:

RcmException