Interface PositionInputStream<T>

Type Parameters:
T -
All Known Subinterfaces:
AsyncNXCollectionStrategy, CollectionStrategyBeanInterface, CollectionStrategyDecoratableInterface, ISpecsPhoibosCollectionStrategy, NXFileWriterPlugin, NXPlugin
All Known Implementing Classes:
AbstractADCollectionStrategy, AbstractADCollectionStrategyBase, AbstractADCollectionStrategyDecorator, AbstractADTriggeringStrategy, AbstractCollectionStrategyDecorator, AbstractWriteRegionsImmediatelyCollectionStrategy, AbstractXmapTriggeringStrategy, ADArrayCounterMonitor, ADArrayPlugin, ADDetector.NullFileWriter, ADNDAttributesPlugin, ADPilatusFreerunControllerPlugin, ADRectangularROIPlugin, ADRoiCountsI0, ADRoiStatsPair, ADTimeSeriesStatsPlugin, ArrayPortDecorator, AutoSummingProcessDecorator, BufferedDetectorToAsyncNXCollectionStrategyAdapter, CameraROINXPlugin, CMOSMultipleHardwareTriggered, CollectionStrategyDecoratableBase, ColourModeDecorator, ConfigureAcquireTimeAcquirePeriodDecorator, ConfigureAcquireTimeDecorator, ContinuousAcquisition, CustomPluginChainDecorator, DummyHardwareTriggerableSimpleDetector, EpicsStartStop, ExcaliburCollectionStrategy, ExcaliburDacScanCollectionStrategy, ExcaliburMultipleImagesPerHDF5FileWriter, ExcaliburMultipleImagesPerParallelHDF5FileWriter, ExternalTriggerModeDecorator, FileWriterBase, FlatAndDarkFieldPlugin, HardwareTriggeredAndor, HardwareTriggeredAndorBalor, HardwareTriggeredMedipix, HardwareTriggeredPCO, HardwareTriggeredPilatus, HardwareTriggeredPixium, HardwareTriggeredStandard, HardwareTriggeredWithOnlineDataReductionXmap, HardwareTriggerXmap, ImageModeDecorator, InitialiseDetectorAfterExposureTimeChangeDecorator, InternalTriggerModeDecorator, MbsAnalyserCollectionStrategy, MbsAnalyserTotalOnlyCollectionStrategy, MerlinColourModeDecorator, MerlinThresholdSweepConfigurer, MerlinThresholdSweepTrigger, MultipleExposureHardwareTriggeredStrategy, MultipleExposurePerCollectionStandard, MultipleExposureSoftwareTriggerAutoMode, MultipleHDF5PluginsPerDetectorFileWriter, MultipleImageModeDecorator, MultipleImagesPerHDF5FileWriter, MultipleImagesPerParallelHDF5FileWriter, NonAsyncSingleImagePerFileWriter, NullNXPlugin, NXDetectorMetadataPlugin, NXForceCallbacks, ODCCDOverflow, ODCCDSingleExposure, PCOADCModeDecorator, PCOArmDecorator, PCOAutoContinuous, PCOConfigureAcquireTimeAcquirePeriodDecorator, PCODIOTrigger, PCOHWTriggerBase, PCOImageModeDecorator, PCOMultipleExposureHardwareTrigger, PCOMultipleExposurePerCollection, PCOMultipleExposureSoftwareTriggerAutoMode, PCOStopDecorator, PCOTFGTrigger, PCOTFGTriggerContinuousAutoMode, PCOTriggerModeDecorator, PilatusCamserverFileWriter, PixiumMultipleExposureSoftwareTriggerAutoMode, PixiumSimpleAcquire, PositionInputStreamCombiner, PositionQueue, PositionStreamingTfgScaler, ProcessFilterDecorator, ProcessingVariableDecorator, ProcStartStop, PSLSingleExposure, PVArrayPlugin, PVTogglingNXPlugin, SimpleAcquire, SingleExposureEpicsShutter, SingleExposurePco, SingleExposurePcoSoftwareTrigger, SingleExposurePilatus, SingleExposureStandard, SingleExposureUnsynchronisedExternalShutter, SingleImageModeDecorator, SingleImagePerFileWriter, SingleImagePerFileWriterWithNumTracker, SoftTriggeredPilatus, SoftwareContinuous, SoftwareStartDoNotForceStop, SoftwareStartStop, SoftwareSynchronisedMultipleExposure, SpecsPhoibosCollectionStrategy, SpecsPhoibosSeparateIterationCollectionStrategy, SpecsPhoibosSolsticeCollectionStrategy, TriggerModeDecorator, UnsynchronisedExternalShutterDecorator, VGScientaAnalyserCollectionStrategy, XBufferPlugin, XmapHardwareTriggeredCollectionStrategy, XmapMultipleImagesPerHDF5FileWriter, XMapNXDetectorDataAppenderInputStream, XmapReadbackHdf5NXPlugin, XmapSimpleAcquire, Xspress3CollectionStrategy, Xspress3FFCalculatorNXPlugin, Xspress3TriggeringStrategy, ZebraCollectionStrategy

public interface PositionInputStream<T>
Provides a very simple input stream for reading positions/data from Scannables / Detectors.
  • Method Summary

    Modifier and Type
    Method
    Description
    read(int maxToRead)
    Return at least one element, but no more than maxToRead, waiting until able to do so.
  • Method Details

    • read

      Return at least one element, but no more than maxToRead, waiting until able to do so. The parameter maxToRead is there to protect the caller from potentially receiving too much data in call, not to meet the needs of the detector.
      Parameters:
      maxToRead - the maximum number of elements to read. Must be one or more.
      Returns:
      at least one element from the head of the stream, oldest on the left
      Throws:
      NoSuchElementException - if the stream will have nothing to return
      InterruptedException
      DeviceException