Package org.eclipse.scanning.api

Interface IBoundable<T>

Type Parameters:
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 IBoundable<T>
Interface which, if implemented, will provide information about the upper and lower values which the value may take. In GDA8 there are several concepts of bounds, the underlying hardware, the acquistion layer etc. In Solstice there is one limit and it is in the same unit as the position.

  • Method Summary

    Modifier and Type
    Method
    Description
    default T
    getMaximum()
    The upper limit in the same unit as the position.
    default T
    getMinimum()
    The lower limit in the same unit as the position.
    default T[]
    getPermittedValues()
    Returns a list of the permitted values for this object, or null if the values are not restricted to a set of permitted values
    T
    getPosition()
    The position is the value which should be: 1.

  • Method Details

    • getPosition

      T getPosition() throws ScanningException
      The position is the value which should be: 1. Greater than or equal to the lower 2. Less than or equal to the upper. 3. One of the permitted values, if they are not null.
      Returns:
      Throws:
      ScanningException - if the position cannot be read for any reason

    • getMaximum

      default T getMaximum()
      The upper limit in the same unit as the position.
      Returns:
      null if there is no upper limit. In this case it will be the upper limit of the type T.

    • getMinimum

      default T getMinimum()
      The lower limit in the same unit as the position.
      Returns:
      null if there is no upper limit. In this case it will be the upper limit of the type T.

    • getPermittedValues

      default T[] getPermittedValues() throws Exception
      Returns a list of the permitted values for this object, or null if the values are not restricted to a set of permitted values
      Returns:
      list of permitted values, or null
      Throws:
      Exception