Package org.eclipse.scanning.api.device

package org.eclipse.scanning.api.device
  • Class
    Description
    AbstractRunnableDevice<T>
    A device should create its own model when its constructor is called.
    DeviceRequestHandler
    TODO FIXME Is the idea of having request/response calls correct for exposing services on the server to the client? Disadvantages: 1.
    IActivatable
    Deprecated, for removal: This API element is subject to removal in a future version.
    whether monitors (i.e.
    IDeviceController
    A device controller takes input from several clients and ensures that each of their preferences about pausing the device being controlled is taken into account.
    IDeviceWatchdog<T extends IDeviceWatchdogModel>
    A watchdog may be started to run with a scan.
    IDeviceWatchdogService
    Welcome to Watchdogs
    IPausableDevice<T>
     
    IResettableDevice
     
    IRunnableDevice<T>
    An IDevice is the runner for the whole scan but also for individual detectors.
    IRunnableDeviceService
    Anatomy of a CPU scan (non-malcolm)
     _________
    _|           |________ collectData() Tell detector to collect
                 _________
    _________|           |_ readout() Tell detector to readout
                 _______
    _________|         |___ moveTo() Scannables move motors to new position


    A MalcolmDevice is also an IScanner which may operate with an arbitrary model, usually driving hardware.

    IParserService pservice = ...// OSGi

    // Parse the scan command, throws an exception
    IParserResult parser = pservice.createParser(...)
    // e.g.
    IRunnableEventDevice<T>
    A runnable device which also allows the ability to listen to when it will run and after it has run.
    IScanDevice
    An IRunnableDevice that performs a scan when its IRunnableDevice.run() method is called.
    IScannableDeviceService
    Clients do not need to consume this service, it is used to provide connection to devices which already exist, like those in GDA8.
    IWritableDetector<T>
    Anatomy of a CPU scan (non-malcolm) Making GDA8 Detectors work with GDA9 (org.eclipse.scanning) requires usage of the GDA8 IHardwareConnectionService.
    PositionerRequestHandler
     
    ScanRole
    An enumeration of the roles that a device can have in a scan.