Package gda.beamline.health

Class ComponentHealthConditionBase

java.lang.Object

gda.factory.ConfigurableBase

gda.factory.FindableConfigurableBase

gda.beamline.health.ComponentHealthConditionBase

All Implemented Interfaces:

ComponentHealthCondition, Configurable, Findable

Direct Known Subclasses:

ScannableHealthCondition, ServerCondition

public abstract class ComponentHealthConditionBase
extends FindableConfigurableBase
implements ComponentHealthCondition

Constructor Summary

Constructors

Constructor	Description
ComponentHealthConditionBase()

Method Summary

Modifier and Type	Method	Description
protected abstract BeamlineHealthState	calculateHealthState()
void	configure()	Default implementation for classes that do not have to do any specific configuration. Classes that do their own configuration should *not* call this superclass function, as it may cause the object to appear configured before it really is.
String	getCurrentState()	Return the current state of the component. For a scannable, this would be its position: for a service, it could indicate whether it is running, paused etc.
protected String	getDefaultErrorMessage()
String	getDescription()	Return a user-friendly description of the component e.g.
String	getErrorMessage()	Return a message that can be displayed to the user is the corresponding condition is not met
BeamlineHealthState	getHealthState()	Return the health state for this component, based on the condition itself and whether it is critical for the functioning of the beamline.
boolean	isCritical()	Indicate whether this is critical for the overall health of the beamline
boolean	isEnabled()	Indicates whether the condition is enabled.
protected abstract String	readCurrentState()
void	setCritical(boolean critical)
void	setDescription(String description)
void	setEnabled(boolean enabled)
void	setErrorMessage(String errorMessage)
String	toString()

Methods inherited from class gda.factory.FindableConfigurableBase

getName, setName

Methods inherited from class gda.factory.ConfigurableBase

isConfigureAtStartup, isConfigured, reconfigure, setConfigured

Methods inherited from class java.lang.Object

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

Constructor Details

ComponentHealthConditionBase

public ComponentHealthConditionBase()

Method Details

configure

public void configure()
               throws FactoryException

Description copied from class: ConfigurableBase

Default implementation for classes that do not have to do any specific configuration.
Classes that do their own configuration should *not* call this superclass function, as it may cause the object to appear configured before it really is.

Specified by:

configure in interface Configurable

Overrides:

configure in class ConfigurableBase

Throws:

FactoryException - if there is an error in configuration e.g. required variable not set or cannot connect to device

getDefaultErrorMessage

protected String getDefaultErrorMessage()

getCurrentState

public String getCurrentState()

Description copied from interface: ComponentHealthCondition

Return the current state of the component.
For a scannable, this would be its position: for a service, it could indicate whether it is running, paused etc.

Specified by:

getCurrentState in interface ComponentHealthCondition

readCurrentState

protected abstract String readCurrentState()

getHealthState

public BeamlineHealthState getHealthState()

Description copied from interface: ComponentHealthCondition

Return the health state for this component, based on the condition itself and whether it is critical for the functioning of the beamline.

Specified by:

getHealthState in interface ComponentHealthCondition

calculateHealthState

protected abstract BeamlineHealthState calculateHealthState()

getDescription

public String getDescription()

Description copied from interface: ComponentHealthCondition

Return a user-friendly description of the component e.g. for display in the GUI

Specified by:

getDescription in interface ComponentHealthCondition

setDescription

public void setDescription(String description)

Specified by:

setDescription in interface ComponentHealthCondition

getErrorMessage

public String getErrorMessage()

Description copied from interface: ComponentHealthCondition

Return a message that can be displayed to the user is the corresponding condition is not met

Specified by:

getErrorMessage in interface ComponentHealthCondition

setErrorMessage

public void setErrorMessage(String errorMessage)

Specified by:

setErrorMessage in interface ComponentHealthCondition

isCritical

public boolean isCritical()

Description copied from interface: ComponentHealthCondition

Indicate whether this is critical for the overall health of the beamline

Specified by:

isCritical in interface ComponentHealthCondition

setCritical

public void setCritical(boolean critical)

Specified by:

setCritical in interface ComponentHealthCondition

isEnabled

public boolean isEnabled()

Description copied from interface: ComponentHealthCondition

Indicates whether the condition is enabled.

Specified by:

isEnabled in interface ComponentHealthCondition

setEnabled

public void setEnabled(boolean enabled)

Specified by:

setEnabled in interface ComponentHealthCondition

toString

public String toString()

Overrides:

toString in class Object