Merge branch 'feature/add_string_pv_interface_rel08' into 'release/08-00'

Feature/add string pv interface rel08

See merge request belle2/software/basf2!2506

Author: Frankenfrog

dqm/analysis/modules/include/DQMHistAnalysisTOP.h

@@ -179,6 +179,12 @@ namespace Belle2 {
      */
     void updateLimits();
 
+    /**
+     * Sets flags for boardstacks to be included in alarming
+     * @param excludedBoardstacks list of boarstacks to be excluded from alarming
+     */
+    void setIncludedBoardstacks(const std::vector<std::string>& excludedBoardstacks);
+
     // module parameters
 
     std::vector<int> m_asicWindowsBand = {215, 235}; /**< lower and upper bin of a band denoting good windows */
@@ -195,6 +201,7 @@ namespace Belle2 {
 
     std::vector<int> m_alarmColors = {kGray, kGreen, kYellow, kRed}; /**< alarm colors */
     std::vector<bool> m_includedBoardstacks; /**< boardstacks included in alarming */
+    std::map<std::string, int> m_bsmap;  /**< a map of boardstack names to ID's */
 
     bool m_IsNullRun = false; /**< Run type flag for null runs. */
 

dqm/analysis/modules/src/DQMHistAnalysisTOP.cc

@@ -74,26 +74,21 @@ void DQMHistAnalysisTOPModule::initialize()
   if (m_backgroundAlarmLevels.size() != 2) B2ERROR("Parameter list 'backgroundAlarmLevels' must contain two numbers");
   if (m_photonYieldsAlarmLevels.size() != 2) B2ERROR("Parameter list 'photonYieldsAlarmLevels' must contain two numbers");
 
-  // parse excluded boardstacks
+  // make a map of boardstack names to ID's
 
-  m_includedBoardstacks.resize(64, true);
-  if (not m_excludedBoardstacks.empty()) {
-    std::map<std::string, int> bsmap;
-    int id = 1;
-    for (int slot = 1; slot <= 16; slot++) {
-      string slotstr = to_string(slot);
-      for (std::string bs : {"a", "b", "c", "d"}) {
-        bsmap[slotstr + bs] = id;
-        id++;
-      }
-    }
-    for (const auto& bsname : m_excludedBoardstacks) {
-      id = bsmap[bsname];
-      if (id > 0) m_includedBoardstacks[id - 1] = false;
-      else B2ERROR("Invalid boardstack name: " << bsname);
+  int id = 1;
+  for (int slot = 1; slot <= 16; slot++) {
+    string slotstr = to_string(slot);
+    for (std::string bs : {"a", "b", "c", "d"}) {
+      m_bsmap[slotstr + bs] = id;
+      id++;
     }
   }
 
+  // parse excluded boardstacks
+
+  setIncludedBoardstacks(m_excludedBoardstacks);
+
   // MiraBelle monitoring
 
   m_monObj = getMonitoringObject("top");
@@ -104,6 +99,7 @@ void DQMHistAnalysisTOPModule::initialize()
   registerEpicsPV(m_pvPrefix + "badCarriers", "badCarriers");
   registerEpicsPV(m_pvPrefix + "badAsics", "badAsics");
   registerEpicsPV(m_pvPrefix + "badPMTs", "badPMTs");
+  registerEpicsPV(m_pvPrefix + "numExcludedBS", "numExcludedBS");
 
   // Epics used to get limits from configuration file - override module parameters (input only)
 
@@ -114,10 +110,7 @@ void DQMHistAnalysisTOPModule::initialize()
   registerEpicsPV(m_pvPrefix + "deadChannelsAlarmLevels", "deadChannelsAlarmLevels");
   registerEpicsPV(m_pvPrefix + "backgroundAlarmLevels", "backgroundAlarmLevels");
   registerEpicsPV(m_pvPrefix + "photonYieldsAlarmLevels", "photonYieldsAlarmLevels");
-  for (int slot = 1; slot <= 16; slot++) {
-    std::string varName = "slot" + to_string(slot);
-    registerEpicsPV(m_pvPrefix + varName, varName); // excludedBoardstacks (lolo = BS0, low = BS1, high = BS2, hihi = BS3)
-  }
+  registerEpicsPV(m_pvPrefix + "excludedBoardstacks", "excludedBoardstacks");
 
   updateEpicsPVs(5.0);
 
@@ -266,6 +259,7 @@ void DQMHistAnalysisTOPModule::updateWindowVsSlotCanvas()
     canvas->cd();
     m_text1->Draw();
     for (auto* line : m_asicWindowsBandLines) line->Draw();
+    canvas->Pad()->SetFrameFillColor(10);
     canvas->Pad()->SetFillColor(getAlarmColor(alarmState));
     canvas->Modified();
   }
@@ -292,6 +286,7 @@ void DQMHistAnalysisTOPModule::updateEventMonitorCanvas()
   if (canvas) {
     canvas->cd();
     m_text2->Draw();
+    canvas->Pad()->SetFrameFillColor(10);
     canvas->Pad()->SetFillColor(getAlarmColor(alarmState));
     canvas->Modified();
   }
@@ -705,12 +700,16 @@ void DQMHistAnalysisTOPModule::setEpicsVariables()
   setEpicsPV("badCarriers", badCarriers);
   setEpicsPV("badAsics", badAsics);
   setEpicsPV("badPMTs", badPMTs);
+  int numBS = 0;
+  for (auto included : m_includedBoardstacks) if (not included) numBS++;
+  setEpicsPV("numExcludedBS", numBS);
   updateEpicsPVs(5.0);
 
   B2DEBUG(20, "badBoardstacks: " << badBoardstacks);
   B2DEBUG(20, "badCarriers: " << badCarriers);
   B2DEBUG(20, "badAsics: " << badAsics);
   B2DEBUG(20, "badPMTs: " << badPMTs);
+  B2DEBUG(20, "excludedBS: " << numBS);
 }
 
 void DQMHistAnalysisTOPModule::updateLimits()
@@ -732,30 +731,49 @@ void DQMHistAnalysisTOPModule::updateLimits()
 
   setAlarmLines();
 
-  m_excludedBoardstacks.clear();
-  std::vector<std::string> bsLabels = {"a", "b", "c", "d"};
-  for (int slot = 1; slot <= 16; slot++) {
-    std::vector<double> includedBS(4);
-    for (int bs = 0; bs < 4; bs++) includedBS[bs] = m_includedBoardstacks[(slot - 1) * 4 + bs];
-    std::string varName = "slot" + to_string(slot);
-    requestLimitsFromEpicsPVs(varName, includedBS[0], includedBS[1], includedBS[2], includedBS[3]);
-    for (int bs = 0; bs < 4; bs++) {
-      int index = (slot - 1) * 4 + bs;
-      m_includedBoardstacks[index] = (includedBS[bs] != 0);
-      if (not m_includedBoardstacks[index]) m_excludedBoardstacks.push_back(to_string(slot) + bsLabels[bs]);
+  bool status = false;
+  std::string excludedBS = getEpicsStringPV("excludedBoardstacks", status);
+
+  if (status) {
+    m_excludedBoardstacks.clear();
+    std::string name;
+    for (auto c : excludedBS) {
+      if (isspace(c)) continue;
+      else if (ispunct(c)) {
+        if (not name.empty()) {
+          m_excludedBoardstacks.push_back(name);
+          name.clear();
+        }
+      } else name.push_back(c);
     }
+    if (not name.empty()) {
+      m_excludedBoardstacks.push_back(name);
+    }
+    setIncludedBoardstacks(m_excludedBoardstacks);
   }
 
-  B2DEBUG(20, "asicWindowsBand:           [" << m_asicWindowsBand[0] << ", " << m_asicWindowsBand[1] << "]");
-  B2DEBUG(20, "asicWindowsAlarmLevels:    [" << m_asicWindowsAlarmLevels[0] << ", " << m_asicWindowsAlarmLevels[1] << "]");
+  B2DEBUG(20, "asicWindowsBand:         [" << m_asicWindowsBand[0] << ", " << m_asicWindowsBand[1] << "]");
+  B2DEBUG(20, "asicWindowsAlarmLevels:  [" << m_asicWindowsAlarmLevels[0] << ", " << m_asicWindowsAlarmLevels[1] << "]");
   B2DEBUG(20, "eventMonitorAlarmLevels: [" << m_eventMonitorAlarmLevels[0] << ", " << m_eventMonitorAlarmLevels[1] << "]");
-  B2DEBUG(20, "junkHitsAlarmLevels:      [" << m_junkHitsAlarmLevels[0] << ", " << m_junkHitsAlarmLevels[1] << "]");
+  B2DEBUG(20, "junkHitsAlarmLevels:     [" << m_junkHitsAlarmLevels[0] << ", " << m_junkHitsAlarmLevels[1] << "]");
   B2DEBUG(20, "deadChannelsAlarmLevels: [" << m_deadChannelsAlarmLevels[0] << ", " << m_deadChannelsAlarmLevels[1] << "]");
   B2DEBUG(20, "backgroundAlarmLevels:   [" << m_backgroundAlarmLevels[0] << ", " << m_backgroundAlarmLevels[1] << "]");
   B2DEBUG(20, "photonYieldsAlarmLevels: [" << m_photonYieldsAlarmLevels[0] << ", " << m_photonYieldsAlarmLevels[1] << "]");
   std::string ss;
   for (const auto& s : m_excludedBoardstacks) ss += "'" + s + "', ";
   if (ss.size() > 2)  {ss.pop_back(); ss.pop_back();}
   B2DEBUG(20, "excludedBoardstacks:     [" << ss << "]");
+
 }
 
+void DQMHistAnalysisTOPModule::setIncludedBoardstacks(const std::vector<std::string>& excludedBoardstacks)
+{
+  m_includedBoardstacks.clear();
+  m_includedBoardstacks.resize(64, true);
+
+  for (const auto& bsname : excludedBoardstacks) {
+    int id = m_bsmap[bsname];
+    if (id > 0) m_includedBoardstacks[id - 1] = false;
+    else B2ERROR("Invalid boardstack name: " << bsname);
+  }
+}

dqm/core/include/DQMHistAnalysis.h

@@ -335,6 +335,13 @@ namespace Belle2 {
      */
     void setEpicsPV(std::string keyname, int value);
 
+    /**
+     * Write string to a EPICS PV
+     * @param keyname key name (or full PV name) of PV
+     * @param value string to write
+     */
+    void setEpicsStringPV(std::string keyname, std::string value);
+
     /**
      * Write value to a EPICS PV
      * @param index index of PV
@@ -349,6 +356,13 @@ namespace Belle2 {
      */
     void setEpicsPV(int index, int value);
 
+    /**
+     * Write string to a EPICS PV
+     * @param index index of PV
+     * @param value string to write
+     */
+    void setEpicsStringPV(int index, std::string value);
+
     /**
      * Read value from a EPICS PV
      * @param keyname key name (or full PV name) of PV
@@ -363,6 +377,22 @@ namespace Belle2 {
      */
     double getEpicsPV(int index);
 
+    /**
+     * Read value from a EPICS PV
+     * @param keyname key name (or full PV name) of PV
+     * @param status return status (true on success)
+     * @return string value (empty string if non existing)
+     */
+    std::string getEpicsStringPV(std::string keyname, bool& status);
+
+    /**
+     * Read value from a EPICS PV
+     * @param index index of PV
+     * @param status return status (true on success)
+     * @return string value (empty string if non existing)
+     */
+    std::string getEpicsStringPV(int index, bool& status);
+
     /**
      * Update all EPICS PV (flush to network)
      * @param timeout maximum time until timeout in s

dqm/core/src/DQMHistAnalysis.cc

@@ -344,6 +344,24 @@ void DQMHistAnalysisModule::setEpicsPV(std::string keyname, int value)
 #endif
 }
 
+void DQMHistAnalysisModule::setEpicsStringPV(std::string keyname, std::string value)
+{
+  if (!m_useEpics || m_epicsReadOnly) return;
+#ifdef _BELLE2_EPICS
+  if (m_epicsNameToChID[keyname] == nullptr) {
+    B2ERROR("Epics PV " << keyname << " not registered!");
+    return;
+  }
+  if (value.length() > 40) {
+    B2ERROR("Epics string PV " << keyname << " too long (>40 characters)!");
+    return;
+  }
+  char text[40];
+  strcpy(text, value.c_str());
+  SEVCHK(ca_put(DBR_STRING, m_epicsNameToChID[keyname], text), "ca_set failure");
+#endif
+}
+
 void DQMHistAnalysisModule::setEpicsPV(int index, double value)
 {
   if (!m_useEpics || m_epicsReadOnly) return;
@@ -368,6 +386,20 @@ void DQMHistAnalysisModule::setEpicsPV(int index, int value)
 #endif
 }
 
+void DQMHistAnalysisModule::setEpicsStringPV(int index, std::string value)
+{
+  if (!m_useEpics || m_epicsReadOnly) return;
+#ifdef _BELLE2_EPICS
+  if (index < 0 || index >= (int)m_epicsChID.size()) {
+    B2ERROR("Epics PV with " << index << " not registered!");
+    return;
+  }
+  char text[40];
+  strcpy(text, value.c_str());
+  SEVCHK(ca_put(DBR_STRING, m_epicsChID[index], text), "ca_set failure");
+#endif
+}
+
 double DQMHistAnalysisModule::getEpicsPV(std::string keyname)
 {
   double value{NAN};
@@ -414,6 +446,55 @@ double DQMHistAnalysisModule::getEpicsPV(int index)
   return NAN;
 }
 
+std::string DQMHistAnalysisModule::getEpicsStringPV(std::string keyname, bool& status)
+{
+  status = false;
+  char value[40] = "";
+  if (!m_useEpics) return std::string(value);
+#ifdef _BELLE2_EPICS
+  if (m_epicsNameToChID[keyname] == nullptr) {
+    B2ERROR("Epics PV " << keyname << " not registered!");
+    return std::string(value);
+  }
+  // From EPICS doc. When ca_get or ca_array_get are invoked the returned channel value cant be assumed to be stable
+  // in the application supplied buffer until after ECA_NORMAL is returned from ca_pend_io. If a connection is lost
+  // outstanding get requests are not automatically reissued following reconnect.
+  auto r = ca_get(DBR_STRING, m_epicsNameToChID[keyname], value);
+  if (r == ECA_NORMAL) r = ca_pend_io(5.0); // this is needed!
+  if (r == ECA_NORMAL) {
+    status = true;
+    return std::string(value);
+  } else {
+    SEVCHK(r, "ca_get or ca_pend_io failure");
+  }
+#endif
+  return std::string(value);
+}
+
+std::string DQMHistAnalysisModule::getEpicsStringPV(int index, bool& status)
+{
+  status = false;
+  char value[40] = "";
+  if (!m_useEpics) return std::string(value);
+#ifdef _BELLE2_EPICS
+  if (index < 0 || index >= (int)m_epicsChID.size()) {
+    B2ERROR("Epics PV with " << index << " not registered!");
+    return std::string(value);
+  }
+  // From EPICS doc. When ca_get or ca_array_get are invoked the returned channel value cant be assumed to be stable
+  // in the application supplied buffer until after ECA_NORMAL is returned from ca_pend_io. If a connection is lost
+  // outstanding get requests are not automatically reissued following reconnect.
+  auto r = ca_get(DBR_DOUBLE, m_epicsChID[index], value);
+  if (r == ECA_NORMAL) r = ca_pend_io(5.0); // this is needed!
+  if (r == ECA_NORMAL) {
+    status = true;
+    return std::string(value);
+  } else {
+    SEVCHK(r, "ca_get or ca_pend_io failure");
+  }
+#endif
+  return std::string(value);
+}
 
 chid DQMHistAnalysisModule::getEpicsPVChID(std::string keyname)
 {