MMDevice: adds functions to XYStage and Stage to #808
Conversation
let them signal whether they use callbacks to update the UI about their position.
There was a problem hiding this comment.
Pull request overview
This PR adds functions to Stage and XYStage device interfaces to allow them to signal whether they use callbacks to update the UI about their position. This is the second part of issue #806 and will enable UI components (Stage control window, Snap-on-Move, HCS plugin) to determine whether polling is necessary.
Key Changes:
- Increments device interface version from 74 to 75
- Adds pure virtual functions
UsesOnStagePositionChanged()andUsesOnXYStagePositionChanged()to respective interfaces - Provides default implementations (returning
false) inCStageBaseandCXYStageBaseclasses
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 7 comments.
| File | Description |
|---|---|
| MMDevice/MMDevice.h | Adds pure virtual functions to Stage and XYStage interfaces with documentation; increments interface version |
| MMDevice/DeviceBase.h | Provides default implementations returning false for both base classes |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
MMDevice/MMDevice.h
Outdated
| * in which case the UI code should use polling. This function signals whether | ||
| * the device adapters uses callbacks, so that the UI knows it does not need | ||
| * to poll this device | ||
| */ | ||
| virtual bool UsesOnStagePositionChanged() = 0; |
There was a problem hiding this comment.
just curious: how do you intend to determine from the UI whether a specific device returns True on this... does it imply that you intend to add another public method to MMCore?
There was a problem hiding this comment.
Very good point! Completely forgot about that part. Added now. Please feel free to suggest better function names.
isXYStageUsingCallbacks functions. Bump MMCore version to 11.12.0.
2 participants
let them signal whether they use callbacks to update the UI about their position.
Second part of issue #806. I believe this will be useful once implemented (for instance, the Stage control window, Snap-on-Move, and the HCS plugin could all make use of it), but can easily be convinced otherwise.