Package org.eclipse.scanning.api

Interface ITimeoutable

All Known Subinterfaces:
IDetectorModel, IMalcolmDetectorModel, IMalcolmModel, IScannable<T>
All Known Implementing Classes:
AbstractDetectorModel, AbstractNameableTimeoutable, AbstractScannable, AreaDetectorRunnableDeviceExtendedModel, AreaDetectorRunnableDeviceModel, AreaDetectorWritingFilesRunnableDeviceModel, BeamScannable, CalibrationFrameCollector, CompositeNexusScannable, ConstantVelocityModel, CountableScannable, DarkImageModel, DetectorCollectionScannable, DummyMalcolmDetectorModel, DummyMalcolmModel, DummyMalcolmTriggeredModel, ElectronAnalyserRunnableDeviceModel, FrameCollectingScannable, GenericModel, JythonScannableNexusWrapper, MalcolmDetectorModel, MalcolmModel, MandelbrotModel, MockBeamOnMonitor, MockCountingPositionScannable, MockNeXusScannable, MockNeXusSlit, MockPausingMonitor, MockScannable, MockStringNexusScannable, MockStringScannable, MockTopupScannable, NexusSlitsWrapper, NXObjectScannable, NXSampleScannable, PosDetectorModel, RandomLineModel, ScannableNexusWrapper, SimpleDetectorModel, XmapRunnableDeviceModel, XmapWritingFilesRunnableDeviceModel, ZebraModel
public interface ITimeoutable

  • Method Summary

    Modifier and Type
    Method
    Description
    default long
    getTimeout()
    This is the timeout time in seconds which defaults to -1 If set the default timeout for an action on a device will use this value.
    default void
    setTimeout(long time)
     

  • Method Details

    • getTimeout

      default long getTimeout()
      This is the timeout time in seconds which defaults to -1 If set the default timeout for an action on a device will use this value. For instance for detectors the run and write time will timeout if this field is set>0 or 10 seconds if none of the detector models have this field set. For scannables the IScannable interface extends this interface. If any motor at a given level implements this timeout, this time out (or the max of all the timeouts) will be used. If none are set the default is three minutes.
      Returns:

    • setTimeout

      default void setTimeout(long time)
      Parameters:
      time - in seconds