ctb: patwaittime and exptime (#1076)

* cli: patwaittime also takes time argument, api: patwaitclocks and patwaitinterval, tcp: patwaitinterval is 2 functions for set and get, patwaitclocks remains a single for backward compatibility with -1 for get, server (loadpattern): clks using member names (needs to be refactored). needs tobe discussed what to do with pattern files.

* all tests passed

* fixed test 
* exptime deprecated for ctb and xilinx

* pyctbgui..not there yet

* fixed in pyctbgui

* removed redundant warning for ctb and xilinx exptime in Detector class (already in module class handling all exptime signatures), patwait, patloop and patnloop have to be non inferrable commands because of support for old commands (level as suffix)

* fix formatting error from command line parsing

* fix tests for patwaittime

python/slsdet/detector.py

@@ -3702,7 +3702,13 @@ class Detector(CppDetectorApi):
     @property
     def patwaittime(self):
         """
-        [Ctb][Mythen3][Xilinx Ctb] Wait time in clock cycles of loop level provided.
+        [Ctb][Mythen3][Xilinx Ctb] Wait time in clock cycles of loop level provided. 
+
+        Info
+        ----
+
+        :getter: Always return in clock cycles. To get in DurationWrapper, use getPatternWaitInterval
+        :setter: Accepts either a value in clock cycles or a time unit (timedelta, DurationWrapper)
         
         Example
         -------
@@ -3713,41 +3719,85 @@ class Detector(CppDetectorApi):
         0: 5
         1: 20
         2: 30
+        >>> # using timedelta (up to microseconds precision)
+        >>> from datetime import timedelta
+        >>> d.patwaittime[0] = timedelta(seconds=1, microseconds=3)
+        >>> 
+        >>> # using DurationWrapper to set in seconds
+        >>> from slsdet import DurationWrapper
+        >>> d.patwaittime[0] = DurationWrapper(1.2)
+        >>> 
+        >>> # using DurationWrapper to set in ns
+        >>> t = DurationWrapper()
+        >>> t.set_count(500)
+        >>> d.patwaittime = t
+        >>>
+        >>> # to get in clock cycles
+        >>> d.patwaittime
+        1000
+        >>> 
+        >>> d.getPatternWaitInterval(0)
+        sls::DurationWrapper(total_seconds: 1.23 count: 1230000000)
         """
         return PatWaitTimeProxy(self)
 
-    @property
-    @element
-    def patwaittime0(self):
-        """[Ctb][Mythen3][Xilinx Ctb] Wait 0 time in clock cycles."""
-        return self.getPatternWaitTime(0)
 
-    @patwaittime0.setter
-    def patwaittime0(self, nclk):
-        nclk = ut.merge_args(0, nclk)
-        ut.set_using_dict(self.setPatternWaitTime, *nclk)
+    def create_patwaittime_property(level):
+        docstring_template ="""
+        Deprecated command. Use patwaittime instead.
+        [Ctb][Mythen3][Xilinx Ctb] Wait time in clock cycles of loop level {level} provided. 
 
-    @property
-    @element
-    def patwaittime1(self):
-        """[Ctb][Mythen3][Xilinx Ctb] Wait 1 time in clock cycles."""
-        return self.getPatternWaitTime(1)
+        Info
+        ----
 
-    @patwaittime1.setter
-    def patwaittime1(self, nclk):
-        nclk = ut.merge_args(1, nclk)
-        ut.set_using_dict(self.setPatternWaitTime, *nclk)
+        :getter: Always return in clock cycles. To get in DurationWrapper, use getPatternWaitInterval
+        :setter: Accepts either a value in clock cycles or a time unit (timedelta, DurationWrapper)
+        
+        Example
+        -------
+        >>> d.patwaittime{level} = 5
+        >>> d.patwaittime{level}
+        5
+        >>> # using timedelta (up to microseconds precision)
+        >>> from datetime import timedelta
+        >>> d.patwaittime{level} = timedelta(seconds=1, microseconds=3)
+        >>> 
+        >>> # using DurationWrapper to set in seconds
+        >>> from slsdet import DurationWrapper
+        >>> d.patwaittime{level} = DurationWrapper(1.2)
+        >>> 
+        >>> # using DurationWrapper to set in ns
+        >>> t = DurationWrapper()
+        >>> t.set_count(500)
+        >>> d.patwaittime{level} = t
+        >>>
+        >>> # to get in clock cycles
+        >>> d.patwaittime{level}
+        1000
+        >>> 
+        >>> d.getPatternWaitInterval(level)
+        sls::DurationWrapper(total_seconds: 1.23 count: 1230000000)
+        """
+        @property
+        @element
+        def patwaittime(self):
+            return self.getPatternWaitClocks(level)
 
-    @property
-    @element
-    def patwaittime2(self):
-        """[Ctb][Mythen3][Xilinx Ctb] Wait 2 time in clock cycles."""
-        return self.getPatternWaitTime(2)
+        @patwaittime.setter
+        def patwaittime(self, value):
+            if isinstance(value, (int, float)) and not isinstance(value, bool):
+                nclk = ut.merge_args(level, value)
+                ut.set_using_dict(self.setPatternWaitClocks, level, *nclk)
+            else:
+                ut.set_time_using_dict(self.setPatternWaitInterval, level, value)
+        
+        patwaittime.__doc__ = docstring_template.format(level=level)
 
-    @patwaittime2.setter
-    def patwaittime2(self, nclk):
-        nclk = ut.merge_args(2, nclk)
-        ut.set_using_dict(self.setPatternWaitTime, *nclk)
+        return patwaittime
+    
+    patwaittime0 = create_patwaittime_property(0)
+    patwaittime1 = create_patwaittime_property(1)
+    patwaittime2 = create_patwaittime_property(2)
 
 
     @property

python/slsdet/proxy.py

@@ -275,10 +275,13 @@ class PatWaitTimeProxy:
         self.det = det
 
     def __getitem__(self, key):
-        return element_if_equal(self.det.getPatternWaitTime(key))
+        return element_if_equal(self.det.getPatternWaitClocks(key))
 
     def __setitem__(self, key, value):
-        set_proxy_using_dict(self.det.setPatternWaitTime, key, value)
+        if isinstance(value, (int, float)) and not isinstance(value, bool):
+            set_proxy_using_dict(self.det.setPatternWaitClocks, key, value)
+        else:
+            set_proxy_using_dict(self.det.setPatternWaitInterval, key, value)
 
     def __repr__(self):
         max_levels = MAX_PATTERN_LEVELS

python/src/detector.cpp

@@ -1861,13 +1861,22 @@ void init_det(py::module &m) {
                            Detector::setPatternWaitAddr,
                        py::arg(), py::arg(), py::arg() = Positions{});
     CppDetectorApi.def(
-        "getPatternWaitTime",
+        "getPatternWaitClocks",
         (Result<uint64_t>(Detector::*)(int, sls::Positions) const) &
-            Detector::getPatternWaitTime,
+            Detector::getPatternWaitClocks,
         py::arg(), py::arg() = Positions{});
-    CppDetectorApi.def("setPatternWaitTime",
+    CppDetectorApi.def("setPatternWaitClocks",
                        (void (Detector::*)(int, uint64_t, sls::Positions)) &
-                           Detector::setPatternWaitTime,
+                           Detector::setPatternWaitClocks,
+                       py::arg(), py::arg(), py::arg() = Positions{});
+    CppDetectorApi.def(
+        "getPatternWaitInterval",
+        (Result<sls::ns>(Detector::*)(int, sls::Positions) const) &
+            Detector::getPatternWaitInterval,
+        py::arg(), py::arg() = Positions{});
+    CppDetectorApi.def("setPatternWaitInterval",
+                       (void (Detector::*)(int, sls::ns, sls::Positions)) &
+                           Detector::setPatternWaitInterval,
                        py::arg(), py::arg(), py::arg() = Positions{});
     CppDetectorApi.def("getPatternMask",
                        (Result<uint64_t>(Detector::*)(sls::Positions)) &