Jcampos/add channel status

otsdaq-mu2e-calorimeter/CMakeLists.txt

@@ -1,3 +1,4 @@
 add_subdirectory(FEInterfaces)
 add_subdirectory(Generators)
 add_subdirectory(ArtModules)
+add_subdirectory(TablePlugins)

otsdaq-mu2e-calorimeter/TablePlugins/CMakeLists.txt

@@ -0,0 +1,12 @@
+
+include(otsdaq::table)
+
+cet_build_plugin(SubsystemCalorimeterParametersTable otsdaq::table LIBRARIES REG 
+    otsdaq::SlowControlsTableBase
+    otsdaq::XDAQContextTable
+  )
+
+
+
+install_headers()
+install_source()

otsdaq-mu2e-calorimeter/TablePlugins/SubsystemCalorimeterParametersTable.h

@@ -0,0 +1,71 @@
+#ifndef _ots_SubsystemCalorimeterParametersTable_h_
+#define _ots_SubsystemCalorimeterParametersTable_h_
+
+#include "otsdaq/ConfigurationInterface/ConfigurationManager.h"
+#include "otsdaq/TableCore/TableBase.h"
+
+namespace ots {
+class SubsystemCalorimeterParametersTable : public TableBase {
+	// clang-format off
+
+  public:
+	SubsystemCalorimeterParametersTable						(void);
+	virtual ~SubsystemCalorimeterParametersTable				(void);
+
+	// Methods
+	void 					init						(ConfigurationManager* configManager) override;
+
+	virtual std::string		getStructureAsJSON			(const ConfigurationManager* configManager) override;
+
+	virtual std::string		getChannelMapAndCSVFormat	(const ConfigurationManager* configManager, const std::string& OfflineCxxClassName);
+
+	virtual std::string		getStatusTableInCSVFormat	(const ConfigurationManager* configManager, const std::string& OfflineCxxClassName);
+
+	void 					generateOfflineTableMap		(const ConfigurationManager* configManager);
+
+	void 					loadNominalChannelMap		();
+
+	bool					isFirstAppInContext_	= false;
+
+  private:
+
+	const static std::string PATH_TO_TRIGGER_OFFLINE_DB;
+	const static std::string CHANNEL_STATUS_TABLE;
+	const static std::string CHANNEL_MAP_TABLE;
+	const static uint32_t CHANNELS_PER_BOARD = 20;
+
+	std::map<std::string, std::string> mapOfflineTables_;
+	std::map<uint16_t, uint16_t> mapChannels_;
+
+	// Column names
+	struct ColParameters // Calorimeter subsystem top level
+	{
+		// Incomplete list
+		std::string const colLinkToFETypeTable					= "LinkToChannelStatusTableInfo";
+		std::string const colLinkToSlowControlsChannelTable_ 	= "LinkToChannelThresholdTableInfo";
+	} ColParameters;
+
+	struct ColChannelMap // LinkToChannelMapTableInfo
+	{
+		std::string const offlineId_ = "offID";
+		std::string const onlineId_  = "FEEchan";
+	} ColChannelMap;
+
+	struct ColChannelStatus // LinkToChannelStatusTableInfo
+	{
+		std::string const colBoardId_ 		= "BoardID";
+		std::string const colStatus_		= "Status";
+	} ColChannelStatus;
+
+	struct ColChannelThreshold // LinkToChannelThresholdTableInfo
+	{
+		std::string const colStatus_ 				= "BoardID";
+		std::string const colROCGroupID_			= "Thresholds";
+		std::string const colROCInterfacePluginName_= "Baseline";
+		std::string const colLinkToSlowControlsChannelTable_ 	= "LinkToSlowControlsChannelTable";
+	} ColChannelThreshold;
+
+	// clang-format on
+};
+}  // namespace ots
+#endif

otsdaq-mu2e-calorimeter/TablePlugins/SubsystemCalorimeterParametersTable_table.cc

@@ -0,0 +1,165 @@
+#include "otsdaq-mu2e-calorimeter/TablePlugins/SubsystemCalorimeterParametersTable.h"
+#include "otsdaq/Macros/TablePluginMacros.h"  //for DEFINE_OTS_TABLE
+
+#include "otsdaq/TablePlugins/XDAQContextTable/XDAQContextTable.h"
+
+#include <sys/stat.h>  //for mkdir
+#include <fstream>
+#include <iostream>
+
+using namespace ots;
+
+const std::string SubsystemCalorimeterParametersTable::PATH_TO_TRIGGER_OFFLINE_DB = getenv("PATH_TO_TRIGGER_OFFLINE_DB") ? getenv("PATH_TO_TRIGGER_OFFLINE_DB") : "";
+const std::string SubsystemCalorimeterParametersTable::CHANNEL_MAP_TABLE          = "SubsystemCalorimeterMapTable";
+const std::string SubsystemCalorimeterParametersTable::CHANNEL_STATUS_TABLE       = "SubsystemCalorimeterStatusTable";
+
+//==============================================================================
+SubsystemCalorimeterParametersTable::SubsystemCalorimeterParametersTable(void) : TableBase("SubsystemCalorimeterParametersTable") {}
+
+//==============================================================================
+SubsystemCalorimeterParametersTable::~SubsystemCalorimeterParametersTable(void) {}
+
+//==============================================================================
+/// init
+/// generate calo specific files needed by the online trigger and save them in the filesystem 'offline' db
+void SubsystemCalorimeterParametersTable::init(ConfigurationManager* configManager) {
+	// use isFirstAppInContext to only run once per context, for example to avoid
+	//	generating files on local disk multiple times.
+	bool isFirstAppInContext_ = configManager->isOwnerFirstAppInContext();
+
+	__COUTV__(isFirstAppInContext_);
+	if(!isFirstAppInContext_)
+		return;
+
+	__COUTV__(SubsystemCalorimeterParametersTable::PATH_TO_TRIGGER_OFFLINE_DB);
+	if(SubsystemCalorimeterParametersTable::PATH_TO_TRIGGER_OFFLINE_DB.size() == 0)
+		return;
+
+	__COUT__ << "*&*&*&*&*&*&*&*&*&*&*&*&*&*&*&*&*&*&*&*&*&*" << __E__;
+	__COUT__ << configManager->__SELF_NODE__ << __E__;
+
+	generateOfflineTableMap(configManager);
+
+	for(const auto& offlineTable : mapOfflineTables_) {
+		std::string offlineTableFileName = PATH_TO_TRIGGER_OFFLINE_DB + "/" + offlineTable.first + ".txt";
+
+		try {
+			std::ofstream out(offlineTableFileName);
+			if(!out) {
+				__COUTT__ << "Failed to open file: " << offlineTableFileName;
+				return;
+			}
+			out << offlineTable.second;
+			out.close();
+		} catch(const std::exception& e) {
+			__COUT__ << "Failed to write offline table " << offlineTable.first << " to file.";
+			__COUT__ << e.what() << __E__;
+		}
+	}
+
+}  // end init()
+
+//==============================================================================
+void SubsystemCalorimeterParametersTable::generateOfflineTableMap(const ConfigurationManager* configManager) {
+	mapOfflineTables_.clear();
+	mapOfflineTables_["CalChannelMap"] = getChannelMapAndCSVFormat(configManager, "CalChannelMap");
+	__COUTT__ << mapOfflineTables_["CalChannelMap"] << __E__;
+	mapOfflineTables_["CalChannelStatus"] = getStatusTableInCSVFormat(configManager, "CalChannelStatus");
+	__COUTT__ << mapOfflineTables_["CalChannelStatus"] << __E__;
+}  // end generateOfflineTableMap()
+
+//==============================================================================
+std::string SubsystemCalorimeterParametersTable::getChannelMapAndCSVFormat(const ConfigurationManager* configManager, const std::string& OfflineCxxClassName) {
+	mapChannels_.clear();
+
+	std::stringstream OfflineTable;
+	OfflineTable << "TABLE " << OfflineCxxClassName << __E__;
+	std::vector<std::pair<std::string, ConfigurationTree>> channelMapRecords = configManager->getNode(SubsystemCalorimeterParametersTable::CHANNEL_MAP_TABLE).getChildren();
+
+	// start main fe/DTC record loop
+	for(auto& channelMapPair : channelMapRecords) {
+		uint16_t onlineID      = channelMapPair.second.getNode(ColChannelMap.onlineId_).getValue<uint16_t>();
+		uint16_t offlineID     = channelMapPair.second.getNode(ColChannelMap.offlineId_).getValue<uint16_t>();
+		mapChannels_[onlineID] = offlineID;
+
+		OfflineTable << onlineID << "," << offlineID << "\n";
+	}
+	return OfflineTable.str();
+}  // end getChannelMapAndCSVFormat()
+
+//==============================================================================
+std::string SubsystemCalorimeterParametersTable::getStatusTableInCSVFormat(const ConfigurationManager* configManager, const std::string& OfflineCxxClassName) {
+	std::stringstream OfflineTable;
+	OfflineTable << "TABLE " << OfflineCxxClassName << __E__;
+	std::vector<std::pair<std::string, ConfigurationTree>> channelStatusRecords = configManager->getNode(SubsystemCalorimeterParametersTable::CHANNEL_STATUS_TABLE).getChildren();
+
+	// start main fe/DTC record loop
+	for(auto& channelStatusPair : channelStatusRecords) {
+		uint32_t                               boardID = channelStatusPair.second.getNode(ColChannelStatus.colBoardId_).getValue<uint32_t>();
+		ConfigurationTree::BitMap<std::string> bitmap  = channelStatusPair.second.getNode(ColChannelStatus.colStatus_).getValueAsBitMap();
+
+		// assume data is 1-dimensional
+		for(uint32_t j = 0; j < bitmap.numberOfColumns(0); j++) {
+			OfflineTable << mapChannels_.at(boardID * CHANNELS_PER_BOARD + j) << ", ";
+			OfflineTable << ((bitmap.get(0, j).size() == 0) ? "0" : bitmap.get(0, j));
+			OfflineTable << ((j + 1 == bitmap.numberOfColumns(0)) ? "" : "\n");
+		}
+	}
+	return OfflineTable.str();
+}  // end getStatusTableInCSVFormat()
+
+//==============================================================================
+// return status structures
+std::string SubsystemCalorimeterParametersTable::getStructureAsJSON(const ConfigurationManager* cfgMgr) {
+	// Don't generate maps if done already in init()
+	if(mapOfflineTables_.size() == 0)
+		generateOfflineTableMap(cfgMgr);
+
+	std::vector<std::pair<std::string, ConfigurationTree>> channelStatusRecords = cfgMgr->getNode(SubsystemCalorimeterParametersTable::CHANNEL_STATUS_TABLE).getChildren();
+
+	std::stringstream outstream;
+
+	outstream << "{";
+
+	// Write all cat-3 tables converted from MongoDB
+	outstream << "\t\"cat3\": {" << __E__;
+	std::map<std::string, std::string>::iterator it;
+	for(it = mapOfflineTables_.begin(); it != mapOfflineTables_.end(); ++it) {
+		outstream << "\"" << it->first << "\":" << it->second;
+		outstream << (std::next(it) == mapOfflineTables_.end() ? "" : ",");
+	}
+	outstream << "},";
+
+	// Write any desired table in a custom format for user-friendly quick reading
+	outstream << "\t\"custom\": ";
+	outstream << "{" << __E__;
+	outstream << "\t\"Number of rows\": " << channelStatusRecords.size() << "," << __E__;
+	outstream << "\t[" << __E__;
+
+	uint16_t statusPairIdx = 0;
+	for(auto& channelStatusPair : channelStatusRecords) {
+		uint16_t                               boardID = channelStatusPair.second.getNode(ColChannelStatus.colBoardId_).getValue<uint16_t>();
+		ConfigurationTree::BitMap<std::string> bitmap  = channelStatusPair.second.getNode(ColChannelStatus.colStatus_).getValueAsBitMap();
+		statusPairIdx++;
+
+		outstream << "\t\t{" << __E__;
+		outstream << "\t\t\"BoardID\": " << boardID << "," << __E__;
+		outstream << "\t\t\"Rows\": " << bitmap.numberOfRows() << "," << __E__;
+		outstream << "\t\t\"BitMap\": [";
+
+		// assume data is 1-dimensional
+		for(uint32_t j = 0; j < bitmap.numberOfColumns(0); j++) {
+			outstream << ((bitmap.get(0, j).size() == 0) ? "0" : bitmap.get(0, j));
+			outstream << ((j + 1 == bitmap.numberOfColumns(0)) ? "" : ", ");
+		}
+		outstream << "]" << __E__;
+		outstream << "\t\t}" << (statusPairIdx == channelStatusRecords.size() ? "" : ",") << __E__;
+	}
+
+	outstream << "\t]" << __E__;
+	outstream << "}";  // close custom blob
+	outstream << "}";  // close full blob
+	return outstream.str();
+}  // end getStructureAsJSON()
+
+DEFINE_OTS_TABLE(SubsystemCalorimeterParametersTable)