org.lsst.ccs.framework

Interface HardwareController

All Known Implementing Classes:

CalcDevice, Device

Deprecated.

This is to be replaced with corresponding methods in the HasLifecycle interface

@Deprecated
public interface HardwareController

Interface to implement for components that handle direct or indirect interaction with hardware. The methods of this interface, when overridden, will be invoked by the framework at specific times of its life cycle.

Note that these methods are invoked as part of a top to bottom tree walking of the components that make the modular structure of the enclosing subsystem.

Author:

bamade

Method Summary

Modifier and Type	Method and Description
default TreeWalkerDiag	checkHardware() Deprecated. This is to be replaced with corresponding methods in the HasLifecycle interface
default void	checkStarted() Deprecated. This is to be replaced with corresponding methods in the HasLifecycle interface
default void	checkStopped() Deprecated. This is to be replaced with corresponding methods in the HasLifecycle interface

Method Detail

checkHardware

@Deprecated
default TreeWalkerDiag checkHardware()
                                          throws HardwareException

Deprecated. This is to be replaced with corresponding methods in the HasLifecycle interface

Override to initiate interaction with the hardware. First interaction with low level hardware should take place in the body of this method. At the time it is called, the enclosing subsystem has connected to the messaging layer and is in PhaseState.INITIALIZING state.

If accessing the hardware is considered as having failed, this method should throw an HardwareException. This will interrupt the startup process and make the subsystem go to OperationalState.ENGINEERING_FAULT. The startup process will be resumed with a call to Subsystem.completeInitialization() that will invoke checkStarted()

If this method is considered having succeeded, the state remains to OperationalState.ENGINEERING_OK

Returns:

a TreeWalkerDiag indicating if this component has already performed hardware checking for its own components (HANDLING_CHILDREN) or if the framework should do it (GO)

Throws:

HardwareException - if any failure interacting with the hardware occurs. The exception is caught by the framework.

checkStarted

@Deprecated
default void checkStarted()
                               throws HardwareException

Deprecated. This is to be replaced with corresponding methods in the HasLifecycle interface

Override to check that all hardware is correctly initiated. Note that this method is only invoked by the framework when the previous step failed. It is triggered by a call to Subsystem.completeInitialization()

If a failure in the way the hardware has been started is noticed, the implementation should throw an HardwareException. This will interrupt the startup process and make the subsystem remain in OperationalState.ENGINEERING_FAULT. The startup process will be resumed with a subsequent call to Subsystem.completeInitialization()

Throws:

HardwareException - if a failure is noticed in the way hardware is started.

checkStopped

@Deprecated
default void checkStopped()
                               throws HardwareException

Deprecated. This is to be replaced with corresponding methods in the HasLifecycle interface

Override with specific code to stop the hardware. It is invoked upon calls to Agent.shutdown() or Subsystem.stop(long). At the time it is called, the enclosing subsystem is in PhaseState.CLOSING phase

If a failure in stopping hardware is noticed, the implementation should throw an HardwareException. This will interrupt the shutdown process

If no HardwareException is thrown, the shutdown process will resume.

Throws:

HardwareException - if a failure occurs while stopping the hardware.