stella

Interface ErrorHandling

All Superinterfaces:

ClusterDepending, ErrorListener, EventListener, PropertySupplying

All Known Implementing Classes:

AbstractErrorHandler, MasterErrorHandler

public interface ErrorHandling
extends PropertySupplying, ErrorListener, ClusterDepending

The basic interface defining error handling capabilities. Any error handler should listen to error originating from the peripheral network devices as well as internal (i.e. SCS) errors. It is the handlers responsibility to properly register as an error event listener to the peripherals. The error handler should alter sequencing steps in case of certain errors, accordingly the sequencer is registered with registerSequencer(stella.Sequencing). To pipe error or status messages to the parameter cluster, the parameter cluster must be registered to the error caster as well, see #registerCluster. Any error that affect target selection in the scheduler are either transported in the parameter cluster or, if they directly interfere with the target, registered in the Appointable.isAbort(globals.GlobalGrouping) method. For correct error chaining of multiple targets, the master mind should always signal new targets picked to the error handler, see startTarget(stella.Handable) and endTarget(stella.Handable).

Field Summary

Fields inherited from interface util.PropertySupplying

CONFIG, KEY_CLASS

Method Summary

Modifier and Type	Method and Description
boolean	doAbort() Returns true, if target should be aborted.
void	endTarget(Handable end) Signals that a target has finished.
void	registerLauncher(CommandLaunching[] launch) Registers the command launching interfaces to the error handler.
void	registerMonitor(Object sleeper) Registers a monitor to the error handler.
void	registerSequencer(Sequencing sequencer) Registers the sequencer to the error handler.
void	registerWeather(WeatherSurveying weather) Registers a local weather station constructed within the MasterMind to the error handler.
void	setEnabled(boolean accept) Sets the enabled flag.
void	startTarget(Handable start) Signals that a new target has been picked.

Methods inherited from interface util.PropertySupplying

defaultBoolean, defaultChar, defaultDouble, defaultFloat, defaultInt, defaultLong, defaultObject, defaultObject, defaultProperties, defaultProperty, getAsBoolean, getAsChar, getAsDouble, getAsFloat, getAsInt, getAsList, getAsLong, getAsMap, getAsObject, getAsObject, getProperties, getProperty, has, parseObject, removeProperty, setObject, setProperty, stringProperties

Methods inherited from interface stella.ErrorListener

errorOccured

Methods inherited from interface stella.ClusterDepending

registerGlobals

Method Detail

registerLauncher

void registerLauncher(CommandLaunching[] launch)

Registers the command launching interfaces to the error handler. Intended for low-level command submission or re-submission.

registerSequencer

void registerSequencer(Sequencing sequencer)

Registers the sequencer to the error handler. In case of errors the actual observing sequence will be broken and alternate steps must be loaded into the sequencer.

registerWeather

void registerWeather(WeatherSurveying weather)

Registers a local weather station constructed within the MasterMind to the error handler. Normal error handler will use their remote weather-listening capabilities to listen to weather changes.

setEnabled

void setEnabled(boolean accept)

Sets the enabled flag. Any error handler that is disabled should receive errors, but ignore them. During critical setup-sections, the error handler may also disable itself, thus the owner of the handler should always enable the error handler prior to starting itself.

registerMonitor

void registerMonitor(Object sleeper)

Registers a monitor to the error handler. A monitor is mainly used for ErrorFinalizing instances that need to awaken a sleeping object.

doAbort

boolean doAbort()

Returns true, if target should be aborted. May also block a selected target before its actual sequence steps are loaded.

startTarget

void startTarget(Handable start)

Signals that a new target has been picked. All started targets should be buffered inside the error handler to allow correct back-traversal of errors occuring during (daughter) targets. The started target should be removed from this list when the endTarget(stella.Handable) method is invoked.

endTarget

void endTarget(Handable end)

Signals that a target has finished. No success flag is passed, as errors occuring during target execution should directly radiate to the ErrorListener capabilities of the error handler. Once a target has been ended, it is removed from the handlers current list and errors occuring later may no longer affect the target.