Package org.eclipse.scanning.api

Interface IModelProvider<T>

Type Parameters:

T -

All Known Subinterfaces:

IDeviceWatchdog<T>, IMalcolmDevice, IModelViewer<T>, IPausableDevice<T>, IPointGenerator<T>, IRunnableDevice<T>, IRunnableEventDevice<T>, IScanDevice, IWritableDetector<T>

All Known Implementing Classes:

AbstractAreaDetectorRunnableDevice, AbstractGenerator, AbstractLineGenerator, AbstractMalcolmDevice, AbstractMultiGenerator, AbstractRunnableDevice, AbstractScanPointGenerator, AbstractWatchdog, AreaDetectorRunnableDevice, AreaDetectorRunnableDeviceProxy, AreaDetectorRunnableDeviceWaitForArray, AreaDetectorWritingFilesRunnableDevice, AxialArrayGenerator, AxialCollatedStepGenerator, CompoundGenerator, ConcurrentMultiGenerator, ConsecutiveMultiGenerator, ConstantVelocityDevice, DarkImageDetector, DetectorScanUIElement, DeviceInformation, DummyMalcolmDevice, DummyMalcolmTriggeredDetector, ElectronAnalyserRunnableDevice, ExpressionWatchdog, MalcolmDevice, MalcolmDeviceProxy, MandelbrotDetector, ModelViewer, NoModelGenerator, PosDetector, ProcessingMalcolmDevice, RandomIntDetector, RandomLineDevice, RunnableDeviceProxy, TopupWatchdog, TwoAxisGridPointsGenerator, TwoAxisGridPointsRandomOffsetGenerator, TwoAxisLinePointsGenerator, TwoAxisLissajousGenerator, TwoAxisPointSingleGenerator, TwoAxisPtychographyGenerator, TypeEditor, XmapRunnableDevice, XmapRunnableDeviceBase, XmapWritingFilesRunnableDevice, ZebraRunnableDevice

Functional Interface:

This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.

@FunctionalInterface
public interface IModelProvider<T>

A model provider is any object that holds a model.

Method Summary

Modifier and Type	Method	Description
T	getModel()
default void	setModel(T model)	The model for some providers may be set but be warned that others throw an IllegalArgumentException.
default void	updateModel(T model)	The model for some providers may be updated but be warned that others throw an IllegalArgumentException.

Method Details

getModel

T getModel()
    throws Exception

Returns:

the model that we are providing

Throws:

Exception

setModel

default void setModel(T model)
               throws Exception

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

Parameters:

model -

Throws:

Exception

updateModel

default void updateModel(T model)
                  throws Exception

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

Parameters:

model -

Throws:

Exception