Package org.eclipse.scanning.api.device

Interface IActivatable

All Known Subinterfaces:
IScannable<T>
All Known Implementing Classes:
AbstractAreaDetectorRunnableDevice, AbstractMalcolmDevice, AbstractRunnableDevice, AbstractScannable, AreaDetectorRunnableDevice, AreaDetectorRunnableDeviceProxy, AreaDetectorRunnableDeviceWaitForArray, AreaDetectorWritingFilesRunnableDevice, BeamScannable, CalibrationFrameCollector, CompositeNexusScannable, ConstantVelocityDevice, CountableScannable, DarkImageDetector, DetectorCollectionScannable, DummyMalcolmDevice, DummyMalcolmTriggeredDetector, ElectronAnalyserRunnableDevice, FrameCollectingScannable, JythonScannableNexusWrapper, MalcolmDevice, MalcolmDeviceProxy, MandelbrotDetector, MockBeamOnMonitor, MockCountingPositionScannable, MockNeXusScannable, MockNeXusSlit, MockPausingMonitor, MockScannable, MockStringNexusScannable, MockStringScannable, MockTopupScannable, NexusSlitsWrapper, NXObjectScannable, NXSampleScannable, PosDetector, ProcessingMalcolmDevice, RandomIntDetector, RandomLineDevice, RunnableDeviceProxy, ScannableNexusWrapper, XmapRunnableDevice, XmapRunnableDeviceBase, XmapWritingFilesRunnableDevice, ZebraRunnableDevice
@Deprecated(since="GDA 9.7", forRemoval=true) public interface IActivatable
Deprecated, for removal: This API element is subject to removal in a future version.
whether monitors (i.e. scannables) will be included in the next scan or not should not be a property of the monitor on the server. Instead this should be configured in the client and used to determine the ScanRequest. Configuring this on the server caused a large number of client-server requests to build the ScanRequest by asking the server which monitors were activated. Default monitors can be configured by setting.
An interface for devices that are activatable and part of the scan. For runnable devices (detectors etc) they get included as detectors, for scannables activated scannables are included as monitors. This is normally used to mark detectors as being active so that if scan algorithm data is contstructed they will be included in the scan. NOTE: Normally the scan device is told specifically which detectors to use it does not take into account the isActivated() value when the scan is run. Instead this is used when the scan data is being constructed. Activated devices are used when a scan is constructed and the state is saved. This allows devices created in Spring to be activated and therefore run in a default scan. However the actual devices run in the scan are just defaulted to those activated. It is perfectly possible to run non-activated devices by putting them in the scan request. TODO: this interface is now deprecated and should be removed at some future point. This can only be done when the <activated> property has been removed from all beamline configuration files

  • Method Summary

    Modifier and Type
    Method
    Description
    default boolean
    isActivated()
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    default boolean
    setActivated(boolean activated)
    Deprecated, for removal: This API element is subject to removal in a future version.
     

  • Method Details

    • isActivated

      default boolean isActivated()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Returns:
      true if device is activated.

    • setActivated

      default boolean setActivated(boolean activated) throws ScanningException
      Deprecated, for removal: This API element is subject to removal in a future version.
      Parameters:
      activated -
      Returns:
      the old value of activated
      Throws:
      ScanningException