org.lsst.ccs.framework

Interface HardwareController

public interface HardwareController

codes that implement this interface are supposed to handle hardware either directly or through subComponents (children).

Author:

bamade

Method Summary

Modifier and Type	Method and Description
TreeWalkerDiag	checkHardware() this method will be invoked by the subsystem as part of the startup or of a clean check after an incident.
void	checkStarted() sent to check if the hardware had been started.
void	checkStopped() sent to check if the hardware had been stopped.

Method Detail

checkHardware

TreeWalkerDiag checkHardware()
                      throws HardwareException

this method will be invoked by the subsystem as part of the startup or of a clean check after an incident.
the order of invocations is the order of declaration of components in the description file.
It's up to the implementer to decide if the framework should call the method on its children or not (see TreeWalkerDiag)

Throws:

HardwareException

checkStarted

void checkStarted()
           throws HardwareException

sent to check if the hardware had been started.

Todo: argument

Throws:

HardwareException - if not started

checkStopped

void checkStopped()
           throws HardwareException

sent to check if the hardware had been stopped.

Todo: argument (example: we are not stopping the subsystem)

Throws:

HardwareException - if not stopped