Splitting Pump device into PressurePump and VolumetricPump

micro-manager · Jul 1, 2024 · 67dbe2b · 67dbe2b
1 parent 503321c
commit 67dbe2b
Show file tree

Hide file tree

Showing 19 changed files with 1,057 additions and 29 deletions.
diff --git a/MMCore/CoreUtils.h b/MMCore/CoreUtils.h
@@ -72,6 +72,8 @@ inline std::string ToString(const MM::DeviceType d)
       case MM::SLMDevice: return "SLM";
       case MM::HubDevice: return "Hub";
       case MM::GalvoDevice: return "Galvo";
+      case MM::PressurePumpDevice: return "PressurePump";
+      case MM::VolumetricPumpDevice: return "VolumetricPump";
    }
    return "Invalid";
 }

diff --git a/MMCore/Devices/DeviceInstances.h b/MMCore/Devices/DeviceInstances.h
@@ -33,3 +33,5 @@
 #include "SLMInstance.h"
 #include "GalvoInstance.h"
 #include "HubInstance.h"
+#include "PressurePumpInstance.h"
+#include "VolumetricPumpInstance.h"
diff --git a/MMCore/Devices/PressurePumpInstance.cpp b/MMCore/Devices/PressurePumpInstance.cpp
@@ -0,0 +1,30 @@
+// PROJECT:       Micro-Manager
+// SUBSYSTEM:     MMCore
+//
+// DESCRIPTION:   PressurePump device instance wrapper
+//
+// COPYRIGHT:     Institut Pierre-Gilles de Gennes, Paris, 2024,
+//                All Rights reserved
+//
+// LICENSE:       This file is distributed under the "Lesser GPL" (LGPL) license.
+//                License text is included with the source distribution.
+//
+//                This file is distributed in the hope that it will be useful,
+//                but WITHOUT ANY WARRANTY; without even the implied warranty
+//                of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
+//
+//                IN NO EVENT SHALL THE COPYRIGHT OWNER OR
+//                CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
+//                INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES.
+//
+// AUTHOR:        Lars Kool, Institut Pierre-Gilles de Gennes
+
+#include "PressurePumpInstance.h"
+#include "../../MMDevice/MMDeviceConstants.h"
+
+// General pump functions
+int PressurePumpInstance::Stop() { return GetImpl()->Stop(); }
+int PressurePumpInstance::Calibrate() { return GetImpl()->Calibrate(); }
+bool PressurePumpInstance::requiresCalibration() { return GetImpl()->RequiresCalibration(); }
+int PressurePumpInstance::setPressure(double pressure) { return GetImpl()->SetPressure(pressure); }
+int PressurePumpInstance::getPressure(double& pressure) { return GetImpl()->GetPressure(pressure); }
diff --git a/MMCore/Devices/PressurePumpInstance.h b/MMCore/Devices/PressurePumpInstance.h
@@ -0,0 +1,45 @@
+// PROJECT:       Micro-Manager
+// SUBSYSTEM:     MMCore
+//
+// DESCRIPTION:   Pump device instance wrapper
+//
+// COPYRIGHT:     Institut Pierre-Gilles de Gennes, Paris, 2024,
+//                All Rights reserved
+//
+// LICENSE:       This file is distributed under the "Lesser GPL" (LGPL) license.
+//                License text is included with the source distribution.
+//
+//                This file is distributed in the hope that it will be useful,
+//                but WITHOUT ANY WARRANTY; without even the implied warranty
+//                of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
+//
+//                IN NO EVENT SHALL THE COPYRIGHT OWNER OR
+//                CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
+//                INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES.
+//
+// AUTHOR:        Lars Kool, Institut Pierre-Gilles de Gennes
+
+#include "DeviceInstanceBase.h"
+#include "../../MMDevice/MMDeviceConstants.h"
+
+class PressurePumpInstance : public DeviceInstanceBase<MM::PressurePump>
+{
+public:
+    PressurePumpInstance(CMMCore* core,
+        std::shared_ptr<LoadedDeviceAdapter> adapter,
+        const std::string& name,
+        MM::Device* pDevice,
+        DeleteDeviceFunction deleteFunction,
+        const std::string& label,
+        mm::logging::Logger deviceLogger,
+        mm::logging::Logger coreLogger) :
+        DeviceInstanceBase<MM::PressurePump>(core, adapter, name, pDevice, deleteFunction, label, deviceLogger, coreLogger)
+    {}
+
+
+    int Calibrate();
+    int Stop();
+    bool requiresCalibration();
+    int setPressure(double pressure);
+    int getPressure(double& pressure);
+};
diff --git a/MMCore/Devices/VolumetricPumpInstance.cpp b/MMCore/Devices/VolumetricPumpInstance.cpp
@@ -0,0 +1,39 @@
+// PROJECT:       Micro-Manager
+// SUBSYSTEM:     MMCore
+//
+// DESCRIPTION:   Pump device instance wrapper
+//
+// COPYRIGHT:     Institut Pierre-Gilles de Gennes, Paris, 2024,
+//                All Rights reserved
+//
+// LICENSE:       This file is distributed under the "Lesser GPL" (LGPL) license.
+//                License text is included with the source distribution.
+//
+//                This file is distributed in the hope that it will be useful,
+//                but WITHOUT ANY WARRANTY; without even the implied warranty
+//                of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
+//
+//                IN NO EVENT SHALL THE COPYRIGHT OWNER OR
+//                CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
+//                INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES.
+//
+// AUTHOR:        Lars Kool, Institut Pierre-Gilles de Gennes
+
+#include "VolumetricPumpInstance.h"
+#include "../../MMDevice/MMDeviceConstants.h"
+
+// Volume controlled pump functions
+int VolumetricPumpInstance::Home() { return GetImpl()->Home(); }
+int VolumetricPumpInstance::Stop() { return GetImpl()->Stop(); }
+bool VolumetricPumpInstance::requiresHoming() { return GetImpl()->RequiresHoming(); }
+int VolumetricPumpInstance::invertDirection(bool state) { return GetImpl()->InvertDirection(state); }
+int VolumetricPumpInstance::isDirectionInverted(bool& state) { return GetImpl()->IsDirectionInverted(state); }
+int VolumetricPumpInstance::setVolumeUl(double volume) { return GetImpl()->SetVolumeUl(volume); }
+int VolumetricPumpInstance::getVolumeUl(double& volume) { return GetImpl()->GetVolumeUl(volume); }
+int VolumetricPumpInstance::setMaxVolumeUl(double volume) { return GetImpl()->SetMaxVolumeUl(volume); }
+int VolumetricPumpInstance::getMaxVolumeUl(double& volume) { return GetImpl()->GetMaxVolumeUl(volume); }
+int VolumetricPumpInstance::setFlowrateUlPerSec(double flowrate) { return GetImpl()->SetFlowrateUlPerSecond(flowrate); }
+int VolumetricPumpInstance::getFlowrateUlPerSec(double& flowrate) { return GetImpl()->GetFlowrateUlPerSecond(flowrate); }
+int VolumetricPumpInstance::Start() { return GetImpl()->Start(); }
+int VolumetricPumpInstance::DispenseDuration(double durSec) { return GetImpl()->DispenseDuration(durSec); }
+int VolumetricPumpInstance::DispenseVolume(double volUl) { return GetImpl()->DispenseVolume(volUl); }
diff --git a/MMCore/Devices/VolumetricPumpInstance.h b/MMCore/Devices/VolumetricPumpInstance.h
@@ -0,0 +1,53 @@
+// PROJECT:       Micro-Manager
+// SUBSYSTEM:     MMCore
+//
+// DESCRIPTION:   Pump device instance wrapper
+//
+// COPYRIGHT:     Institut Pierre-Gilles de Gennes, Paris, 2024,
+//                All Rights reserved
+//
+// LICENSE:       This file is distributed under the "Lesser GPL" (LGPL) license.
+//                License text is included with the source distribution.
+//
+//                This file is distributed in the hope that it will be useful,
+//                but WITHOUT ANY WARRANTY; without even the implied warranty
+//                of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
+//
+//                IN NO EVENT SHALL THE COPYRIGHT OWNER OR
+//                CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
+//                INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES.
+//
+// AUTHOR:        Lars Kool, Institut Pierre-Gilles de Gennes
+
+#include "DeviceInstanceBase.h"
+#include "../../MMDevice/MMDeviceConstants.h"
+
+class VolumetricPumpInstance : public DeviceInstanceBase<MM::VolumetricPump>
+{
+public:
+    VolumetricPumpInstance(CMMCore* core,
+        std::shared_ptr<LoadedDeviceAdapter> adapter,
+        const std::string& name,
+        MM::Device* pDevice,
+        DeleteDeviceFunction deleteFunction,
+        const std::string& label,
+        mm::logging::Logger deviceLogger,
+        mm::logging::Logger coreLogger) :
+        DeviceInstanceBase<MM::VolumetricPump>(core, adapter, name, pDevice, deleteFunction, label, deviceLogger, coreLogger)
+    {}
+
+    int Home();
+    int Stop();
+    bool requiresHoming();
+    int invertDirection(bool state);
+    int isDirectionInverted(bool& state);
+    int setVolumeUl(double volUl);
+    int getVolumeUl(double& volUl);
+    int setMaxVolumeUl(double volUl);
+    int getMaxVolumeUl(double& volUl);
+    int setFlowrateUlPerSec(double flowrate);
+    int getFlowrateUlPerSec(double& flowrate);
+    int Start();
+    int DispenseDuration(double durSec);
+    int DispenseVolume(double volUl);
+};
diff --git a/MMCore/LoadableModules/LoadedDeviceAdapter.cpp b/MMCore/LoadableModules/LoadedDeviceAdapter.cpp
@@ -185,6 +185,10 @@ LoadedDeviceAdapter::LoadDevice(CMMCore* core, const std::string& name,
          return std::make_shared<GalvoInstance>(core, shared_this, name, pDevice, deleter, label, deviceLogger, coreLogger);
       case MM::HubDevice:
          return std::make_shared<HubInstance>(core, shared_this, name, pDevice, deleter, label, deviceLogger, coreLogger);
+      case MM::PressurePumpDevice:
+          return std::make_shared<PressurePumpInstance>(core, shared_this, name, pDevice, deleter, label, deviceLogger, coreLogger);
+      case MM::VolumetricPumpDevice:
+          return std::make_shared<VolumetricPumpInstance>(core, shared_this, name, pDevice, deleter, label, deviceLogger, coreLogger);
       default:
          deleter(pDevice);
          throw CMMError("Device " + ToQuotedString(name) +