diff --git a/slsDetectorSoftware/include/Detector.h b/slsDetectorSoftware/include/Detector.h index c5dfaa8c0..fab073d01 100644 --- a/slsDetectorSoftware/include/Detector.h +++ b/slsDetectorSoftware/include/Detector.h @@ -152,24 +152,30 @@ class Detector { void setPeriod(ns t, Positions pos = {}); - /** [Gotthard][Jungfrau][CTB][Mythen3][Gotthard2] */ + /** [Gotthard][Jungfrau][CTB][Mythen3] + * [Gotthard2] only in continuous mode */ Result getDelayAfterTrigger(Positions pos = {}) const; - /** [Gotthard][Jungfrau][CTB][Mythen3][Gotthard2] */ + /** [Gotthard][Jungfrau][CTB][Mythen3] + * [Gotthard2] only in continuous mode */ void setDelayAfterTrigger(ns value, Positions pos = {}); - /** [Gotthard][Jungfrau][CTB][Mythen3][Gotthard2] */ + /** [Gotthard][Jungfrau][CTB][Mythen3] + * [Gotthard2] only in continuous mode */ Result getNumberOfFramesLeft(Positions pos = {}) const; - /** [Gotthard][Jungfrau][CTB][Mythen3][Gotthard2] */ + /** [Gotthard][Jungfrau][CTB][Mythen3] + * [Gotthard2] only in continuous mode */ Result getNumberOfTriggersLeft(Positions pos = {}) const; - /** [Gotthard][Jungfrau][CTB][Mythen3][Gotthard2] */ - Result getDelayAfterTriggerLeft(Positions pos = {}) const; - - /** [Gotthard][Jungfrau][CTB][Mythen3][Gotthard2] */ + /** [Gotthard][Jungfrau][CTB][Mythen3] + * [Gotthard2] only in continuous mode */ Result getPeriodLeft(Positions pos = {}) const; + /** [Gotthard][Jungfrau][CTB][Mythen3] + * [Gotthard2] only in continuous mode */ + Result getDelayAfterTriggerLeft(Positions pos = {}) const; + Result getTimingMode(Positions pos = {}) const; /** @@ -1286,13 +1292,16 @@ class Detector { /** Execute a command on the detector server console */ void executeCommand(const std::string &value, Positions pos = {}); - /** [Jungfrau][Mythen3][Gotthard2][CTB] */ + /** [Jungfrau][Mythen3][CTB] + * [Gotthard2] only in continuous mode */ Result getNumberOfFramesFromStart(Positions pos = {}) const; - /** [Jungfrau][Mythen3][Gotthard2][CTB] Get time from detector start */ + /** [Jungfrau][Mythen3][CTB] Get time from detector start + * [Gotthard2] only in continuous mode */ Result getActualTime(Positions pos = {}) const; - /** [Jungfrau][Mythen3][Gotthard2][CTB] Get timestamp at a frame start */ + /** [Jungfrau][Mythen3][CTB] Get timestamp at a frame start + * [Gotthard2] only in continuous mode */ Result getMeasurementTime(Positions pos = {}) const; std::string getUserDetails() const; diff --git a/slsDetectorSoftware/src/CmdProxy.h b/slsDetectorSoftware/src/CmdProxy.h index e365d23fc..0e221280c 100644 --- a/slsDetectorSoftware/src/CmdProxy.h +++ b/slsDetectorSoftware/src/CmdProxy.h @@ -1020,19 +1020,24 @@ class CmdProxy { "\n\t[Gotthard2] Uploaded to detector just before acquisition starts"); TIME_COMMAND(delay, getDelayAfterTrigger, setDelayAfterTrigger, - "[duration] [(optional unit) ns|us|ms|s]\n\t[Jungfrau][Gotthard][Mythen3][Gotthard2][Ctb] Delay after trigger"); + "[duration] [(optional unit) ns|us|ms|s]\n\t[Jungfrau][Gotthard][Mythen3][Gotthard2][Ctb] Delay after trigger" + "\n\t[Gotthard2] only in continuous mode."); GET_COMMAND(framesl, getNumberOfFramesLeft, - "\n\t[Gotthard][Jungfrau][Mythen3][Gotthard2][CTB] Number of frames left in acquisition."); + "\n\t[Gotthard][Jungfrau][Mythen3][Gotthard2][CTB] Number of frames left in acquisition." + "\n\t[Gotthard2] only in continuous mode."); GET_COMMAND(triggersl, getNumberOfTriggersLeft, - "\n\t[Gotthard][Jungfrau][Mythen3][Gotthard2][CTB] Number of triggers left in acquisition."); + "\n\t[Gotthard][Jungfrau][Mythen3][Gotthard2][CTB] Number of triggers left in acquisition." + "\n\t[Gotthard2] only in continuous mode."); TIME_GET_COMMAND(delayl, getDelayAfterTriggerLeft, - "\n\t[Gotthard][Jungfrau][Mythen3][Gotthard2][CTB] DelayLeft Delay Left in Acquisition."); + "\n\t[Gotthard][Jungfrau][Mythen3][Gotthard2][CTB] DelayLeft Delay Left in Acquisition." + "\n\t[Gotthard2] only in continuous mode."); TIME_GET_COMMAND(periodl, getPeriodLeft, - "\n\t[Gotthard][Jungfrau][Mythen3][Gotthard2][CTB] Period left for current frame."); + "\n\t[Gotthard][Jungfrau][Mythen3][Gotthard2][CTB] Period left for current frame." + "\n\t[Gotthard2] only in continuous mode."); INTEGER_COMMAND(timing, getTimingMode, setTimingMode, sls::StringTo, "[auto|trigger|gating|burst_trigger]\n\tTiming Mode of detector.\n\t[Jungfrau][Gotthard][Mythen3][Gotthard2][Ctb] [auto|trigger]\n\t[Eiger] [auto|trigger|gating|burst_trigger]"); @@ -1717,13 +1722,16 @@ class CmdProxy { "\n\tClient IP Address that last communicated with the detector."); GET_COMMAND(nframes, getNumberOfFramesFromStart, - "\n\t[Jungfrau][Mythen3][Gotthard2][Moench][CTB] Number of frames from start run control."); + "\n\t[Jungfrau][Mythen3][Gotthard2][Moench][CTB] Number of frames from start run control." + "\n\t[Gotthard2] only in continuous mode."); TIME_GET_COMMAND(now, getActualTime, - "[(optional unit) ns|us|ms|s]\n\t[Jungfrau][Mythen3][Gotthard2][Moench][CTB] Time from detector start up."); + "[(optional unit) ns|us|ms|s]\n\t[Jungfrau][Mythen3][Gotthard2][Moench][CTB] Time from detector start up." + "\n\t[Gotthard2] only in continuous mode."); TIME_GET_COMMAND(timestamp, getMeasurementTime, - "[(optional unit) ns|us|ms|s]\n\t[Jungfrau][Mythen3][Gotthard2][Moench][CTB] Timestamp at a frame start."); + "[(optional unit) ns|us|ms|s]\n\t[Jungfrau][Mythen3][Gotthard2][Moench][CTB] Timestamp at a frame start." + "\n\t[Gotthard2] only in continuous mode."); GET_COMMAND(rx_frameindex, getRxCurrentFrameIndex, "\n\tCurrent frame index received in receiver."); diff --git a/slsDetectorSoftware/src/slsDetector.h b/slsDetectorSoftware/src/slsDetector.h index c324d2d15..5e1694afb 100755 --- a/slsDetectorSoftware/src/slsDetector.h +++ b/slsDetectorSoftware/src/slsDetector.h @@ -564,10 +564,12 @@ class slsDetector : public virtual slsDetectorDefs { void setPeriod(int64_t value); - /** [Gotthard][Jungfrau][CTB][Mythen3][Gotthard2] */ + /** [Gotthard][Jungfrau][CTB][Mythen3] + * [Gotthard2] only in continuous mode */ int64_t getDelayAfterTrigger(); - /** [Gotthard][Jungfrau][CTB][Mythen3][Gotthard2] */ + /** [Gotthard][Jungfrau][CTB][Mythen3] + * [Gotthard2] only in continuous mode */ void setDelayAfterTrigger(int64_t value); /** [Eiger] in 32 bit mode */ @@ -589,13 +591,16 @@ class slsDetector : public virtual slsDetectorDefs { * Options: (0-1638375 ns (resolution of 25ns) */ void setStorageCellDelay(int64_t value); - /** [Gotthard][Jungfrau][CTB][Mythen3][Gotthard2] */ + /** [Gotthard][Jungfrau][CTB][Mythen3] + * [Gotthard2] only in continuous mode */ int64_t getNumberOfFramesLeft() const; - /** [Gotthard][Jungfrau][CTB][Mythen3][Gotthard2] */ + /** [Gotthard][Jungfrau][CTB][Mythen3] + * [Gotthard2] only in continuous mode */ int64_t getNumberOfTriggersLeft() const; - /** [Gotthard][Jungfrau][CTB][Gotthard2] */ + /** [Gotthard][Jungfrau][CTB] + * [Gotthard2] only in continuous mode */ int64_t getDelayAfterTriggerLeft() const; /** [Gotthard] */ @@ -610,13 +615,16 @@ class slsDetector : public virtual slsDetectorDefs { /** [Eiger] */ int64_t getMeasuredSubFramePeriod() const; - /** [Jungfrau][CTB][Mythen3][Gotthard2] */ + /** [Jungfrau][CTB][Mythen3] + * [Gotthard2] only in continuous mode */ int64_t getNumberOfFramesFromStart() const; - /** [Jungfrau][CTB][Mythen3][Gotthard2] Get time from detector start */ + /** [Jungfrau][CTB][Mythen3] Get time from detector start + * [Gotthard2] only in continuous mode */ int64_t getActualTime() const; - /** [Jungfrau][CTB][Mythen3][Gotthard2] Get timestamp at a frame start */ + /** [Jungfrau][CTB][Mythen3] Get timestamp at a frame start + * [Gotthard2] only in continuous mode */ int64_t getMeasurementTime() const; /**