L1ConfigOnlineProdBase< TRcd, TData > Class Template Reference

#include <CondTools/L1Trigger/interface/L1ConfigOnlineProdBase.h>

Inheritance diagram for L1ConfigOnlineProdBase< TRcd, TData >:

Public Member Functions
	L1ConfigOnlineProdBase (const edm::ParameterSet &)
virtual std::unique_ptr< TData >	newObject (const std::string &objectKey)=0
virtual std::unique_ptr< TData >	produce (const TRcd &iRecord)
	~L1ConfigOnlineProdBase () override
Public Member Functions inherited from edm::ESProducer
	ESProducer ()
	ESProducer (const ESProducer &)=delete
ESProxyIndex const *	getTokenIndices (unsigned int iIndex) const
ESProducer const &	operator= (const ESProducer &)=delete
template<typename Record >
void	updateFromMayConsumes (unsigned int iIndex, const Record &iRecord)
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)

Protected Member Functions
bool	getObjectKey (const TRcd &record, std::string &objectKey)
Protected Member Functions inherited from edm::ESProducer
template<typename T >
auto	setWhatProduced (T *iThis, const char *iLabel)
template<typename T >
auto	setWhatProduced (T *iThis, const es::Label &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={})
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 Attributes
bool	m_copyFromCondDB
cond::persistency::Session	m_dbSession
bool	m_forceGeneration
l1t::OMDSReader	m_omdsReader

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

template<class TRcd, class TData>
class L1ConfigOnlineProdBase< TRcd, TData >

Description: Abstract templated base class for producers that reads OMDS to retrieve configuration data for a given key and generates the corresponding C++ objects.

Usage: <usage>

Definition at line 52 of file L1ConfigOnlineProdBase.h.

Constructor & Destructor Documentation

L1ConfigOnlineProdBase()

template<class TRcd , class TData >

L1ConfigOnlineProdBase< TRcd, TData >::L1ConfigOnlineProdBase

(

const edm::ParameterSet &

iConfig

)

Definition at line 80 of file L1ConfigOnlineProdBase.h.

    : m_omdsReader(),
      m_forceGeneration(iConfig.getParameter<bool>("forceGeneration")),
      m_dbSession(),
      m_copyFromCondDB(false) {
  //the following line is needed to tell the framework what
  // data is being produced
  setWhatProduced(this);
 
  //now do what ever other initialization is needed
 
  if (iConfig.exists("copyFromCondDB")) {
    m_copyFromCondDB = iConfig.getParameter<bool>("copyFromCondDB");
 
    if (m_copyFromCondDB) {
      cond::persistency::ConnectionPool connectionPool;
      // Connect DB Session
      connectionPool.setAuthenticationPath(iConfig.getParameter<std::string>("onlineAuthentication"));
      connectionPool.configure();
      m_dbSession = connectionPool.createSession(iConfig.getParameter<std::string>("onlineDB"));
    }
  } else {
    m_omdsReader.connect(iConfig.getParameter<std::string>("onlineDB"),
                         iConfig.getParameter<std::string>("onlineAuthentication"));
  }
}

~L1ConfigOnlineProdBase()

template<class TRcd , class TData >

L1ConfigOnlineProdBase< TRcd, TData >::~L1ConfigOnlineProdBase ( )

override

Definition at line 108 of file L1ConfigOnlineProdBase.h.

                                                             {
  // do anything here that needs to be done at desctruction time
  // (e.g. close files, deallocate resources etc.)
}

Member Function Documentation

getObjectKey()

template<class TRcd, class TData >

bool L1ConfigOnlineProdBase< TRcd, TData >::getObjectKey ( const TRcd &  record, std::string &  objectKey  )

protected

Definition at line 162 of file L1ConfigOnlineProdBase.h.

                                                                                               {
  // Get L1TriggerKey
  const L1TriggerKeyRcd& keyRcd = record.template getRecord<L1TriggerKeyRcd>();
 
  // Explanation of funny syntax: since record is dependent, we are not
  // expecting getRecord to be a template so the compiler parses it
  // as a non-template. http://gcc.gnu.org/ml/gcc-bugs/2005-11/msg03685.html
 
  // If L1TriggerKey is invalid, then all configuration objects are
  // already in ORCON.
  edm::ESHandle<L1TriggerKey> key;
  try {
    keyRcd.get(key);
  } catch (l1t::DataAlreadyPresentException& ex) {
    objectKey = std::string();
    return false;
  }
 
  // Get object key from L1TriggerKey
  std::string recordName = edm::typelookup::className<TRcd>();
  std::string dataType = edm::typelookup::className<TData>();
 
  objectKey = key->get(recordName, dataType);
 
  /*    edm::LogVerbatim( "L1-O2O" ) */
  /*      << "L1ConfigOnlineProdBase record " << recordName */
  /*      << " type " << dataType << " obj key " << objectKey ; */
 
  // Get L1TriggerKeyList
  L1TriggerKeyList keyList;
  l1t::DataWriter dataWriter;
  if (!dataWriter.fillLastTriggerKeyList(keyList)) {
    edm::LogError("L1-O2O") << "Problem getting last L1TriggerKeyList";
  }
 
  // If L1TriggerKeyList does not contain object key, token is empty
  return keyList.token(recordName, dataType, objectKey).empty();
}

newObject()

template<class TRcd, class TData>

virtual std::unique_ptr<TData> L1ConfigOnlineProdBase< TRcd, TData >::newObject ( const std::string &  objectKey )

pure virtual

Implemented in L1GtTriggerMenuConfigOnlineProd, L1CaloHcalScaleConfigOnlineProd, L1GtPsbSetupConfigOnlineProd, L1GtPrescaleFactorsAlgoTrigConfigOnlineProd, L1GtPrescaleFactorsTechTrigConfigOnlineProd, L1GtTriggerMaskAlgoTrigConfigOnlineProd, L1GtTriggerMaskTechTrigConfigOnlineProd, L1GtTriggerMaskVetoTechTrigConfigOnlineProd, L1CaloEcalScaleConfigOnlineProd, L1RCTChannelMaskOnlineProd, L1GtParametersConfigOnlineProd, DTEtaPatternLutOnlineProd, DTExtLutOnlineProd, DTPhiLutOnlineProd, DTPtaLutOnlineProd, DTQualPatternLutOnlineProd, L1MuTriggerScalesOnlineProducer, L1RCTParametersOnlineProd, L1RPCConeDefinitionOnlineProd, RPCConfigOnlineProd, DTTFMasksOnlineProd, DTTFParametersOnlineProd, L1MuTriggerPtScaleOnlineProducer, L1EmEtScaleOnlineProd, L1HfRingEtScaleOnlineProd, L1HtMissScaleOnlineProd, L1JetEtScaleOnlineProd, L1MuGMTParametersOnlineProducer, L1RPCBxOrConfigOnlineProd, L1RPCHsbConfigOnlineProd, CSCTFConfigOnlineProd, L1MuCSCPtLutConfigOnlineProd, L1GctChannelMaskOnlineProd, L1GctJetFinderParamsOnlineProd, L1MuGMTChannelMaskOnlineProducer, and CSCTFAlignmentOnlineProd.

produce()

template<class TRcd, class TData >

std::unique_ptr< TData > L1ConfigOnlineProdBase< TRcd, TData >::produce ( const TRcd &  iRecord )

virtual

Reimplemented in L1CaloHcalScaleConfigOnlineProd.

Definition at line 114 of file L1ConfigOnlineProdBase.h.

                                                                                     {
  std::unique_ptr<TData> pData;
 
  // Get object key and check if already in ORCON
  std::string key;
  if (getObjectKey(iRecord, key) || m_forceGeneration) {
    if (m_copyFromCondDB) {
      // Get L1TriggerKeyList from EventSetup
      const L1TriggerKeyListRcd& keyListRcd = iRecord.template getRecord<L1TriggerKeyListRcd>();
      edm::ESHandle<L1TriggerKeyList> keyList;
      keyListRcd.get(keyList);
 
      // Find payload token
      std::string recordName = edm::typelookup::className<TRcd>();
      std::string dataType = edm::typelookup::className<TData>();
      std::string payloadToken = keyList->token(recordName, dataType, key);
 
      edm::LogVerbatim("L1-O2O") << "Copying payload for " << recordName << "@" << dataType << " obj key " << key
                                 << " from CondDB.";
      edm::LogVerbatim("L1-O2O") << "TOKEN " << payloadToken;
 
      // Get object from POOL
      // Copied from l1t::DataWriter::readObject()
      if (!payloadToken.empty()) {
        m_dbSession.transaction().start();
        pData = m_dbSession.fetchPayload<TData>(payloadToken);
        m_dbSession.transaction().commit();
      }
    } else {
      pData = newObject(key);
    }
 
    //     if( pData.get() == 0 )
    if (pData == std::unique_ptr<TData>()) {
      std::string dataType = edm::typelookup::className<TData>();
 
      throw l1t::DataInvalidException("Unable to generate " + dataType + " for key " + key + ".");
    }
  } else {
    std::string dataType = edm::typelookup::className<TData>();
 
    throw l1t::DataAlreadyPresentException(dataType + " for key " + key + " already in CondDB.");
  }
 
  return pData;
}

Member Data Documentation

m_copyFromCondDB

template<class TRcd, class TData>

bool L1ConfigOnlineProdBase< TRcd, TData >::m_copyFromCondDB

protected

Definition at line 76 of file L1ConfigOnlineProdBase.h.

Referenced by L1ConfigOnlineProdBase< L1HtMissScaleRcd, L1CaloEtScale >::L1ConfigOnlineProdBase().

m_dbSession

template<class TRcd, class TData>

cond::persistency::Session L1ConfigOnlineProdBase< TRcd, TData >::m_dbSession

protected

Definition at line 75 of file L1ConfigOnlineProdBase.h.

Referenced by L1ConfigOnlineProdBase< L1HtMissScaleRcd, L1CaloEtScale >::L1ConfigOnlineProdBase().

m_forceGeneration

template<class TRcd, class TData>

bool L1ConfigOnlineProdBase< TRcd, TData >::m_forceGeneration

protected

Definition at line 66 of file L1ConfigOnlineProdBase.h.

m_omdsReader

template<class TRcd, class TData>

l1t::OMDSReader L1ConfigOnlineProdBase< TRcd, TData >::m_omdsReader

protected

Definition at line 65 of file L1ConfigOnlineProdBase.h.

Referenced by L1ConfigOnlineProdBase< L1HtMissScaleRcd, L1CaloEtScale >::L1ConfigOnlineProdBase().