org.lsst.ccs.subsystem.monitor

Class Control

java.lang.Object

org.lsst.ccs.framework.ConfigurableComponent

org.lsst.ccs.subsystem.monitor.Control

All Implemented Interfaces:

org.lsst.ccs.framework.Configurable

public abstract class Control
extends org.lsst.ccs.framework.ConfigurableComponent

Implements a control "channel".

Author:

Owen Saxton

Nested Class Summary

Nested classes/interfaces inherited from interface org.lsst.ccs.framework.Configurable

org.lsst.ccs.framework.Configurable.Environment

Field Summary

Fields

Modifier and Type	Field and Description
protected String	description Data fields.
protected Device	devc
protected int	hwChan
protected org.lsst.ccs.utilities.logging.Logger	log
protected Monitor	mon

Fields inherited from class org.lsst.ccs.framework.ConfigurableComponent

environment

Constructor Summary

Constructors

Constructor and Description
Control(String desc, int hwChan) Constructor.

Method Summary

Modifier and Type	Method and Description
abstract void	addConfigValues(Map<String,Object> map) Adds to a map of configured values.
protected void	checkOnline() Checks the online state.
protected void	checkTimeout(Exception e, Class<?> eClass) Checks whether exception is a timeout.
protected void	configure(Monitor mon, Device devc) Configures common part of control channel.
Map<String,Object>	getConfigValues() Gets the map of configured values.
String	getDescription() Gets the channel description.
int	getHwChan() Gets the hardware channel number.
protected boolean	testOnline() Tests the online state.

Methods inherited from class org.lsst.ccs.framework.ConfigurableComponent

getChildren, getEnvironment, setEnvironment

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.framework.Configurable

alias, change, getCheckedValueFromConfiguration, getComponentByName, getFullPath, getName, getParent, getParentObject, getSubsystem, init, injectResources, listChildren, notifyChange, notifyChangeWithoutPreliminaryChecks, postStart, proceduralWalk, shutdownNow, start, treeWalk

Field Detail

description

protected final String description

Data fields.

hwChan

protected final int hwChan

devc

protected Device devc

mon

protected Monitor mon

log

protected org.lsst.ccs.utilities.logging.Logger log

Constructor Detail

Control

public Control(String desc,
               int hwChan)

Constructor.

Parameters:

desc - The descriptive name

hwChan - The hardware channel number

Method Detail

configure

protected void configure(Monitor mon,
                         Device devc)

Configures common part of control channel.

Parameters:

mon - The associated monitor

devc - The associated device

getDescription

public String getDescription()

Gets the channel description.

Returns:

The description

getHwChan

public int getHwChan()

Gets the hardware channel number.

Returns:

The hardware channel number

getConfigValues

public Map<String,Object> getConfigValues()

Gets the map of configured values.

Returns:

The map of configured values

addConfigValues

public abstract void addConfigValues(Map<String,Object> map)

Adds to a map of configured values.

Parameters:

map - The map of configured values to be updated

checkOnline

protected void checkOnline()

Checks the online state. If offline, an attempt is made to re-initialize the device.

testOnline

protected boolean testOnline()

Tests the online state. If offline, an error message is logged.

Returns:

Whether or not the device is online.

checkTimeout

protected void checkTimeout(Exception e,
                            Class<?> eClass)
                     throws Exception

Checks whether exception is a timeout. If it is a timeout, the device is set offline. In all cases an exception of the supplied class is thrown, containing the message of the original exception.

Parameters:

e - The exception to be checked.

eClass - The class of the exception to be thrown.

Throws:

Exception