org.lsst.ccs.monitor

Class Control

java.lang.Object

org.lsst.ccs.monitor.Control

All Implemented Interfaces:

HasLifecycle

public abstract class Control
extends Object
implements HasLifecycle

Implements a control "channel".

Author:

Owen Saxton

Field Summary

Fields

Modifier and Type	Field and Description
protected String	description Data fields.
protected Device	devc
protected int	hwChan
protected Logger	log
protected Monitor	mon

Constructor Summary

Constructors

Constructor and Description
Control()

Method Summary

Modifier and Type	Method and Description
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.
String	getDescription() Gets the channel description.
int	getHwChan() Gets the hardware channel number.
String	getName() Get the name as specified in the lookup tree for this object.
Subsystem	getSubsystem() Get the Subsystem this object belongs to.
void	init() Called from the enclosing Subsystem at initialization phase.
protected boolean	testOnline() Deprecated. this method will be removed. No replacement will be provided.

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.HasLifecycle

build, postBuild, postInit, postShutdown, postStart, shutdown, start

Field Detail

description

protected String description

Data fields.

hwChan

protected int hwChan

devc

@LookupField(strategy=ANCESTORS)
protected Device devc

mon

@LookupField(strategy=TREE)
protected Monitor mon

log

protected Logger log

Constructor Detail

Control

public Control()

Method Detail

init

public void init()

Description copied from interface: HasLifecycle

Called from the enclosing Subsystem at initialization phase.

This method is called before the children components of this object have their init method called.

At the time it is called, connection to the messaging layer is not yet done, so there should be no attempt to send messages in the body of this method. Configuration for message listening can nevertheless be done here, such as adding MessageListener objects.

It is unnecessary to call super.init()

Specified by:

init in interface HasLifecycle

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

checkOnline

protected void checkOnline()

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

testOnline

@Deprecated
protected boolean testOnline()

Deprecated. this method will be removed. No replacement will be provided.

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

getName

public String getName()

Get the name as specified in the lookup tree for this object.

Returns:

The name of this object.

getSubsystem

public Subsystem getSubsystem()

Get the Subsystem this object belongs to.

Returns:

The Subsystem in which this node is defined.