l1t::L1TGlobalUtilHelper Class Reference

#include <L1TGlobalUtilHelper.h>

Public Member Functions
edm::InputTag const &	l1tAlgBlkInputTag () const
edm::EDGetTokenT< GlobalAlgBlkBxCollection > const &	l1tAlgBlkToken () const
edm::InputTag const &	l1tExtBlkInputTag () const
edm::EDGetTokenT< GlobalExtBlkBxCollection > const &	l1tExtBlkToken () const
	L1TGlobalUtilHelper (edm::ParameterSet const &pset, edm::ConsumesCollector &iC)
template<typename T >
	L1TGlobalUtilHelper (edm::ParameterSet const &pset, edm::ConsumesCollector &iC, T &module)
template<typename T >
	L1TGlobalUtilHelper (edm::ParameterSet const &pset, edm::ConsumesCollector &iC, T &module, edm::InputTag const &l1tAlgBlkInputTag, edm::InputTag const &l1tExtBlkInputTag)
bool const &	readPrescalesFromFile () const

Static Public Member Functions
static void	fillDescription (edm::ParameterSetDescription &desc, edm::InputTag const &iAlg, edm::InputTag const &iExt, bool readPrescalesFromFile)

Private Member Functions
void	checkToUpdateTags (edm::BranchDescription const &branchDescription, edm::ConsumesCollector, bool findL1TAlgBlk, bool findL1TExtBlk)

Private Attributes
edm::InputTag	m_l1tAlgBlkInputTag
edm::EDGetTokenT< GlobalAlgBlkBxCollection >	m_l1tAlgBlkToken
edm::InputTag	m_l1tExtBlkInputTag
edm::EDGetTokenT< GlobalExtBlkBxCollection >	m_l1tExtBlkToken
bool	m_readPrescalesFromFile

Detailed Description

Definition at line 38 of file L1TGlobalUtilHelper.h.

Constructor & Destructor Documentation

L1TGlobalUtilHelper() [1/3]

L1TGlobalUtilHelper::L1TGlobalUtilHelper	(	edm::ParameterSet const &	pset,
		edm::ConsumesCollector &	iC
	)

Definition at line 9 of file L1TGlobalUtilHelper.cc.

References edm::ConsumesCollector::consumes(), m_l1tAlgBlkInputTag, m_l1tAlgBlkToken, m_l1tExtBlkInputTag, and m_l1tExtBlkToken.

    : m_l1tAlgBlkInputTag(pset.getParameter<edm::InputTag>("l1tAlgBlkInputTag")),
      m_l1tExtBlkInputTag(pset.getParameter<edm::InputTag>("l1tExtBlkInputTag")),
      m_readPrescalesFromFile(pset.getParameter<bool>("ReadPrescalesFromFile")) {
  m_l1tAlgBlkToken = iC.consumes<GlobalAlgBlkBxCollection>(m_l1tAlgBlkInputTag);
  m_l1tExtBlkToken = iC.consumes<GlobalExtBlkBxCollection>(m_l1tExtBlkInputTag);
}

L1TGlobalUtilHelper() [2/3]

template<typename T >

L1TGlobalUtilHelper::L1TGlobalUtilHelper	(	edm::ParameterSet const &	pset,
		edm::ConsumesCollector &	iC,
		T &	module
	)

Definition at line 97 of file L1TGlobalUtilHelper.h.

      : L1TGlobalUtilHelper(pset, iC, module, edm::InputTag(), edm::InputTag()) {}

L1TGlobalUtilHelper() [3/3]

template<typename T >

L1TGlobalUtilHelper::L1TGlobalUtilHelper	(	edm::ParameterSet const &	pset,
		edm::ConsumesCollector &	iC,
		T &	module,
		edm::InputTag const &	l1tAlgBlkInputTag,
		edm::InputTag const &	l1tExtBlkInputTag
	)

Definition at line 101 of file L1TGlobalUtilHelper.h.

References cms::Exception::addContext(), checkToUpdateTags(), edm::ConsumesCollector::consumes(), label, edm::InputTag::label(), m_l1tAlgBlkInputTag, m_l1tAlgBlkToken, m_l1tExtBlkInputTag, m_l1tExtBlkToken, m_readPrescalesFromFile, callgraph::module, muonDTDigis_cfi::pset, and AlCaHLTBitMon_QueryRunRegistry::string.

      :  // Set InputTags from arguments
        m_l1tAlgBlkInputTag(l1tAlgBlkInputTag),
        m_l1tExtBlkInputTag(l1tExtBlkInputTag),
        m_readPrescalesFromFile(false) {
    if (pset.existsAs<bool>("ReadPrescalesFromFile")) {
      m_readPrescalesFromFile = pset.getParameter<bool>("ReadPrescalesFromFile");
    }
    // If the InputTags are not set to valid values by the arguments, then
    // try to set them from the configuration.
    if (m_l1tAlgBlkInputTag.label().empty() && pset.existsAs<edm::InputTag>("l1tAlgBlkInputTag")) {
      m_l1tAlgBlkInputTag = pset.getParameter<edm::InputTag>("l1tAlgBlkInputTag");
    }
    if (m_l1tExtBlkInputTag.label().empty() && pset.existsAs<edm::InputTag>("l1tExtBlkInputTag")) {
      m_l1tExtBlkInputTag = pset.getParameter<edm::InputTag>("l1tExtBlkInputTag");
    }

    // If the InputTags were set to valid values, make the consumes calls.
    if (!m_l1tAlgBlkInputTag.label().empty()) {
      m_l1tAlgBlkToken = iC.consumes<GlobalAlgBlkBxCollection>(m_l1tAlgBlkInputTag);
    }

    if (!m_l1tExtBlkInputTag.label().empty()) {
      m_l1tExtBlkToken = iC.consumes<GlobalExtBlkBxCollection>(m_l1tExtBlkInputTag);
    }

    // Do we still need to search for each InputTag?
    bool findL1TAlgBlk = m_l1tAlgBlkInputTag.label().empty();
    bool findL1TExtBlk = m_l1tExtBlkInputTag.label().empty();

    // Register the callback function with the Framework
    // if any InputTags still need to be found.
    if (findL1TAlgBlk || findL1TExtBlk) {
      auto const* pModule = &module;
      module.callWhenNewProductsRegistered([this, findL1TAlgBlk, findL1TExtBlk, iC, pModule](auto iBranch) {
        try {
          checkToUpdateTags(iBranch, iC, findL1TAlgBlk, findL1TExtBlk);
        } catch (cms::Exception& iExcept) {
          auto const& label = pModule->moduleDescription().moduleLabel();
          iExcept.addContext(std::string("Running 'callWhenNewProductRegistered' for module ") + label);
          throw;
        }
      });
    }
  }

Member Function Documentation

checkToUpdateTags()

void L1TGlobalUtilHelper::checkToUpdateTags ( edm::BranchDescription const &  branchDescription, edm::ConsumesCollector  consumesCollector, bool  findL1TAlgBlk, bool  findL1TExtBlk  )

private

Definition at line 85 of file L1TGlobalUtilHelper.cc.

References edm::BranchDescription::branchType(), edm::BranchDescription::dropped(), edm::InEvent, ProducerED_cfi::InputTag, and edm::BranchDescription::unwrappedTypeID().

Referenced by L1TGlobalUtilHelper().

                                                                     {
  // This is only used if required InputTags were not specified already.
  // This is called early in the process, once for each product in the ProductRegistry.
  // The callback is registered when callWhenNewProductsRegistered is called.
  // It finds products by type and sets the token so that it can be used
  // later when getting the product.

  // The code will look for the corresponding product in ProductRegistry.
  // If the product is found, it checks the product label in
  // a vector of preferred input tags (hardwired now to "gtDigis" and
  // "hltGtDigis"). The first input tag from the vector of preferred input tags, with the
  // same label as the input tag found from provenance, is kept as input tag, if there are no
  // multiple products with the same label.

  // If multiple products are found and no one has a label in the vector of preferred input tags,
  // or if multiple products are found with the label in the vector of preferred input tags
  // (with different instance or process) the input tag is set to empty input tag, and L1GtUtil
  // will produce an error, as it is not possible to safely choose a product. In this case, one must
  // provide explicitly the correct input tag via configuration or in the constructor.

  // TODO decide if the preferred input tags must be given as input parameters
  // or stay hardwired

  if (branchDescription.dropped()) {
    return;
  }

  std::vector<edm::InputTag> preferredL1TAlgBlkInputTag = {edm::InputTag("gtStage2Digis"),
                                                           edm::InputTag("hltGtStage2Digis")};

  std::vector<edm::InputTag> preferredL1TExtBlkInputTag = {edm::InputTag("gtStage2Digis"),
                                                           edm::InputTag("hltGtStage2Digis")};

  // GlobalAlgBlkBxCollection

  if (findL1TAlgBlk && (branchDescription.unwrappedTypeID() == edm::TypeID(typeid(GlobalAlgBlkBxCollection))) &&
      (branchDescription.branchType() == edm::InEvent)) {
    setConsumesAndCheckAmbiguities(branchDescription,
                                   preferredL1TAlgBlkInputTag,
                                   m_l1tAlgBlkToken,
                                   m_l1tAlgBlkInputTag,
                                   consumesCollector,
                                   "GlobalAlgBlkBxCollection");
  }

  // GlobalExtBlkBxCollection

  if (findL1TExtBlk && (branchDescription.unwrappedTypeID() == edm::TypeID(typeid(GlobalExtBlkBxCollection))) &&
      (branchDescription.branchType() == edm::InEvent)) {
    setConsumesAndCheckAmbiguities(branchDescription,
                                   preferredL1TExtBlkInputTag,
                                   m_l1tExtBlkToken,
                                   m_l1tExtBlkInputTag,
                                   consumesCollector,
                                   "GlobalExtBlkBxCollection");
  }
}

fillDescription()

void L1TGlobalUtilHelper::fillDescription ( edm::ParameterSetDescription &  desc, edm::InputTag const &  iAlg, edm::InputTag const &  iExt, bool  readPrescalesFromFile  )

static

Definition at line 17 of file L1TGlobalUtilHelper.cc.

References submitPVResolutionJobs::desc.

Referenced by l1t::L1TGlobalUtil::fillDescription().

                                                                           {
  desc.add<edm::InputTag>("l1tAlgBlkInputTag", iAlg);
  desc.add<edm::InputTag>("l1tExtBlkInputTag", iExt);
  desc.add<bool>("ReadPrescalesFromFile", readPrescalesFromFile);
}

l1tAlgBlkInputTag()

edm::InputTag const& l1t::L1TGlobalUtilHelper::l1tAlgBlkInputTag ( ) const

inline

Definition at line 70 of file L1TGlobalUtilHelper.h.

References m_l1tAlgBlkInputTag.

{ return m_l1tAlgBlkInputTag; }

l1tAlgBlkToken()

edm::EDGetTokenT<GlobalAlgBlkBxCollection> const& l1t::L1TGlobalUtilHelper::l1tAlgBlkToken ( ) const

inline

Definition at line 75 of file L1TGlobalUtilHelper.h.

References m_l1tAlgBlkToken.

{ return m_l1tAlgBlkToken; }

l1tExtBlkInputTag()

edm::InputTag const& l1t::L1TGlobalUtilHelper::l1tExtBlkInputTag ( ) const

inline

Definition at line 71 of file L1TGlobalUtilHelper.h.

References m_l1tExtBlkInputTag.

{ return m_l1tExtBlkInputTag; }

l1tExtBlkToken()

edm::EDGetTokenT<GlobalExtBlkBxCollection> const& l1t::L1TGlobalUtilHelper::l1tExtBlkToken ( ) const

inline

Definition at line 76 of file L1TGlobalUtilHelper.h.

References m_l1tExtBlkToken.

{ return m_l1tExtBlkToken; }

readPrescalesFromFile()

bool const& l1t::L1TGlobalUtilHelper::readPrescalesFromFile ( ) const

inline

Definition at line 73 of file L1TGlobalUtilHelper.h.

References m_readPrescalesFromFile.

{ return m_readPrescalesFromFile; }

Member Data Documentation

m_l1tAlgBlkInputTag

edm::InputTag l1t::L1TGlobalUtilHelper::m_l1tAlgBlkInputTag

private

Definition at line 87 of file L1TGlobalUtilHelper.h.

Referenced by l1tAlgBlkInputTag(), and L1TGlobalUtilHelper().

m_l1tAlgBlkToken

edm::EDGetTokenT<GlobalAlgBlkBxCollection> l1t::L1TGlobalUtilHelper::m_l1tAlgBlkToken

private

Definition at line 90 of file L1TGlobalUtilHelper.h.

Referenced by l1tAlgBlkToken(), and L1TGlobalUtilHelper().

m_l1tExtBlkInputTag

edm::InputTag l1t::L1TGlobalUtilHelper::m_l1tExtBlkInputTag

private

Definition at line 88 of file L1TGlobalUtilHelper.h.

Referenced by l1tExtBlkInputTag(), and L1TGlobalUtilHelper().

m_l1tExtBlkToken

edm::EDGetTokenT<GlobalExtBlkBxCollection> l1t::L1TGlobalUtilHelper::m_l1tExtBlkToken

private

Definition at line 91 of file L1TGlobalUtilHelper.h.

Referenced by l1tExtBlkToken(), and L1TGlobalUtilHelper().

m_readPrescalesFromFile

bool l1t::L1TGlobalUtilHelper::m_readPrescalesFromFile

private

Definition at line 93 of file L1TGlobalUtilHelper.h.

Referenced by L1TGlobalUtilHelper(), and readPrescalesFromFile().