Interface IScanService

All Superinterfaces:
IPositionerService, IRunnableDeviceService
All Known Implementing Classes:
RunnableDeviceServiceImpl

public interface IScanService extends IRunnableDeviceService
This interface is used to provide custom scanning methods to the IRunnableDeviceService.
  • Method Details

    • addScanParticipant

      void addScanParticipant(Object device)
      Used to register a scan participant. Once registered any scan created will use the participant.
      Parameters:
      device -
    • removeScanParticipant

      void removeScanParticipant(Object device)
      Used to remove a scan participant. Once registered any scan created will use the participant it must be removed to stop this.
      Parameters:
      device -
    • getScanParticipants

      Collection<Object> getScanParticipants()
      The list of objects to be run as participants with the scan.
      Returns:
    • createScanDevice

      IScanDevice createScanDevice(ScanModel model) throws ScanningException
      Create and configure a new device that represents a scan.
      Parameters:
      model - The model providing the configuration for the scan
      Returns:
      A new IScanDevice
      Throws:
      ScanningException
    • createScanDevice

      IScanDevice createScanDevice(ScanModel model, boolean configure) throws ScanningException
      Create and configure a new device that represents a scan. Configure it if requested. TODO: Use Builder pattern rather than a flag?
      Parameters:
      model - The model providing the configuration for the scan
      configure - Should the new device be automatically configured?
      Returns:
      A new IScanDevice
      Throws:
      ScanningException
    • createScanDevice

      IScanDevice createScanDevice(ScanModel model, IPublisher<ScanBean> eventPublisher) throws ScanningException
      Create and configure a new device that represents a scan, the scan will publish events to the supplied publisher. TODO: Use Builder pattern rather than a flag?
      Parameters:
      model - The model providing the configuration for the scan
      eventPublisher - A publisher that the scan will use to produce events.
      Returns:
      A new IScanDevice
      Throws:
      ScanningException
    • createScanDevice

      IScanDevice createScanDevice(ScanModel model, IPublisher<ScanBean> eventPublisher, boolean configure) throws ScanningException
      Create and configure a new device that represents a scan, the scan will publish events to the supplied publisher. Configure the device if requested. TODO: Use Builder pattern rather than a flag?
      Parameters:
      model - The model providing the configuration for the scan
      eventPublisher - A publisher that the scan will use to produce events.
      configure - Should the new device be automatically configured?
      Returns:
      A new IScanDevice
      Throws:
      ScanningException