Interface AcquisitionStartedEvent

All Superinterfaces:
MMEvent
All Known Subinterfaces:
AcquisitionSequenceStartedEvent

public interface AcquisitionStartedEvent extends MMEvent
This class signals that an acquisition is starting, and provides access to the Datastore that images from the acquisition will be put into. Third-party code may subclass this event to provide notifications of their own acquisitions. If they do so, they should also publish AcquisitionEndedEvents when their acquisitions cease.

The default implementation of this event posts on the Studio event bus, so subscribe to this event using EventManager.

  • Method Summary

    Modifier and Type
    Method
    Description
    Return the Datastore into which images will be inserted during the acquisition.
    Return an Object used to identify the entity in charge of the acquisition.
  • Method Details

    • getDatastore

      Datastore getDatastore()
      Return the Datastore into which images will be inserted during the acquisition.
    • getSource

      Object getSource()
      Return an Object used to identify the entity in charge of the acquisition. This can be used by recipients to distinguish different types of acquisitions. You must re-use the same object for the AcquisitionEndedEvent that you post.