TotemDAQMappingESSourceXML Class Reference

Loads TotemDAQMapping and TotemAnalysisMask from two XML files. More...

Inheritance diagram for TotemDAQMappingESSourceXML:

Classes
struct	ConfigBlock

Public Member Functions
edm::ESProducts< std::unique_ptr< TotemDAQMapping >, std::unique_ptr< TotemAnalysisMask > >	produce (const TotemReadoutRcd &)
	TotemDAQMappingESSourceXML (const edm::ParameterSet &)
	~TotemDAQMappingESSourceXML () override
Public Member Functions inherited from edm::ESProducer
	ESProducer ()
	ESProducer (const ESProducer &)=delete
ESProxyIndex const *	getTokenIndices (unsigned int iIndex) const
ESRecordIndex const *	getTokenRecordIndices (unsigned int iIndex) const
bool	hasMayConsumes () const noexcept
size_t	numberOfTokenIndices (unsigned int iIndex) const
ESProducer const &	operator= (const ESProducer &)=delete
SerialTaskQueueChain &	queue ()
template<typename Record >
std::optional< std::vector< ESProxyIndex > >	updateFromMayConsumes (unsigned int iIndex, const Record &iRecord) const
void	updateLookup (eventsetup::ESRecordsToProxyIndices const &) final
	~ESProducer () noexcept(false) override
Public Member Functions inherited from edm::ESProxyFactoryProducer
	ESProxyFactoryProducer ()
	ESProxyFactoryProducer (const ESProxyFactoryProducer &)=delete
const ESProxyFactoryProducer &	operator= (const ESProxyFactoryProducer &)=delete
	~ESProxyFactoryProducer () noexcept(false) override
Public Member Functions inherited from edm::eventsetup::DataProxyProvider
void	createKeyedProxies (EventSetupRecordKey const &key, unsigned int nConcurrentIOVs)
	DataProxyProvider ()
	DataProxyProvider (const DataProxyProvider &)=delete
const ComponentDescription &	description () const
void	fillRecordsNotAllowingConcurrentIOVs (std::set< EventSetupRecordKey > &recordsNotAllowingConcurrentIOVs) const
virtual void	initConcurrentIOVs (EventSetupRecordKey const &key, unsigned int nConcurrentIOVs)
bool	isUsingRecord (const EventSetupRecordKey &key) const
KeyedProxies &	keyedProxies (const EventSetupRecordKey &iRecordKey, unsigned int iovIndex=0)
const DataProxyProvider &	operator= (const DataProxyProvider &)=delete
void	setAppendToDataLabel (const edm::ParameterSet &)
void	setDescription (const ComponentDescription &iDescription)
std::set< EventSetupRecordKey >	usingRecords () const
virtual	~DataProxyProvider () noexcept(false)
Public Member Functions inherited from edm::EventSetupRecordIntervalFinder
bool	concurrentFinder () const
const eventsetup::ComponentDescription &	descriptionForFinder () const
	EventSetupRecordIntervalFinder ()
	EventSetupRecordIntervalFinder (const EventSetupRecordIntervalFinder &)=delete
std::set< eventsetup::EventSetupRecordKey >	findingForRecords () const
const ValidityInterval &	findIntervalFor (const eventsetup::EventSetupRecordKey &, const IOVSyncValue &)
bool	nonconcurrentAndIOVNeedsUpdate (const eventsetup::EventSetupRecordKey &key, const IOVSyncValue &syncValue) const
const EventSetupRecordIntervalFinder &	operator= (const EventSetupRecordIntervalFinder &)=delete
void	resetInterval (const eventsetup::EventSetupRecordKey &)
void	setDescriptionForFinder (const eventsetup::ComponentDescription &iDescription)
virtual	~EventSetupRecordIntervalFinder () noexcept(false)

Static Public Attributes
static const std::string	tagAnalysisMask = "analysisMask"
static const std::string	tagArm = "arm"
	Common position tags. More...
static const std::string	tagChannel = "channel"
static const std::string	tagChip1 = "vfat"
	COMMON Chip XML tags. More...
static const std::string	tagChip2 = "test_vfat"
static const std::string	tagDiamondCh = "diamond_channel"
static const std::string	tagDiamondPlane = "rp_plane_diamond"
	diamond specific tags More...
static const std::string	tagRPPlane = "rp_plane"
static const std::string	tagRPPot = "rp_detector_set"
static const std::string	tagRPStation = "station"
	RP XML tags. More...
static const std::string	tagSampicBoard = "rp_sampic_board"
	totem timing specific tags More...
static const std::string	tagSampicCh = "rp_sampic_channel"
static const std::string	tagTotemTimingCh = "timing_channel"
static const std::string	tagTotemTimingPlane = "timing_plane"
static const std::string	tagVFAT = "vfat"

Protected Member Functions
void	setIntervalFor (const edm::eventsetup::EventSetupRecordKey &, const edm::IOVSyncValue &, edm::ValidityInterval &) override
	sets infinite validity of this data More...
Protected Member Functions inherited from edm::ESProducer
template<typename T >
auto	setWhatProduced (T *iThis, const es::Label &iLabel={})
template<typename T >
auto	setWhatProduced (T *iThis, const char *iLabel)
template<typename T >
auto	setWhatProduced (T *iThis, const std::string &iLabel)
template<typename T , typename TDecorator >
auto	setWhatProduced (T *iThis, const TDecorator &iDec, const es::Label &iLabel={})
template<typename T , typename TReturn , typename TRecord >
auto	setWhatProduced (T *iThis, TReturn(T ::*iMethod)(const TRecord &), const es::Label &iLabel={})
template<typename T , typename TReturn , typename TRecord , typename TArg >
ESConsumesCollectorT< TRecord >	setWhatProduced (T *iThis, TReturn(T ::*iMethod)(const TRecord &), const TArg &iDec, const es::Label &iLabel={})
void	usesResources (std::vector< std::string > const &)
Protected Member Functions inherited from edm::ESProxyFactoryProducer
template<class TFactory >
void	registerFactory (std::unique_ptr< TFactory > iFactory, const std::string &iLabel=std::string())
virtual void	registerFactoryWithKey (const EventSetupRecordKey &iRecord, std::unique_ptr< eventsetup::ProxyFactoryBase > iFactory, const std::string &iLabel=std::string())
KeyedProxiesVector	registerProxies (const EventSetupRecordKey &, unsigned int iovIndex) override
Protected Member Functions inherited from edm::eventsetup::DataProxyProvider
template<class T >
void	usingRecord ()
void	usingRecordWithKey (const EventSetupRecordKey &key)
Protected Member Functions inherited from edm::EventSetupRecordIntervalFinder
template<class T >
void	findingRecord ()
void	findingRecordWithKey (const eventsetup::EventSetupRecordKey &)

Private Types
enum	NodeType {   nUnknown, nSkip, nTop, nArm,   nRPStation, nRPPot, nRPPlane, nDiamondPlane,   nChip, nDiamondCh, nChannel, nSampicBoard,   nSampicChannel, nTotemTimingPlane, nTotemTimingCh }
	enumeration of XML node types More...
enum	ParseType { pMapping, pMask }
	whether to parse a mapping of a mask XML More...

Private Member Functions
TotemFramePosition	ChipFramePosition (xercesc::DOMNode *chipnode)
	extracts VFAT's DAQ channel from XML attributes More...
bool	CommonNode (NodeType type)
string	CompleteFileName (const string &fn)
	adds the path prefix, if needed More...
bool	DiamondNode (NodeType type)
void	GetChannels (xercesc::DOMNode *n, std::set< unsigned char > &channels)
string	GetNodeContent (xercesc::DOMNode *parent)
	returns the content of the node More...
NodeType	GetNodeType (xercesc::DOMNode *)
	determines node type More...
string	GetNodeValue (xercesc::DOMNode *node)
	returns the value of the node More...
void	ParseTreeDiamond (ParseType, xercesc::DOMNode *, NodeType, unsigned int parentID, const std::unique_ptr< TotemDAQMapping > &, const std::unique_ptr< TotemAnalysisMask > &)
	recursive method to extract RP-related information from the DOM tree More...
void	ParseTreeRP (ParseType, xercesc::DOMNode *, NodeType, unsigned int parentID, const std::unique_ptr< TotemDAQMapping > &, const std::unique_ptr< TotemAnalysisMask > &)
	recursive method to extract RP-related information from the DOM tree More...
void	ParseTreeTotemTiming (ParseType, xercesc::DOMNode *, NodeType, unsigned int parentID, const std::unique_ptr< TotemDAQMapping > &, const std::unique_ptr< TotemAnalysisMask > &)
	recursive method to extract RP-related information from the DOM tree More...
void	ParseXML (ParseType, const string &file, const std::unique_ptr< TotemDAQMapping > &, const std::unique_ptr< TotemAnalysisMask > &)
	parses XML file More...
bool	RPNode (NodeType type)
bool	Test (xercesc::DOMNode *node, const std::string &name)
	returns true iff the node is of the given name More...
bool	TotemTimingNode (NodeType type)

Private Attributes
vector< ConfigBlock >	configuration
unsigned int	currentBlock
	index of the current block in 'configuration' array More...
bool	currentBlockValid
	flag whether the 'currentBlock' index is valid More...
std::vector< std::string >	mappingFileNames
	the mapping files More...
unsigned int	sampicSubDetId
string	subSystemName
	label of the CTPPS sub-system More...
unsigned int	verbosity

Additional Inherited Members
Static Public Member Functions inherited from edm::eventsetup::DataProxyProvider
static void	prevalidate (ConfigurationDescriptions &)
Protected Types inherited from edm::ESProxyFactoryProducer
using	EventSetupRecordKey = eventsetup::EventSetupRecordKey
Protected Types inherited from edm::eventsetup::DataProxyProvider
using	KeyedProxiesVector = std::vector< std::pair< DataKey, std::shared_ptr< DataProxy > >>

Detailed Description

Loads TotemDAQMapping and TotemAnalysisMask from two XML files.

Definition at line 52 of file TotemDAQMappingESSourceXML.cc.

Member Enumeration Documentation

NodeType

enum TotemDAQMappingESSourceXML::NodeType

private

enumeration of XML node types

Enumerator
nUnknown
nSkip
nTop
nArm
nRPStation
nRPPot
nRPPlane
nDiamondPlane
nChip
nDiamondCh
nChannel
nSampicBoard
nSampicChannel
nTotemTimingPlane
nTotemTimingCh

Definition at line 117 of file TotemDAQMappingESSourceXML.cc.

                {
    nUnknown,
    nSkip,
    nTop,
    nArm,
    nRPStation,
    nRPPot,
    nRPPlane,
    nDiamondPlane,
    nChip,
    nDiamondCh,
    nChannel,
    nSampicBoard,
    nSampicChannel,
    nTotemTimingPlane,
    nTotemTimingCh
  };

ParseType

enum TotemDAQMappingESSourceXML::ParseType

private

whether to parse a mapping of a mask XML

Enumerator
pMapping
pMask

Definition at line 136 of file TotemDAQMappingESSourceXML.cc.

{ pMapping, pMask };

Constructor & Destructor Documentation

TotemDAQMappingESSourceXML()

TotemDAQMappingESSourceXML::TotemDAQMappingESSourceXML

(

const edm::ParameterSet &

conf

)

Definition at line 248 of file TotemDAQMappingESSourceXML.cc.

References b, configuration, edm::ParameterSet::getParameter(), edm::ESProducer::setWhatProduced(), and subSystemName.

    : verbosity(conf.getUntrackedParameter<unsigned int>("verbosity", 0)),
      subSystemName(conf.getUntrackedParameter<string>("subSystem")),
      sampicSubDetId(conf.getParameter<unsigned int>("sampicSubDetId")),
      currentBlock(0),
      currentBlockValid(false) {
  for (const auto &it : conf.getParameter<vector<ParameterSet>>("configuration")) {
    ConfigBlock b;
    b.validityRange = it.getParameter<EventRange>("validityRange");
    b.mappingFileNames = it.getParameter<vector<string>>("mappingFileNames");
    b.maskFileNames = it.getParameter<vector<string>>("maskFileNames");
    configuration.push_back(b);
  }

  setWhatProduced(this, subSystemName);
  findingRecord<TotemReadoutRcd>();
}

~TotemDAQMappingESSourceXML()

TotemDAQMappingESSourceXML::~TotemDAQMappingESSourceXML ( )

override

Definition at line 311 of file TotemDAQMappingESSourceXML.cc.

{}

Member Function Documentation

ChipFramePosition()

TotemFramePosition TotemDAQMappingESSourceXML::ChipFramePosition ( xercesc::DOMNode *  chipnode )

private

extracts VFAT's DAQ channel from XML attributes

Definition at line 785 of file TotemDAQMappingESSourceXML.cc.

References a, Exception, personalPlayback::fp, dqmiolumiharvest::j, and cms::xerces::toString().

Referenced by ParseTreeDiamond(), ParseTreeRP(), and ParseTreeTotemTiming().

                                                                                         {
  TotemFramePosition fp;
  unsigned char attributeFlag = 0;

  DOMNamedNodeMap *attr = chipnode->getAttributes();
  for (unsigned int j = 0; j < attr->getLength(); j++) {
    DOMNode *a = attr->item(j);
    if (fp.setXMLAttribute(
            cms::xerces::toString(a->getNodeName()), cms::xerces::toString(a->getNodeValue()), attributeFlag) > 1) {
      throw cms::Exception("TotemDAQMappingESSourceXML")
          << "Unrecognized tag `" << cms::xerces::toString(a->getNodeName()) << "' or incompatible value `"
          << cms::xerces::toString(a->getNodeValue()) << "'.";
    }
  }

  if (!fp.checkXMLAttributeFlag(attributeFlag)) {
    throw cms::Exception("TotemDAQMappingESSourceXML")
        << "Wrong/incomplete DAQ channel specification (attributeFlag = " << attributeFlag << ").";
  }

  return fp;
}

CommonNode()

bool TotemDAQMappingESSourceXML::CommonNode ( NodeType  type )

inlineprivate

Definition at line 205 of file TotemDAQMappingESSourceXML.cc.

{ return ((type == nChip) || (type == nArm)); }

CompleteFileName()

string TotemDAQMappingESSourceXML::CompleteFileName ( const string &  fn )

private

adds the path prefix, if needed

Definition at line 315 of file TotemDAQMappingESSourceXML.cc.

References personalPlayback::fn, and edm::FileInPath::fullPath().

Referenced by produce().

                                                                    {
  FileInPath fip(fn);
  return fip.fullPath();
}

DiamondNode()

bool TotemDAQMappingESSourceXML::DiamondNode ( NodeType  type )

inlineprivate

Definition at line 195 of file TotemDAQMappingESSourceXML.cc.

Referenced by ParseTreeDiamond().

                                  {
    return ((type == nArm) || (type == nRPStation) || (type == nRPPot) || (type == nDiamondPlane) ||
            (type == nDiamondCh));
  }

GetChannels()

void TotemDAQMappingESSourceXML::GetChannels ( xercesc::DOMNode *  n, std::set< unsigned char > &  channels  )

private

Definition at line 853 of file TotemDAQMappingESSourceXML.cc.

References a, ewkTauDQM_cfi::channels, class-composition::children, Exception, mps_fire::i, triggerObjects_cff::id, dqmiolumiharvest::j, dqmiodumpmetadata::n, Test(), and cms::xerces::toString().

Referenced by ParseTreeRP().

                                                                                            {
  DOMNodeList *children = n->getChildNodes();
  for (unsigned int i = 0; i < children->getLength(); i++) {
    DOMNode *n = children->item(i);
    if (n->getNodeType() != DOMNode::ELEMENT_NODE || !Test(n, "channel"))
      continue;

    DOMNamedNodeMap *attr = n->getAttributes();
    bool idSet = false;
    for (unsigned int j = 0; j < attr->getLength(); j++) {
      DOMNode *a = attr->item(j);

      if (!strcmp(cms::xerces::toString(a->getNodeName()).c_str(), "id")) {
        unsigned int id = 0;
        sscanf(cms::xerces::toString(a->getNodeValue()).c_str(), "%u", &id);
        channels.insert(id);
        idSet = true;
        break;
      }
    }

    if (!idSet) {
      throw cms::Exception("TotemDAQMappingESSourceXML::GetChannels") << "Channel tags must have an `id' attribute.";
    }
  }
}

GetNodeContent()

string TotemDAQMappingESSourceXML::GetNodeContent ( xercesc::DOMNode *  parent )

inlineprivate

returns the content of the node

Definition at line 181 of file TotemDAQMappingESSourceXML.cc.

References class-composition::parent, AlCaHLTBitMon_QueryRunRegistry::string, and cms::xerces::toString().

{ return string(cms::xerces::toString(parent->getTextContent())); }

GetNodeType()

TotemDAQMappingESSourceXML::NodeType TotemDAQMappingESSourceXML::GetNodeType ( xercesc::DOMNode *  n )

private

determines node type

Definition at line 810 of file TotemDAQMappingESSourceXML.cc.

References Exception, dqmiodumpmetadata::n, nArm, nChip, nDiamondCh, nDiamondPlane, nRPPlane, nRPPot, nRPStation, nSampicBoard, nSampicChannel, nSkip, nTotemTimingCh, nTotemTimingPlane, tagArm, tagChip1, tagChip2, tagDiamondCh, tagDiamondPlane, tagRPPlane, tagRPPot, tagRPStation, tagSampicBoard, tagSampicCh, tagTotemTimingCh, tagTotemTimingPlane, Test(), and cms::xerces::toString().

Referenced by ParseTreeDiamond(), ParseTreeRP(), and ParseTreeTotemTiming().

                                                                                            {
  // common node types
  if (Test(n, tagArm))
    return nArm;
  if (Test(n, tagChip1))
    return nChip;
  if (Test(n, tagChip2))
    return nChip;

  // RP node types
  if (Test(n, tagRPStation))
    return nRPStation;
  if (Test(n, tagRPPot))
    return nRPPot;
  if (Test(n, tagRPPlane))
    return nRPPlane;

  //diamond specifics
  if (Test(n, tagDiamondCh))
    return nDiamondCh;
  if (Test(n, tagDiamondPlane))
    return nDiamondPlane;

  //totem timing specifics
  if (Test(n, tagSampicBoard))
    return nSampicBoard;
  if (Test(n, tagSampicCh))
    return nSampicChannel;
  if (Test(n, tagTotemTimingCh))
    return nTotemTimingCh;
  if (Test(n, tagTotemTimingPlane))
    return nTotemTimingPlane;

  // for backward compatibility
  if (Test(n, "trigger_vfat"))
    return nSkip;

  throw cms::Exception("TotemDAQMappingESSourceXML::GetNodeType")
      << "Unknown tag `" << cms::xerces::toString(n->getNodeName()) << "'.\n";
}

GetNodeValue()

string TotemDAQMappingESSourceXML::GetNodeValue ( xercesc::DOMNode *  node )

inlineprivate

returns the value of the node

Definition at line 184 of file TotemDAQMappingESSourceXML.cc.

References cms::xerces::toString().

{ return cms::xerces::toString(node->getNodeValue()); }

ParseTreeDiamond()

void TotemDAQMappingESSourceXML::ParseTreeDiamond ( ParseType  pType, xercesc::DOMNode *  parent, NodeType  parentType, unsigned int  parentID, const std::unique_ptr< TotemDAQMapping > &  mapping, const std::unique_ptr< TotemAnalysisMask > &  mask  )

private

recursive method to extract RP-related information from the DOM tree

Definition at line 521 of file TotemDAQMappingESSourceXML.cc.

References a, class-composition::children, ChipFramePosition(), DiamondNode(), Exception, GetNodeType(), TotemVFATInfo::hwID, mps_fire::i, triggerObjects_cff::id, dqmiolumiharvest::j, taus_updatedMVAIds_cff::mapping, gpuClustering::pixelStatus::mask, dqmiodumpmetadata::n, nArm, nDiamondCh, nDiamondPlane, nRPPot, nRPStation, nTop, nUnknown, class-composition::parent, pMapping, TotemSymbID::symbolicID, TotemVFATInfo::symbolicID, and cms::xerces::toString().

Referenced by ParseXML().

                                                                                                {
#ifdef DEBUG
  printf(">> TotemDAQMappingESSourceXML::ParseTreeDiamond(%s, %u, %u)\n",
         cms::xerces::toString(parent->getNodeName()),
         parentType,
         parentID);
#endif

  DOMNodeList *children = parent->getChildNodes();

  for (unsigned int i = 0; i < children->getLength(); i++) {
    DOMNode *n = children->item(i);
    if (n->getNodeType() != DOMNode::ELEMENT_NODE)
      continue;

    NodeType type = GetNodeType(n);
#ifdef DEBUG
    printf("\tname = %s, type = %u\n", cms::xerces::toString(n->getNodeName()), type);
#endif

    // structure control
    if (!DiamondNode(type))
      continue;

    NodeType expectedParentType;
    switch (type) {
      case nArm:
        expectedParentType = nTop;
        break;
      case nRPStation:
        expectedParentType = nArm;
        break;
      case nRPPot:
        expectedParentType = nRPStation;
        break;
      case nDiamondPlane:
        expectedParentType = nRPPot;
        break;
      case nDiamondCh:
        expectedParentType = nDiamondPlane;
        break;
      default:
        expectedParentType = nUnknown;
        break;
    }

    if (expectedParentType != parentType) {
      throw cms::Exception("TotemDAQMappingESSourceXML")
          << "Node " << cms::xerces::toString(n->getNodeName()) << " not allowed within "
          << cms::xerces::toString(parent->getNodeName()) << " block.\n";
    }

    // parse tag attributes
    unsigned int id = 0, hw_id = 0;
    bool id_set = false, hw_id_set = false;
    DOMNamedNodeMap *attr = n->getAttributes();

    for (unsigned int j = 0; j < attr->getLength(); j++) {
      DOMNode *a = attr->item(j);

      if (!strcmp(cms::xerces::toString(a->getNodeName()).c_str(), "id")) {
        sscanf(cms::xerces::toString(a->getNodeValue()).c_str(), "%u", &id);
        id_set = true;
      }

      if (!strcmp(cms::xerces::toString(a->getNodeName()).c_str(), "hw_id")) {
        sscanf(cms::xerces::toString(a->getNodeValue()).c_str(), "%x", &hw_id);
        hw_id_set = true;
      }
    }

    // content control
    if (!id_set)
      throw cms::Exception("TotemDAQMappingESSourceXML::ParseTreeDiamond")
          << "id not given for element `" << cms::xerces::toString(n->getNodeName()) << "'";

    if (!hw_id_set && type == nDiamondCh && pType == pMapping)
      throw cms::Exception("TotemDAQMappingESSourceXML::ParseTreeDiamond")
          << "hw_id not given for element `" << cms::xerces::toString(n->getNodeName()) << "'";

    if (type == nDiamondPlane && id > 3)
      throw cms::Exception("TotemDAQMappingESSourceXML::ParseTreeDiamond")
          << "Plane IDs range from 0 to 3. id = " << id << " is invalid.";

#ifdef DEBUG
    printf("\tID found: 0x%x\n", id);
#endif

    // store mapping data
    if (pType == pMapping && type == nDiamondCh) {
      const TotemFramePosition &framepos = ChipFramePosition(n);

      TotemVFATInfo vfatInfo;
      vfatInfo.hwID = hw_id;

      if (type == nDiamondCh) {
        unsigned int ArmNum = (parentID / 10000) % 10;
        unsigned int StationNum = (parentID / 1000) % 10;
        unsigned int RpNum = (parentID / 100) % 10;
        unsigned int PlaneNum = (parentID % 100);

        vfatInfo.symbolicID.symbolicID = CTPPSDiamondDetId(ArmNum, StationNum, RpNum, PlaneNum, id);
      }

      mapping->insert(framepos, vfatInfo);

      continue;
    }

    unsigned int childId;
    if (pType == pMapping && type == nDiamondPlane)
      childId = parentID * 100 + id;
    else
      childId = parentID * 10 + id;

    ParseTreeDiamond(pType, n, type, childId, mapping, mask);
  }
}

ParseTreeRP()

void TotemDAQMappingESSourceXML::ParseTreeRP ( ParseType  pType, xercesc::DOMNode *  parent, NodeType  parentType, unsigned int  parentID, const std::unique_ptr< TotemDAQMapping > &  mapping, const std::unique_ptr< TotemAnalysisMask > &  mask  )

private

recursive method to extract RP-related information from the DOM tree

Definition at line 376 of file TotemDAQMappingESSourceXML.cc.

References a, class-composition::children, ChipFramePosition(), Exception, TotemVFATAnalysisMask::fullMask, GetChannels(), GetNodeType(), TotemVFATInfo::hwID, mps_fire::i, triggerObjects_cff::id, dqmiolumiharvest::j, taus_updatedMVAIds_cff::mapping, gpuClustering::pixelStatus::mask, TotemVFATAnalysisMask::maskedChannels, dqmiodumpmetadata::n, nArm, nChannel, nChip, nRPPlane, nRPPot, nRPStation, nTop, nUnknown, class-composition::parent, pMapping, pMask, RPNode(), TotemSymbID::symbolicID, TotemVFATInfo::symbolicID, and cms::xerces::toString().

Referenced by ParseXML().

                                                                                           {
#ifdef DEBUG
  printf(">> TotemDAQMappingESSourceXML::ParseTreeRP(%s, %u, %u)\n",
         cms::xerces::toString(parent->getNodeName()),
         parentType,
         parentID);
#endif

  DOMNodeList *children = parent->getChildNodes();

  for (unsigned int i = 0; i < children->getLength(); i++) {
    DOMNode *n = children->item(i);
    if (n->getNodeType() != DOMNode::ELEMENT_NODE)
      continue;

    NodeType type = GetNodeType(n);

#ifdef DEBUG
    printf("\tname = %s, type = %u\n", cms::xerces::toString(n->getNodeName()), type);
#endif

    // structure control
    if (!RPNode(type))
      continue;

    NodeType expectedParentType;
    switch (type) {
      case nArm:
        expectedParentType = nTop;
        break;
      case nRPStation:
        expectedParentType = nArm;
        break;
      case nRPPot:
        expectedParentType = nRPStation;
        break;
      case nRPPlane:
        expectedParentType = nRPPot;
        break;
      case nChip:
        expectedParentType = nRPPlane;
        break;
      case nChannel:
        expectedParentType = nChip;
        break;
      default:
        expectedParentType = nUnknown;
        break;
    }

    if (expectedParentType != parentType) {
      throw cms::Exception("TotemDAQMappingESSourceXML")
          << "Node " << cms::xerces::toString(n->getNodeName()) << " not allowed within "
          << cms::xerces::toString(parent->getNodeName()) << " block.\n";
    }

    // parse tag attributes
    unsigned int id = 0, hw_id = 0;
    bool id_set = false, hw_id_set = false;
    bool fullMask = false;
    DOMNamedNodeMap *attr = n->getAttributes();

    for (unsigned int j = 0; j < attr->getLength(); j++) {
      DOMNode *a = attr->item(j);

      if (!strcmp(cms::xerces::toString(a->getNodeName()).c_str(), "id")) {
        sscanf(cms::xerces::toString(a->getNodeValue()).c_str(), "%u", &id);
        id_set = true;
      }

      if (!strcmp(cms::xerces::toString(a->getNodeName()).c_str(), "hw_id")) {
        sscanf(cms::xerces::toString(a->getNodeValue()).c_str(), "%x", &hw_id);
        hw_id_set = true;
      }

      if (!strcmp(cms::xerces::toString(a->getNodeName()).c_str(), "full_mask"))
        fullMask = (strcmp(cms::xerces::toString(a->getNodeValue()).c_str(), "no") != 0);
    }

    // content control
    if (!id_set)
      throw cms::Exception("TotemDAQMappingESSourceXML::ParseTreeRP")
          << "id not given for element `" << cms::xerces::toString(n->getNodeName()) << "'";

    if (!hw_id_set && type == nChip && pType == pMapping)
      throw cms::Exception("TotemDAQMappingESSourceXML::ParseTreeRP")
          << "hw_id not given for element `" << cms::xerces::toString(n->getNodeName()) << "'";

    if (type == nRPPlane && id > 9)
      throw cms::Exception("TotemDAQMappingESSourceXML::ParseTreeRP")
          << "Plane IDs range from 0 to 9. id = " << id << " is invalid.";

#ifdef DEBUG
    printf("\tID found: 0x%x\n", id);
#endif

    // store mapping data
    if (pType == pMapping && type == nChip) {
      const TotemFramePosition &framepos = ChipFramePosition(n);
      TotemVFATInfo vfatInfo;
      vfatInfo.hwID = hw_id;

      const unsigned int armIdx = (parentID / 1000) % 10;
      const unsigned int stIdx = (parentID / 100) % 10;
      const unsigned int rpIdx = (parentID / 10) % 10;
      const unsigned int plIdx = parentID % 10;

      vfatInfo.symbolicID.symbolicID = TotemRPDetId(armIdx, stIdx, rpIdx, plIdx, id);

      mapping->insert(framepos, vfatInfo);

      continue;
    }

    // store mask data
    if (pType == pMask && type == nChip) {
      const unsigned int armIdx = (parentID / 1000) % 10;
      const unsigned int stIdx = (parentID / 100) % 10;
      const unsigned int rpIdx = (parentID / 10) % 10;
      const unsigned int plIdx = parentID % 10;

      TotemSymbID symbId;
      symbId.symbolicID = TotemRPDetId(armIdx, stIdx, rpIdx, plIdx, id);

      TotemVFATAnalysisMask am;
      am.fullMask = fullMask;
      GetChannels(n, am.maskedChannels);

      mask->insert(symbId, am);

      continue;
    }

    // recursion (deeper in the tree)
    ParseTreeRP(pType, n, type, parentID * 10 + id, mapping, mask);
  }
}

ParseTreeTotemTiming()

void TotemDAQMappingESSourceXML::ParseTreeTotemTiming ( ParseType  pType, xercesc::DOMNode *  parent, NodeType  parentType, unsigned int  parentID, const std::unique_ptr< TotemDAQMapping > &  mapping, const std::unique_ptr< TotemAnalysisMask > &  mask  )

private

recursive method to extract RP-related information from the DOM tree

Definition at line 647 of file TotemDAQMappingESSourceXML.cc.

References a, class-composition::children, ChipFramePosition(), Exception, GetNodeType(), mps_fire::i, triggerObjects_cff::id, TotemTimingDetId::ID_NOT_SET, dqmiolumiharvest::j, taus_updatedMVAIds_cff::mapping, gpuClustering::pixelStatus::mask, dqmiodumpmetadata::n, nArm, nRPPot, nRPStation, nSampicBoard, nSampicChannel, nTop, nTotemTimingCh, nTotemTimingPlane, nUnknown, class-composition::parent, pMapping, sampicSubDetId, TotemSymbID::symbolicID, TotemVFATInfo::symbolicID, cms::xerces::toString(), and TotemTimingNode().

Referenced by ParseXML().

                                                                                                    {
  DOMNodeList *children = parent->getChildNodes();

  // Fill map hwId -> TotemTimingPlaneChannelPair
  for (unsigned int i = 0; i < children->getLength(); i++) {
    DOMNode *child = children->item(i);
    if ((child->getNodeType() != DOMNode::ELEMENT_NODE) || (GetNodeType(child) != nTotemTimingCh))
      continue;

    int plane = -1;
    DOMNamedNodeMap *attr = parent->getAttributes();
    for (unsigned int j = 0; j < attr->getLength(); j++) {
      DOMNode *a = attr->item(j);

      if (!strcmp(cms::xerces::toString(a->getNodeName()).c_str(), "id"))
        sscanf(cms::xerces::toString(a->getNodeValue()).c_str(), "%d", &plane);
    }

    int channel = -1;
    unsigned int hwId = 0;
    attr = child->getAttributes();
    for (unsigned int j = 0; j < attr->getLength(); j++) {
      DOMNode *a = attr->item(j);

      if (!strcmp(cms::xerces::toString(a->getNodeName()).c_str(), "id"))
        sscanf(cms::xerces::toString(a->getNodeValue()).c_str(), "%d", &channel);
      if (!strcmp(cms::xerces::toString(a->getNodeName()).c_str(), "hwId"))
        sscanf(cms::xerces::toString(a->getNodeValue()).c_str(), "%x", &hwId);
    }

    mapping->totemTimingChannelMap[(uint8_t)hwId] = TotemDAQMapping::TotemTimingPlaneChannelPair(plane, channel);
  }

  for (unsigned int i = 0; i < children->getLength(); i++) {
    DOMNode *n = children->item(i);
    if (n->getNodeType() != DOMNode::ELEMENT_NODE)
      continue;

    NodeType type = GetNodeType(n);

    // structure control
    if (!TotemTimingNode(type))
      continue;

    NodeType expectedParentType;
    switch (type) {
      case nArm:
        expectedParentType = nTop;
        break;
      case nRPStation:
        expectedParentType = nArm;
        break;
      case nRPPot:
        expectedParentType = nRPStation;
        break;
      case nSampicBoard:
        expectedParentType = nRPPot;
        break;
      case nSampicChannel:
        expectedParentType = nSampicBoard;
        break;
      case nTotemTimingPlane:
        expectedParentType = nRPPot;
        break;
      case nTotemTimingCh:
        expectedParentType = nTotemTimingPlane;
        break;
      default:
        expectedParentType = nUnknown;
        break;
    }

    if (expectedParentType != parentType) {
      throw cms::Exception("TotemDAQMappingESSourceXML")
          << "Node " << cms::xerces::toString(n->getNodeName()) << " not allowed within "
          << cms::xerces::toString(parent->getNodeName()) << " block.\n";
    }

    // parse tag attributes
    unsigned int id = 0;
    bool id_set = false;
    DOMNamedNodeMap *attr = n->getAttributes();

    for (unsigned int j = 0; j < attr->getLength(); j++) {
      DOMNode *a = attr->item(j);

      if (!strcmp(cms::xerces::toString(a->getNodeName()).c_str(), "id")) {
        sscanf(cms::xerces::toString(a->getNodeValue()).c_str(), "%u", &id);
        id_set = true;
      }
    }

    // content control
    if (!id_set)
      throw cms::Exception("TotemDAQMappingESSourceXML::ParseTreeTotemTiming")
          << "id not given for element `" << cms::xerces::toString(n->getNodeName()) << "'";
    if (type == nSampicBoard && id > 5)
      throw cms::Exception("TotemDAQMappingESSourceXML::ParseTreeTotemTiming")
          << "SampicBoard IDs range from 0 to 5. id = " << id << " is invalid.";

    // store mapping data
    if (pType == pMapping && type == nSampicChannel) {
      const TotemFramePosition &framepos = ChipFramePosition(n);

      TotemVFATInfo vfatInfo;
      unsigned int ArmNum = (parentID / 10000) % 10;
      unsigned int StationNum = (parentID / 1000) % 10;
      unsigned int RpNum = (parentID / 100) % 10;

      vfatInfo.symbolicID.symbolicID = TotemTimingDetId(ArmNum,
                                                        StationNum,
                                                        RpNum,
                                                        0,
                                                        TotemTimingDetId::ID_NOT_SET,
                                                        sampicSubDetId);  //Dynamical: it is encoded in the frame

      mapping->insert(framepos, vfatInfo);

      continue;
    }

    unsigned int childId;
    if (pType == pMapping && type == nSampicBoard)
      childId = parentID * 100 + id;
    else
      childId = parentID * 10 + id;

    ParseTreeTotemTiming(pType, n, type, childId, mapping, mask);
  }
}

ParseXML()

void TotemDAQMappingESSourceXML::ParseXML ( ParseType  pType, const string &  file, const std::unique_ptr< TotemDAQMapping > &  mapping, const std::unique_ptr< TotemAnalysisMask > &  mask  )

private

parses XML file

Definition at line 349 of file TotemDAQMappingESSourceXML.cc.

References Exception, geometryDiff::file, taus_updatedMVAIds_cff::mapping, gpuClustering::pixelStatus::mask, nTop, writedatasetfile::parser, ParseTreeDiamond(), ParseTreeRP(), and ParseTreeTotemTiming().

Referenced by produce().

                                                                                        {
  unique_ptr<XercesDOMParser> parser(new XercesDOMParser());
  parser->parse(file.c_str());

  DOMDocument *domDoc = parser->getDocument();

  if (!domDoc)
    throw cms::Exception("TotemDAQMappingESSourceXML::ParseXML")
        << "Cannot parse file `" << file << "' (domDoc = NULL).";

  DOMElement *elementRoot = domDoc->getDocumentElement();

  if (!elementRoot)
    throw cms::Exception("TotemDAQMappingESSourceXML::ParseXML") << "File `" << file << "' is empty.";

  ParseTreeRP(pType, elementRoot, nTop, 0, mapping, mask);

  ParseTreeDiamond(pType, elementRoot, nTop, 0, mapping, mask);

  ParseTreeTotemTiming(pType, elementRoot, nTop, 0, mapping, mask);
}

produce()

edm::ESProducts< std::unique_ptr< TotemDAQMapping >, std::unique_ptr< TotemAnalysisMask > > TotemDAQMappingESSourceXML::produce

(

const TotemReadoutRcd &

)

Definition at line 323 of file TotemDAQMappingESSourceXML.cc.

References cms::cuda::assert(), CompleteFileName(), configuration, currentBlock, currentBlockValid, personalPlayback::fn, taus_updatedMVAIds_cff::mapping, mappingFileNames, gpuClustering::pixelStatus::mask, ctppsRawToDigi_cff::maskFileNames, eostools::move(), ParseXML(), pMapping, pMask, edm::es::products(), cms::concurrency::xercesInitialize(), and cms::concurrency::xercesTerminate().

                                                           {
  assert(currentBlockValid);

  auto mapping = std::make_unique<TotemDAQMapping>();
  auto mask = std::make_unique<TotemAnalysisMask>();

  // initialize Xerces
  cms::concurrency::xercesInitialize();

  // load mapping files
  for (const auto &fn : configuration[currentBlock].mappingFileNames)
    ParseXML(pMapping, CompleteFileName(fn), mapping, mask);

  // load mask files
  for (const auto &fn : configuration[currentBlock].maskFileNames)
    ParseXML(pMask, CompleteFileName(fn), mapping, mask);

  // release Xerces
  cms::concurrency::xercesTerminate();

  // commit the products
  return edm::es::products(std::move(mapping), std::move(mask));
}

RPNode()

bool TotemDAQMappingESSourceXML::RPNode ( NodeType  type )

inlineprivate

Definition at line 191 of file TotemDAQMappingESSourceXML.cc.

Referenced by ParseTreeRP().

                             {
    return ((type == nArm) || (type == nRPStation) || (type == nRPPot) || (type == nRPPlane) || (type == nChip));
  }

setIntervalFor()

void TotemDAQMappingESSourceXML::setIntervalFor ( const edm::eventsetup::EventSetupRecordKey &  key, const edm::IOVSyncValue &  iosv, edm::ValidityInterval &  oValidity  )

overrideprotectedvirtual

sets infinite validity of this data

Implements edm::EventSetupRecordIntervalFinder.

Definition at line 268 of file TotemDAQMappingESSourceXML.cc.

References configuration, edm::contains(), currentBlock, currentBlockValid, mps_fire::end, edm::EventID::event(), edm::IOVSyncValue::eventID(), Exception, heavyIonCSV_trainingSettings::idx, crabWrapper::key, FastTimerService_cff::range, and edm::EventID::run().

                                                                                {
  LogVerbatim("TotemDAQMappingESSourceXML") << ">> TotemDAQMappingESSourceXML::setIntervalFor(" << key.name() << ")";

  LogVerbatim("TotemDAQMappingESSourceXML")
      << "    run=" << iosv.eventID().run() << ", event=" << iosv.eventID().event();

  currentBlockValid = false;
  for (unsigned int idx = 0; idx < configuration.size(); ++idx) {
    const auto &bl = configuration[idx];

    edm::EventRange range = bl.validityRange;

    // If "<run>:min" is specified in python config, it is translated into event <run>:0:1.
    // However, the truly minimal event id often found in data is <run>:0:0. Therefore the
    // adjustment below is needed.
    if (range.startEventID().luminosityBlock() == 0 && range.startEventID().event() == 1)
      range = edm::EventRange(edm::EventID(range.startEventID().run(), 0, 0), range.endEventID());

    if (edm::contains(range, iosv.eventID())) {
      currentBlockValid = true;
      currentBlock = idx;

      const IOVSyncValue begin(range.startEventID());
      const IOVSyncValue end(range.endEventID());
      oValidity = edm::ValidityInterval(begin, end);

      LogVerbatim("TotemDAQMappingESSourceXML") << "    block found: index=" << currentBlock << ", interval=("
                                                << range.startEventID() << " - " << range.endEventID() << ")";

      return;
    }
  }

  if (!currentBlockValid) {
    throw cms::Exception("TotemDAQMappingESSourceXML::setIntervalFor")
        << "No configuration for event " << iosv.eventID();
  }
}

Test()

bool TotemDAQMappingESSourceXML::Test ( xercesc::DOMNode *  node, const std::string &  name  )

inlineprivate

returns true iff the node is of the given name

Definition at line 173 of file TotemDAQMappingESSourceXML.cc.

References Skims_PA_cff::name, and cms::xerces::toString().

Referenced by GetChannels(), and GetNodeType().

                                                         {
    return !(name.compare(cms::xerces::toString(node->getNodeName())));
  }

TotemTimingNode()

bool TotemDAQMappingESSourceXML::TotemTimingNode ( NodeType  type )

inlineprivate

Definition at line 200 of file TotemDAQMappingESSourceXML.cc.

Referenced by ParseTreeTotemTiming().

                                      {
    return ((type == nArm) || (type == nRPStation) || (type == nRPPot) || (type == nSampicBoard) ||
            (type == nSampicChannel) || (type == nTotemTimingPlane) || (type == nTotemTimingCh));
  }

Member Data Documentation

configuration

vector<ConfigBlock> TotemDAQMappingESSourceXML::configuration

private

Definition at line 108 of file TotemDAQMappingESSourceXML.cc.

Referenced by produce(), setIntervalFor(), showPage.BuildViewer::showResults(), and TotemDAQMappingESSourceXML().

currentBlock

unsigned int TotemDAQMappingESSourceXML::currentBlock

private

index of the current block in 'configuration' array

Definition at line 111 of file TotemDAQMappingESSourceXML.cc.

Referenced by produce(), and setIntervalFor().

currentBlockValid

bool TotemDAQMappingESSourceXML::currentBlockValid

private

flag whether the 'currentBlock' index is valid

Definition at line 114 of file TotemDAQMappingESSourceXML.cc.

Referenced by produce(), and setIntervalFor().

mappingFileNames

std::vector<std::string> TotemDAQMappingESSourceXML::mappingFileNames

private

the mapping files

Definition at line 95 of file TotemDAQMappingESSourceXML.cc.

Referenced by produce().

sampicSubDetId

unsigned int TotemDAQMappingESSourceXML::sampicSubDetId

private

Definition at line 92 of file TotemDAQMappingESSourceXML.cc.

Referenced by ParseTreeTotemTiming().

subSystemName

string TotemDAQMappingESSourceXML::subSystemName

private

label of the CTPPS sub-system

Definition at line 89 of file TotemDAQMappingESSourceXML.cc.

Referenced by TotemDAQMappingESSourceXML().

tagAnalysisMask

const string TotemDAQMappingESSourceXML::tagAnalysisMask = "analysisMask"

static

Definition at line 56 of file TotemDAQMappingESSourceXML.cc.

tagArm

const string TotemDAQMappingESSourceXML::tagArm = "arm"

static

Common position tags.

Definition at line 59 of file TotemDAQMappingESSourceXML.cc.

Referenced by GetNodeType().

tagChannel

const string TotemDAQMappingESSourceXML::tagChannel = "channel"

static

Definition at line 55 of file TotemDAQMappingESSourceXML.cc.

tagChip1

const string TotemDAQMappingESSourceXML::tagChip1 = "vfat"

static

COMMON Chip XML tags.

Definition at line 67 of file TotemDAQMappingESSourceXML.cc.

Referenced by GetNodeType().

tagChip2

const string TotemDAQMappingESSourceXML::tagChip2 = "test_vfat"

static

Definition at line 68 of file TotemDAQMappingESSourceXML.cc.

Referenced by GetNodeType().

tagDiamondCh

const string TotemDAQMappingESSourceXML::tagDiamondCh = "diamond_channel"

static

Definition at line 72 of file TotemDAQMappingESSourceXML.cc.

Referenced by GetNodeType().

tagDiamondPlane

const string TotemDAQMappingESSourceXML::tagDiamondPlane = "rp_plane_diamond"

static

diamond specific tags

Definition at line 71 of file TotemDAQMappingESSourceXML.cc.

Referenced by GetNodeType().

tagRPPlane

const string TotemDAQMappingESSourceXML::tagRPPlane = "rp_plane"

static

Definition at line 64 of file TotemDAQMappingESSourceXML.cc.

Referenced by GetNodeType().

tagRPPot

const string TotemDAQMappingESSourceXML::tagRPPot = "rp_detector_set"

static

Definition at line 63 of file TotemDAQMappingESSourceXML.cc.

Referenced by GetNodeType().

tagRPStation

const string TotemDAQMappingESSourceXML::tagRPStation = "station"

static

RP XML tags.

Definition at line 62 of file TotemDAQMappingESSourceXML.cc.

Referenced by GetNodeType().

tagSampicBoard

const string TotemDAQMappingESSourceXML::tagSampicBoard = "rp_sampic_board"

static

totem timing specific tags

Definition at line 75 of file TotemDAQMappingESSourceXML.cc.

Referenced by GetNodeType().

tagSampicCh

const string TotemDAQMappingESSourceXML::tagSampicCh = "rp_sampic_channel"

static

Definition at line 76 of file TotemDAQMappingESSourceXML.cc.

Referenced by GetNodeType().

tagTotemTimingCh

const string TotemDAQMappingESSourceXML::tagTotemTimingCh = "timing_channel"

static

Definition at line 77 of file TotemDAQMappingESSourceXML.cc.

Referenced by GetNodeType().

tagTotemTimingPlane

const string TotemDAQMappingESSourceXML::tagTotemTimingPlane = "timing_plane"

static

Definition at line 78 of file TotemDAQMappingESSourceXML.cc.

Referenced by GetNodeType().

tagVFAT

const string TotemDAQMappingESSourceXML::tagVFAT = "vfat"

static

Definition at line 54 of file TotemDAQMappingESSourceXML.cc.

verbosity

unsigned int TotemDAQMappingESSourceXML::verbosity

private

Definition at line 86 of file TotemDAQMappingESSourceXML.cc.