Package org.eclipse.scanning.sequencer.watchdog

Class AbstractWatchdog<T extends IDeviceWatchdogModel>

java.lang.Object

org.eclipse.scanning.sequencer.watchdog.AbstractWatchdog<T>

All Implemented Interfaces:

IDeviceWatchdog<T>, IModelProvider<T>, INameable

Direct Known Subclasses:

ExpressionWatchdog, TopupWatchdog

public abstract class AbstractWatchdog<T extends IDeviceWatchdogModel>
extends Object
implements IDeviceWatchdog<T>

Field Summary

Fields

Modifier and Type	Field	Description
protected boolean	active
protected IDeviceController	controller
protected T	model

Constructor Summary

Constructors

Constructor	Description
AbstractWatchdog()

Method Summary

Modifier and Type	Method	Description
void	activate()	Used by spring
void	deactivate()	Make this device inactive, removes the watchdog from the service.
IDeviceController	getController()
T	getModel()
String	getName()	Name of the scannable
protected <S> IScannable<S>	getScannable(String name)
boolean	isActive()
boolean	isEnabled()	A disabled watch dog does not participate in a scan, but is not removed from the service.
void	scanFinally()
void	scanStarted()
void	setController(IDeviceController controller)	Called by the framework when a device is created to run with a specific scan.
void	setEnabled(boolean enabled)	A disabled watch dog does not participate in a scan, but is not removed from the service.
void	setModel(T model)	The model for some providers may be set but be warned that others throw an IllegalArgumentException.
void	setName(String name)	Set the name of the device.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.eclipse.scanning.api.device.IDeviceWatchdog

getId, isPausing

Methods inherited from interface org.eclipse.scanning.api.IModelProvider

updateModel

Field Details

model

protected T extends IDeviceWatchdogModel model

controller

protected IDeviceController controller

active

protected boolean active

Constructor Details

AbstractWatchdog

public AbstractWatchdog()

Method Details

getModel

public T getModel()

Specified by:

getModel in interface IModelProvider<T extends IDeviceWatchdogModel>

Returns:

the model that we are providing

setModel

public void setModel(T model)

Description copied from interface: IModelProvider

The model for some providers may be set but be warned that others throw an IllegalArgumentException.

Specified by:

setModel in interface IModelProvider<T extends IDeviceWatchdogModel>

Parameters:

model -

getScannable

protected <S> IScannable<S> getScannable(String name)
                                  throws ScanningException

Throws:

ScanningException

activate

public void activate()

Used by spring

Specified by:

activate in interface IDeviceWatchdog<T extends IDeviceWatchdogModel>

deactivate

public void deactivate()

Description copied from interface: IDeviceWatchdog

Make this device inactive, removes the watchdog from the service.

Specified by:

deactivate in interface IDeviceWatchdog<T extends IDeviceWatchdogModel>

getController

public IDeviceController getController()

setController

public void setController(IDeviceController controller)

Description copied from interface: IDeviceWatchdog

Called by the framework when a device is created to run with a specific scan.

Specified by:

setController in interface IDeviceWatchdog<T extends IDeviceWatchdogModel>

scanStarted

public void scanStarted()

scanFinally

public void scanFinally()

isActive

public boolean isActive()

Specified by:

isActive in interface IDeviceWatchdog<T extends IDeviceWatchdogModel>

Returns:

true if the watchdog is active in a scan and checking things.

getName

public String getName()

Description copied from interface: INameable

Name of the scannable

Specified by:

getName in interface INameable

Returns:

setName

public void setName(String name)

Description copied from interface: INameable

Set the name of the device.

Specified by:

setName in interface INameable

Parameters:

name -

isEnabled

public boolean isEnabled()

Description copied from interface: IDeviceWatchdog

A disabled watch dog does not participate in a scan, but is not removed from the service. *

Specified by:

isEnabled in interface IDeviceWatchdog<T extends IDeviceWatchdogModel>

setEnabled

public void setEnabled(boolean enabled)

Description copied from interface: IDeviceWatchdog

A disabled watch dog does not participate in a scan, but is not removed from the service.

Specified by:

setEnabled in interface IDeviceWatchdog<T extends IDeviceWatchdogModel>

Parameters:

enabled -