Package org.eclipse.scanning.api

Interface ITerminatable

All Known Implementing Classes:

MockBeamOnMonitor, MockCountingPositionScannable, MockNeXusScannable, MockNeXusSlit, MockPausingMonitor, MockScannable, MockTopupScannable

public interface ITerminatable

A device that may be terminated, such as a motor moving to a location, may implement this interface. TODO Should we have an annotation for the termination instead? The current methodology is that core things like terminate and setPosition are in interfaces and extra things which are optional to implement inside a scan are done with annotations.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static enum	ITerminatable.TerminationPreference

Method Summary

Modifier and Type	Method	Description
void	terminate(ITerminatable.TerminationPreference pref)	## Blocking Call ##

Method Details

terminate

void terminate(ITerminatable.TerminationPreference pref)
        throws Exception

## Blocking Call ##

Terminate the move of a given device such that if it is moving, it will stop where it is. The termination preference defines if the device should do a panic stop if it supports such an action. Many devices have one type of stop, therefore in their cases the preference to panic or controlled (etc) is treated as aspiration rather than reality i.e. ignored.

Important: This call is blocking, it does not only set a flag to stop the move and return but it blocks until we are done moving! For instance it uses a CountDownLatch which is started on the move and released whenever the move is exited.

Parameters:

pref -

Throws:

Exception