Package org.eclipse.scanning.api

Interface IScanAttributeContainer

All Superinterfaces:
INameable
All Known Implementing Classes:
AbstractAreaDetectorRunnableDevice, AbstractMalcolmDevice, AbstractRunnableDevice, AbstractScannable, AreaDetectorRunnableDevice, AreaDetectorRunnableDeviceProxy, AreaDetectorRunnableDeviceWaitForArray, AreaDetectorWritingFilesRunnableDevice, BeamScannable, CalibrationFrameCollector, CompositeNexusScannable, ConstantVelocityDevice, CountableScannable, DarkImageDetector, DetectorCollectionScannable, DummyMalcolmDevice, DummyMalcolmTriggeredDetector, ElectronAnalyserRunnableDevice, FrameCollectingScannable, JythonScannableNexusWrapper, MalcolmDevice, MandelbrotDetector, MockBeamOnMonitor, MockCountingPositionScannable, MockNeXusScannable, MockNeXusSlit, MockPausingMonitor, MockScannable, MockStringNexusScannable, MockStringScannable, MockTopupScannable, NexusSlitsWrapper, PosDetector, ProcessingMalcolmDevice, RandomIntDetector, RandomLineDevice, RunnableDeviceProxy, ScannableNexusWrapper, XmapRunnableDevice, XmapRunnableDeviceBase, XmapWritingFilesRunnableDevice, ZebraRunnableDevice
public interface IScanAttributeContainer extends INameable
Interface to allow the getting and setting of scan attributes. These are the attributes that should be written when the scan is performed, e.g. to a NeXus file

  • Method Details

    • getScanAttributeNames

      default Set<String> getScanAttributeNames()
      Returns:
      null if no attributes, otherwise collection of the names of the attributes set

    • setScanAttribute

      default <T> void setScanAttribute(String attributeName, T value) throws Exception
      Set any attribute the implementing classes may provide
      Parameters:
      attributeName - is the name of the attribute
      value - is the value of the attribute

    • getScanAttribute

      default <T> T getScanAttribute(String attributeName) throws Exception
      Get the value of the specified attribute
      Parameters:
      attributeName - is the name of the attribute
      Returns:
      the value of the attribute