Provides mapping between electronics module position within a TOP module and SCROD ID, COPPER and Finesse slot. More...

#include <FrontEndMapper.h>

Public Member Functions
	FrontEndMapper ()
	constructor

void	initialize (const GearDir &frontEndMapping)
	Initialize from Gearbox (XML)

void	initialize ()
	Initialize from database.

bool	isValid () const
	check if the mapping is available

void	importPayload (const IntervalOfValidity &iov) const
	import mappings to database

const TOPFrontEndMap *	getMap (int moduleID, int bs) const
	Return map from TOP module side.

const TOPFrontEndMap *	getMap (unsigned short scrodID) const
	Return map from SCROD side.

const TOPFrontEndMap *	getMapFromCopper (unsigned copperID, int finesse) const
	Return map from COPPER/Finesse side.

int	getMapSize () const
	Return size of the map.

const std::unordered_set< unsigned int > &	getCopperIDs () const
	Return a set of copper ID's.

int	getModuleCNumber (int moduleID) const
	Returns module construction number.

void	print () const
	Print mappings to terminal screen.

Private Types
enum	{ c_numModules = 16 , c_numColumns = 4 }
	Number of TOP modules (number of physical ones can be less), number of electronic modules (SCROD's) per TOP module. More...

Private Member Functions
void	clear ()
	Clear.

void	update ()
	re-do conversion maps when DBArray has changed

Private Attributes
std::vector< TOPFrontEndMap >	m_mapping
	mappings from gearbox

DBArray< TOPFrontEndMap >	m_mappingDB
	mappings from database

bool	m_valid = false
	true, if mapping available

bool	m_fromDB = false
	true, if from database

std::unordered_set< unsigned int >	m_copperIDs
	COPPER ID's.

const TOPFrontEndMap *	m_fromModule [c_numModules][c_numColumns] = {{0}}
	conversion

std::map< unsigned short, const TOPFrontEndMap * >	m_fromScrod
	conversion

std::map< unsigned int, const TOPFrontEndMap * >	m_fromCopper
	conversion

Detailed Description

Provides mapping between electronics module position within a TOP module and SCROD ID, COPPER and Finesse slot.

Definition at line 31 of file FrontEndMapper.h.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum

private

Number of TOP modules (number of physical ones can be less), number of electronic modules (SCROD's) per TOP module.

Definition at line 151 of file FrontEndMapper.h.

151{c_numModules = 16, c_numColumns = 4};

Constructor & Destructor Documentation

◆ FrontEndMapper()

FrontEndMapper ( )

constructor

Definition at line 24 of file FrontEndMapper.cc.

    {
      for (unsigned i = 0; i < c_numModules; i++) {
        for (unsigned k = 0; k < c_numColumns; k++) {
          m_fromModule[i][k] = 0;
        }
      }
    }

Member Function Documentation

◆ clear()

void clear ( )

private

Clear.

Definition at line 170 of file FrontEndMapper.cc.

    {
      m_mapping.clear();
      m_copperIDs.clear();
      m_fromScrod.clear();
      m_fromCopper.clear();
      for (unsigned i = 0; i < c_numModules; i++) {
        for (unsigned k = 0; k < c_numColumns; k++) {
          m_fromModule[i][k] = 0;
        }
      }
      m_valid = false;
      m_fromDB = false;
    }

◆ getCopperIDs()

const std::unordered_set< unsigned int > & getCopperIDs ( ) const

inline

Return a set of copper ID's.

Returns: copper ID's

Definition at line 121 of file FrontEndMapper.h.

      {
        return m_copperIDs;
      }

◆ getMap() [1/2]

const TOPFrontEndMap * getMap	(	int	moduleID,
		int	bs ) const

inline

Return map from TOP module side.

Parameters

moduleID	TOP module ID
bs	boardstack number

Returns: pointer to map element or NULL

Definition at line 69 of file FrontEndMapper.h.

      {
        moduleID--;
        if (moduleID >= 0 and moduleID < c_numModules and bs >= 0 and bs < c_numColumns)
          return m_fromModule[moduleID][bs];
        return 0;
      }

◆ getMap() [2/2]

const TOPFrontEndMap * getMap ( unsigned short scrodID ) const

inline

Return map from SCROD side.

Parameters

scrodID SCROD ID

Returns: pointer to map element or NULL

Definition at line 82 of file FrontEndMapper.h.

      {
        std::map<unsigned short, const TOPFrontEndMap*>::const_iterator it =
          m_fromScrod.find(scrodID);
        if (it == m_fromScrod.end()) return 0;
        return it->second;
      }

◆ getMapFromCopper()

const TOPFrontEndMap * getMapFromCopper	(	unsigned	copperID,
		int	finesse ) const

inline

Return map from COPPER/Finesse side.

Parameters

copperID	COPPER ID
finesse	Finesse slot number

Returns: pointer to map element or NULL

Definition at line 96 of file FrontEndMapper.h.

      {
        std::map<unsigned int, const TOPFrontEndMap*>::const_iterator it =
          m_fromCopper.find(copperID * 4 + finesse);
        if (it == m_fromCopper.end()) return 0;
        return it->second;
      }

◆ getMapSize()

int getMapSize ( ) const

inline

Return size of the map.

Returns: size

Definition at line 108 of file FrontEndMapper.h.

      {
        if (m_fromDB) {
          return m_mappingDB.getEntries();
        } else {
          return m_mapping.size();
        }
      }

◆ getModuleCNumber()

int getModuleCNumber ( int moduleID ) const

inline

Returns module construction number.

Parameters

moduleID module ID (slot number)

Returns: module construction number

Definition at line 131 of file FrontEndMapper.h.

      {
        for (int bs = 0; bs < c_numColumns; bs++) {
          const auto* map = getMap(moduleID, bs);
          if (map) return map->getModuleCNumber();
        }
        return 0;
      }

◆ importPayload()

void importPayload ( const IntervalOfValidity & iov ) const

import mappings to database

Parameters

iov	Interval of validity.

Definition at line 160 of file FrontEndMapper.cc.

    {
      DBImportArray<TOPFrontEndMap> array;
      for (const auto& map : m_mapping) {
        array.appendNew(map);
      }
      array.import(iov);
    }

◆ initialize() [1/2]

void initialize ( )

Initialize from database.

Definition at line 142 of file FrontEndMapper.cc.

    {
      if (!m_mappingDB.isValid()) {
        clear();
        return;
      }
      update();
 
      m_mappingDB.addCallback(this, &FrontEndMapper::update);
 
      const auto& logSystem = LogSystem::Instance();
      if (logSystem.isLevelEnabled(LogConfig::c_Debug, 100, "top")) {
        print();
      }
 
    }

◆ initialize() [2/2]

void initialize ( const GearDir & frontEndMapping )

Initialize from Gearbox (XML)

Parameters

frontEndMapping XML data directory

Definition at line 34 of file FrontEndMapper.cc.

    {
 
      clear();
 
      // unordered sets used to check that ...
 
      unordered_set<unsigned short> scrodIDs; // all SCROD ID's are different
      unordered_set<string> coppers; // COPPER inputs are used only once
      unordered_set<int> modules; // (moduleID, col) mapped only once
 
      // read parameters from gerabox
      int numModules = 0; // counter of mapped modules
      for (const GearDir& topModule : frontEndMapping.getNodes("TOPModule")) {
 
        int moduleCNumber = topModule.getInt("@CNumber");
        int moduleID = topModule.getInt("moduleID");
        if (moduleID == 0) continue; // module is not installed into barrel
        if (moduleID < 0 or moduleID > c_numModules) {
          B2ERROR("TOP::FrontEndMapper: invalid moduleID in xml file"
                  << LogVar("moduleID", moduleID)
                  << LogVar("path", topModule.getPath()));
          return;
        }
 
        bool moduleMapped = false; // to count mapped modules
        for (const GearDir& boardstack : topModule.getNodes("Boardstack")) {
 
          int col = boardstack.getInt("@col");
          if (col < 0 or col >= c_numColumns) {
            B2ERROR("TOP::FrontEndMapper: invalid boardstack number in xml file"
                    << LogVar("moduleID", moduleID)
                    << LogVar("boardstack", col)
                    << LogVar("path", boardstack.getPath()));
            return;
          }
          if (!modules.insert(moduleID * c_numColumns + col).second) {
            B2ERROR("TOP::FrontEndMapper: this boardstack is already mapped."
                    << LogVar("moduleID", moduleID)
                    << LogVar("boardstack", col)
                    << LogVar("path", boardstack.getPath()));
            return;
          }
 
          unsigned short scrodID = (unsigned short) boardstack.getInt("SCRODid");
          if (!scrodIDs.insert(scrodID).second) {
            B2ERROR("TOP::FrontEndMapper: this SCROD ID is already used."
                    << LogVar("moduleID", moduleID)
                    << LogVar("boardstack", col)
                    << LogVar("scrod", scrodID)
                    << LogVar("path", boardstack.getPath() + "/SCRODid"));
            return;
          }
 
          string finesseSlot = boardstack.getString("FinesseSlot");
          int finesse = 0;
          if (finesseSlot == "A") {finesse = 0;}
          else if (finesseSlot == "B") {finesse = 1;}
          else if (finesseSlot == "C") {finesse = 2;}
          else if (finesseSlot == "D") {finesse = 3;}
          else {
            B2ERROR("TOP::FrontEndMapper: invalid finesse slot (valid are A, B, C, D)."
                    << LogVar("FinesseSlot", finesseSlot)
                    << LogVar("path", boardstack.getPath() + "/FinesseSlot"));
            return;
          }
 
          unsigned copperID = (unsigned) boardstack.getInt("COPPERid");
          m_copperIDs.insert(copperID);
          string copper = boardstack.getString("COPPERid") + " " + finesseSlot;
          if (!coppers.insert(copper).second) {
            B2ERROR("TOP::FrontEndMapper: this COPPER ID is already used."
                    << LogVar("moduleID", moduleID)
                    << LogVar("boardstack", col)
                    << LogVar("copperID", copper)
                    << LogVar("path", boardstack.getPath() + "/COPPERid"));
            return;
          }
 
          TOPFrontEndMap feemap(moduleID, moduleCNumber, col, scrodID, copperID, finesse,
                                m_mapping.size());
          m_mapping.push_back(feemap);
          moduleMapped = true;
        }
        if (moduleMapped) numModules++;
      }
 
      // set conversion objects
 
      for (const auto& feemap : m_mapping) {
        m_fromModule[feemap.getModuleID() - 1][feemap.getBoardstackNumber()] = &feemap;
        m_fromScrod[feemap.getScrodID()] = &feemap;
        m_fromCopper[feemap.getCopperID() * 4 + feemap.getFinesseSlot()] = &feemap;
      }
      m_valid = true;
 
      B2INFO("TOP::FrontEndMapper: " << m_mapping.size() << " SCROD's mapped to "
             << numModules << " TOP module(s)");
 
      // print mappings if debug level for package 'top' is set to 100 or larger
      const auto& logSystem = LogSystem::Instance();
      if (logSystem.isLevelEnabled(LogConfig::c_Debug, 100, "top")) {
        print();
      }
 
    }

◆ isValid()

bool isValid ( ) const

inline

check if the mapping is available

Returns: true if available

Definition at line 55 of file FrontEndMapper.h.

55{return m_valid;}

◆ print()

void print ( ) const

Print mappings to terminal screen.

Definition at line 202 of file FrontEndMapper.cc.

    {
      cout << endl;
      cout << "           Mapping of TOP front-end electronics" << endl << endl;
 
      const char label[5] = "ABCD";
      for (int i = 0; i < c_numModules; i++) {
        int moduleID = i + 1;
        cout << " slot " << moduleID
             << " (module " << getModuleCNumber(moduleID) << "):" << endl;
        for (int bs = 0; bs < c_numColumns; bs++) {
          const auto* map = getMap(moduleID, bs);
          if (!map) continue;
          cout << "   BS" << bs;
          cout << " scrod " << map->getScrodID();
          if (map->getScrodID() < 10) cout << " ";
          if (map->getScrodID() < 100) cout << " ";
          cout << "  copper " << map->getCopperID();
          cout << " " << label[map->getFinesseSlot()];
          cout << endl;
        }
      }
      cout << endl;
 
    }

◆ update()

void update ( )

private

re-do conversion maps when DBArray has changed

Definition at line 186 of file FrontEndMapper.cc.

    {
      clear();
      if (!m_mappingDB.isValid()) return;
 
      for (const auto& feemap : m_mappingDB) {
        m_copperIDs.insert(feemap.getCopperID());
        m_fromModule[feemap.getModuleID() - 1][feemap.getBoardstackNumber()] = &feemap;
        m_fromScrod[feemap.getScrodID()] = &feemap;
        m_fromCopper[feemap.getCopperID() * 4 + feemap.getFinesseSlot()] = &feemap;
      }
      m_valid = true;
      m_fromDB = true;
    }

Member Data Documentation

◆ m_copperIDs

std::unordered_set<unsigned int> m_copperIDs

private

COPPER ID's.

Definition at line 168 of file FrontEndMapper.h.

◆ m_fromCopper

std::map<unsigned int, const TOPFrontEndMap*> m_fromCopper

private

conversion

Definition at line 171 of file FrontEndMapper.h.

◆ m_fromDB

bool m_fromDB = false

private

true, if from database

Definition at line 166 of file FrontEndMapper.h.

◆ m_fromModule

const TOPFrontEndMap* m_fromModule[c_numModules][c_numColumns] = {{0}}

private

conversion

Definition at line 169 of file FrontEndMapper.h.

169{{0}};

◆ m_fromScrod

std::map<unsigned short, const TOPFrontEndMap*> m_fromScrod

private

conversion

Definition at line 170 of file FrontEndMapper.h.

◆ m_mapping

std::vector<TOPFrontEndMap> m_mapping

private

mappings from gearbox

Definition at line 163 of file FrontEndMapper.h.

◆ m_mappingDB

DBArray<TOPFrontEndMap> m_mappingDB

private

mappings from database

Definition at line 164 of file FrontEndMapper.h.

◆ m_valid

bool m_valid = false

private

true, if mapping available

Definition at line 165 of file FrontEndMapper.h.

The documentation for this class was generated from the following files:

top/geometry/include/FrontEndMapper.h
top/geometry/src/FrontEndMapper.cc

Public Member Functions

Private Types

Private Member Functions

Private Attributes

Detailed Description

Member Enumeration Documentation

◆ anonymous enum

Constructor & Destructor Documentation

◆ FrontEndMapper()

Member Function Documentation

◆ clear()

◆ getCopperIDs()

◆ getMap() [1/2]

◆ getMap() [2/2]

◆ getMapFromCopper()

◆ getMapSize()

◆ getModuleCNumber()

◆ importPayload()

◆ initialize() [1/2]

◆ initialize() [2/2]

◆ isValid()

◆ print()

◆ update()

Member Data Documentation

◆ m_copperIDs

◆ m_fromCopper

◆ m_fromDB

◆ m_fromModule

◆ m_fromScrod

◆ m_mapping

◆ m_mappingDB

◆ m_valid