Package org.eclipse.scanning.api

Interface ITolerable<T>

All Known Subinterfaces:
IScannable<T>
All Known Implementing Classes:
AbstractScannable, BeamScannable, CalibrationFrameCollector, CompositeNexusScannable, CountableScannable, DetectorCollectionScannable, FrameCollectingScannable, JythonScannableNexusWrapper, MockBeamOnMonitor, MockCountingPositionScannable, MockNeXusScannable, MockNeXusSlit, MockPausingMonitor, MockScannable, MockStringNexusScannable, MockStringScannable, MockTopupScannable, NexusSlitsWrapper, NXObjectScannable, NXSampleScannable, ScannableNexusWrapper
public interface ITolerable<T>

  • Method Summary

    Modifier and Type
    Method
    Description
    default T
    getTolerance()
    The tolerance is a value +/- position which when the position is still within this tolerance means that a setPosition(...) does nothing.
    default T
    setTolerance(T toleranceValue)
    Set the tolerance which when set will allow setPosition(...) on the device to check if a position set is required.

  • Method Details

    • getTolerance

      default T getTolerance()
      The tolerance is a value +/- position which when the position is still within this tolerance means that a setPosition(...) does nothing. This principle of tolerance allows jittery motors not to have value set when their current value is within acceptable accuracy or tolerance.
      Returns:

    • setTolerance

      default T setTolerance(T toleranceValue)
      Set the tolerance which when set will allow setPosition(...) on the device to check if a position set is required. The tolerance is a value +/- position which when the position is still within this tolerance means that a setPosition(...) does nothing.
      Parameters:
      toleranceValue -
      Returns:
      The previous value including null if tolerance is being set for the first time.