Package org.eclipse.scanning.api.scan
Interface IScanService
- All Superinterfaces:
IPositionerService,IRunnableDeviceService
- All Known Implementing Classes:
RunnableDeviceServiceImpl
This interface is used to provide custom scanning methods
to the IRunnableDeviceService.
-
Method Summary
Modifier and TypeMethodDescriptionvoidaddScanParticipant(Object device) Used to register a scan participant.createScanDevice(ScanModel model) Create and configure a new device that represents a scan.createScanDevice(ScanModel model, boolean configure) Create and configure a new device that represents a scan.createScanDevice(ScanModel model, IPublisher<ScanBean> eventPublisher) Create and configure a new device that represents a scan, the scan will publish events to the supplied publisher.createScanDevice(ScanModel model, IPublisher<ScanBean> eventPublisher, boolean configure) Create and configure a new device that represents a scan, the scan will publish events to the supplied publisher.The list of objects to be run as participants with the scan.voidremoveScanParticipant(Object device) Used to remove a scan participant.Methods inherited from interface org.eclipse.scanning.api.scan.event.IPositionerService
createPositioner, createPositionerMethods inherited from interface org.eclipse.scanning.api.device.IRunnableDeviceService
getActiveScanner, getDeviceConnectorService, getDeviceInformation, getDeviceInformation, getDeviceInformation, getDeviceInformationIncludingNonAlive, getRunnableDevice, getRunnableDevice, getRunnableDeviceNames, register
-
Method Details
-
addScanParticipant
Used to register a scan participant. Once registered any scan created will use the participant.- Parameters:
device-
-
removeScanParticipant
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
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
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 scanconfigure- 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 scaneventPublisher- 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 scaneventPublisher- A publisher that the scan will use to produce events.configure- Should the new device be automatically configured?- Returns:
- A new
IScanDevice - Throws:
ScanningException
-