L1GtPsbSetupConfigOnlineProd Class Reference

#include <L1GtPsbSetupConfigOnlineProd.h>

Inheritance diagram for L1GtPsbSetupConfigOnlineProd:

Public Member Functions
	L1GtPsbSetupConfigOnlineProd (const edm::ParameterSet &)
	constructor More...
virtual boost::shared_ptr < L1GtPsbSetup >	newObject (const std::string &objectKey)
	public methods More...
	~L1GtPsbSetupConfigOnlineProd ()
	destructor More...
Public Member Functions inherited from L1ConfigOnlineProdBase< L1GtPsbSetupRcd, L1GtPsbSetup >
	L1ConfigOnlineProdBase (const edm::ParameterSet &)
boost::shared_ptr< L1GtPsbSetup >	produce (const L1GtPsbSetupRcd &iRecord)
	~L1ConfigOnlineProdBase ()
Public Member Functions inherited from edm::ESProducer
	ESProducer ()
virtual	~ESProducer ()
Public Member Functions inherited from edm::ESProxyFactoryProducer
	ESProxyFactoryProducer ()
virtual void	newInterval (const eventsetup::EventSetupRecordKey &iRecordType, const ValidityInterval &iInterval)
	overrides DataProxyProvider method More...
virtual	~ESProxyFactoryProducer ()
Public Member Functions inherited from edm::eventsetup::DataProxyProvider
	DataProxyProvider ()
const ComponentDescription &	description () const
bool	isUsingRecord (const EventSetupRecordKey &) const
const KeyedProxies &	keyedProxies (const EventSetupRecordKey &iRecordKey) const
void	resetProxies (const EventSetupRecordKey &iRecordType)
void	resetProxiesIfTransient (const EventSetupRecordKey &iRecordType)
void	setAppendToDataLabel (const edm::ParameterSet &)
void	setDescription (const ComponentDescription &iDescription)
std::set< EventSetupRecordKey >	usingRecords () const
virtual	~DataProxyProvider ()

Private Member Functions
void	addDefaultPsb (const std::string &psbColumn, std::vector< L1GtPsbConfig > &psbSetup) const
	Creates a default valued PSB from an empty foreign key in the GT_SETUP table. More...
void	addPsbFromDb (const std::string &psbKey, std::vector< L1GtPsbConfig > &psbSetup) const
	Creates a new PSB object from a GT_PSB_SETUP entry and adds. More...
bool	checkOneLineResult (const l1t::OMDSReader::QueryResults &result, const std::string &queryDescription) const
	Ensures that result contains exactly one line, returning false otherwise. More...
std::vector< bool >	extractBoolVector (const l1t::OMDSReader::QueryResults &query, const std::string &prefix, const std::string &suffix, unsigned nColumns) const
template<class T >
void	getRequiredValue (const l1t::OMDSReader::QueryResults &result, const std::string &colName, T &value) const
std::string	numberedColumnName (const std::string &prefix, unsigned number, const std::string &suffix) const
	Concatenates prefix, number and suffix into a string. More...
std::string	numberedColumnName (const std::string &prefix, unsigned number) const
	Special case for empty suffix. More...
unsigned	numberFromString (const std::string &aString) const

Static Private Member Functions
static bool	notPsbColumnName (const std::string &columnName)

Additional Inherited Members
Public Types inherited from edm::eventsetup::DataProxyProvider
typedef std::vector< std::pair < DataKey, boost::shared_ptr < DataProxy > > >	KeyedProxies
typedef std::vector < EventSetupRecordKey >	Keys
typedef std::map < EventSetupRecordKey, KeyedProxies >	RecordProxies
Static Public Member Functions inherited from edm::eventsetup::DataProxyProvider
static void	prevalidate (ConfigurationDescriptions &)
Protected Member Functions inherited from L1ConfigOnlineProdBase< L1GtPsbSetupRcd, L1GtPsbSetup >
bool	getObjectKey (const L1GtPsbSetupRcd &record, boost::shared_ptr< L1GtPsbSetup > data, std::string &objectKey)
Protected Member Functions inherited from edm::ESProducer
template<typename T >
void	setWhatProduced (T *iThis, const es::Label &iLabel=es::Label())
template<typename T >
void	setWhatProduced (T *iThis, const char *iLabel)
template<typename T >
void	setWhatProduced (T *iThis, const std::string &iLabel)
template<typename T , typename TDecorator >
void	setWhatProduced (T *iThis, const TDecorator &iDec, const es::Label &iLabel=es::Label())
template<typename T , typename TReturn , typename TRecord >
void	setWhatProduced (T *iThis, TReturn(T::*iMethod)(const TRecord &), const es::Label &iLabel=es::Label())
template<typename T , typename TReturn , typename TRecord , typename TArg >
void	setWhatProduced (T *iThis, TReturn(T::*iMethod)(const TRecord &), const TArg &iDec, const es::Label &iLabel=es::Label())
Protected Member Functions inherited from edm::ESProxyFactoryProducer
template<class TFactory >
void	registerFactory (std::auto_ptr< TFactory > iFactory, const std::string &iLabel=std::string())
virtual void	registerFactoryWithKey (const eventsetup::EventSetupRecordKey &iRecord, std::auto_ptr< eventsetup::ProxyFactoryBase > &iFactory, const std::string &iLabel=std::string())
virtual void	registerProxies (const eventsetup::EventSetupRecordKey &iRecord, KeyedProxies &aProxyList)
	override DataProxyProvider method More...
Protected Member Functions inherited from edm::eventsetup::DataProxyProvider
void	eraseAll (const EventSetupRecordKey &iRecordKey)
	deletes all the Proxies in aStream More...
void	invalidateProxies (const EventSetupRecordKey &iRecordKey)
template<class T >
void	usingRecord ()
void	usingRecordWithKey (const EventSetupRecordKey &)
Protected Attributes inherited from L1ConfigOnlineProdBase< L1GtPsbSetupRcd, L1GtPsbSetup >
bool	m_copyFromCondDB
cond::DbConnection	m_dbConnection
cond::DbSession	m_dbSession
bool	m_forceGeneration
l1t::OMDSReader	m_omdsReader

Detailed Description

Description: online producer for L1GtPsbSetup.

Implementation: <TODO: enter implementation details>

Author

: Vasile Mihai Ghete - HEPHY Vienna

$Date$ $Revision$

Description: online producer for L1GtPsbSetup.

Implementation: <TODO: enter implementation details>

Author

: Vasile Mihai Ghete - HEPHY Vienna

: Thomas Themel - HEPHY Vienna

$Date$ $Revision$

Definition at line 37 of file L1GtPsbSetupConfigOnlineProd.h.

Constructor & Destructor Documentation

L1GtPsbSetupConfigOnlineProd::L1GtPsbSetupConfigOnlineProd

(

const edm::ParameterSet &

parSet

)

constructor

Definition at line 29 of file L1GtPsbSetupConfigOnlineProd.cc.

                                                                                        :
    L1ConfigOnlineProdBase<L1GtPsbSetupRcd, L1GtPsbSetup> (parSet) {

    // empty

}

L1GtPsbSetupConfigOnlineProd::~L1GtPsbSetupConfigOnlineProd

(

)

destructor

Definition at line 37 of file L1GtPsbSetupConfigOnlineProd.cc.

                                                            {

    // empty

}

Member Function Documentation

void L1GtPsbSetupConfigOnlineProd::addDefaultPsb ( const std::string &  psbColumn, std::vector< L1GtPsbConfig > &  psbSetup  ) const

private

Creates a default valued PSB from an empty foreign key in the GT_SETUP table.

Definition at line 218 of file L1GtPsbSetupConfigOnlineProd.cc.

References numberFromString(), L1GtPsbConfig::PsbNumberLvdsGroups, L1GtPsbConfig::PsbSerLinkNumberChannels, L1GtPsbConfig::setGtBoardSlot(), L1GtPsbConfig::setGtPsbCh0SendLvds(), L1GtPsbConfig::setGtPsbCh1SendLvds(), L1GtPsbConfig::setGtPsbEnableRecLvds(), L1GtPsbConfig::setGtPsbEnableRecSerLink(), and makeLayoutFileForGui::toAdd.

Referenced by newObject().

                                        {

    // deduce the assigned board from the column name
    unsigned boardSlot = numberFromString(psbColumn);

    // create a default PsbConfig with the appropriate board slot and all links disabled
    L1GtPsbConfig toAdd;
    static std::vector<bool> allFalseLvds(L1GtPsbConfig::PsbNumberLvdsGroups, false);
    static std::vector<bool> allFalseSerLink(L1GtPsbConfig::PsbSerLinkNumberChannels, false);

    toAdd.setGtBoardSlot(boardSlot);
    toAdd.setGtPsbCh0SendLvds(false);
    toAdd.setGtPsbCh1SendLvds(false);
    toAdd.setGtPsbEnableRecLvds(allFalseLvds);
    toAdd.setGtPsbEnableRecSerLink(allFalseSerLink);

    psbSetup.push_back(toAdd);
}

void L1GtPsbSetupConfigOnlineProd::addPsbFromDb ( const std::string &  psbKey, std::vector< L1GtPsbConfig > &  psbSetup  ) const

private

Creates a new PSB object from a GT_PSB_SETUP entry and adds.

Definition at line 117 of file L1GtPsbSetupConfigOnlineProd.cc.

References l1t::OMDSReader::basicQuery(), checkOneLineResult(), extractBoolVector(), getRequiredValue(), i, L1ConfigOnlineProdBase< L1GtPsbSetupRcd, L1GtPsbSetup >::m_omdsReader, numberedColumnName(), L1GtPsbConfig::PsbNumberLvdsGroups, L1GtPsbConfig::PsbSerLinkNumberChannels, L1GtPsbConfig::setGtBoardSlot(), L1GtPsbConfig::setGtPsbCh0SendLvds(), L1GtPsbConfig::setGtPsbCh1SendLvds(), L1GtPsbConfig::setGtPsbEnableRecLvds(), L1GtPsbConfig::setGtPsbEnableRecSerLink(), l1t::OMDSReader::singleAttribute(), and makeLayoutFileForGui::toAdd.

Referenced by newObject().

                                        {

    // SQL> describe gt_psb_setup;
    // (heavily pruned to just the stuff we need to set up a GtPsbConfig)
    //  Name                                      Null?    Type
    //  ----------------------------------------- -------- ----------------------------
    //  ID                                        NOT NULL VARCHAR2(256)
    //  BOARD_SLOT                                         NUMBER(3)
    //  CH0_SEND_LVDS_NOT_DS92LV16                         NUMBER(1)
    //  CH1_SEND_LVDS_NOT_DS92LV16                         NUMBER(1)
    //  ENABLE_TT_LVDS_0                                   NUMBER(1)
    //  ENABLE_TT_LVDS_1                                   NUMBER(1)
    //  ENABLE_TT_LVDS_2                                   NUMBER(1)
    //  ENABLE_TT_LVDS_3                                   NUMBER(1)
    //  ENABLE_TT_LVDS_4                                   NUMBER(1)
    //  ENABLE_TT_LVDS_5                                   NUMBER(1)
    //  ENABLE_TT_LVDS_6                                   NUMBER(1)
    //  ENABLE_TT_LVDS_7                                   NUMBER(1)
    //  ENABLE_TT_LVDS_8                                   NUMBER(1)
    //  ENABLE_TT_LVDS_9                                   NUMBER(1)
    //  ENABLE_TT_LVDS_10                                  NUMBER(1)
    //  ENABLE_TT_LVDS_11                                  NUMBER(1)
    //  ENABLE_TT_LVDS_12                                  NUMBER(1)
    //  ENABLE_TT_LVDS_13                                  NUMBER(1)
    //  ENABLE_TT_LVDS_14                                  NUMBER(1)
    //  ENABLE_TT_LVDS_15                                  NUMBER(1)
    //  SERLINK_CH0_REC_ENABLE                             NUMBER(1)
    //  SERLINK_CH1_REC_ENABLE                             NUMBER(1)
    //  SERLINK_CH2_REC_ENABLE                             NUMBER(1)
    //  SERLINK_CH3_REC_ENABLE                             NUMBER(1)
    //  SERLINK_CH4_REC_ENABLE                             NUMBER(1)
    //  SERLINK_CH5_REC_ENABLE                             NUMBER(1)
    //  SERLINK_CH6_REC_ENABLE                             NUMBER(1)
    //  SERLINK_CH7_REC_ENABLE                             NUMBER(1)

    const std::string gtSchema = "CMS_GT";

    // setup up columns to query
    std::vector<std::string> columnNames;

    static const std::string lvdPrefix = "ENABLE_TT_LVDS_";
    static const std::string lvdSuffix = "";
    static const std::string serPrefix = "SERLINK_CH";
    static const std::string serSuffix = "_REC_ENABLE";
    static const std::string boardSlotColumn = "BOARD_SLOT";
    static const std::string ch0FormatColumn = "CH0_SEND_LVDS_NOT_DS92LV16";
    static const std::string ch1FormatColumn = "CH1_SEND_LVDS_NOT_DS92LV16";

    columnNames.push_back(boardSlotColumn);
    columnNames.push_back(ch0FormatColumn);
    columnNames.push_back(ch1FormatColumn);

    for (unsigned i = 0; i < (unsigned) L1GtPsbConfig::PsbNumberLvdsGroups; ++i) {
        columnNames.push_back(numberedColumnName(lvdPrefix, i, lvdSuffix));
    }

    for (unsigned i = 0; i < (unsigned) L1GtPsbConfig::PsbSerLinkNumberChannels; ++i) {
        columnNames.push_back(numberedColumnName(serPrefix, i, serSuffix));
    }

    // execute database query
    l1t::OMDSReader::QueryResults psbQuery = m_omdsReader.basicQuery(
            columnNames, gtSchema, "GT_PSB_SETUP", "GT_PSB_SETUP.ID", m_omdsReader.singleAttribute(
                    psbKey));

    // check if query was successful and we get only one line
    if (!checkOneLineResult(psbQuery, "GT_PSB_SETUP query for PSB keys with ID = " + psbKey)) {
        edm::LogError("L1-O2O")
            << "Problem to get setup for PSB keys with ID = " << psbKey;
        return; // FIXME: change method to bool?
    }

    // extract values
    int16_t boardSlot;

    getRequiredValue(psbQuery, boardSlotColumn, boardSlot);

    bool sendLvds0, sendLvds1;

    getRequiredValue(psbQuery, ch0FormatColumn, sendLvds0);
    getRequiredValue(psbQuery, ch1FormatColumn, sendLvds1);

    const std::vector<bool>& enableRecLvds = extractBoolVector(
            psbQuery, lvdPrefix, lvdSuffix, L1GtPsbConfig::PsbNumberLvdsGroups);
    const std::vector<bool>& serLinkRecEnable = extractBoolVector(
            psbQuery, serPrefix, serSuffix, L1GtPsbConfig::PsbSerLinkNumberChannels);

    // create new PSB object with db values
    L1GtPsbConfig toAdd;

    toAdd.setGtBoardSlot(boardSlot);
    toAdd.setGtPsbCh0SendLvds(sendLvds0);
    toAdd.setGtPsbCh1SendLvds(sendLvds1);
    toAdd.setGtPsbEnableRecLvds(enableRecLvds);
    toAdd.setGtPsbEnableRecSerLink(serLinkRecEnable);

    // add to vector
    psbSetup.push_back(toAdd);
}

bool L1GtPsbSetupConfigOnlineProd::checkOneLineResult ( const l1t::OMDSReader::QueryResults &  result, const std::string &  queryDescription  ) const

private

Ensures that result contains exactly one line, returning false otherwise.

Definition at line 253 of file L1GtPsbSetupConfigOnlineProd.cc.

References l1t::OMDSReader::QueryResults::numberRows(), and l1t::OMDSReader::QueryResults::queryFailed().

Referenced by addPsbFromDb(), and newObject().

                                                                                          {

    // check if query was successful
    if (result.queryFailed()) {
        edm::LogError("L1-O2O") << "\n " << queryDescription + " failed: no match found!";
        return false;

    } else if (result.numberRows() != 1) {
        edm::LogError("L1-O2O") << "\nProblem with " << queryDescription << ": "
                << ( result.numberRows() ) << " rows were returned, expected 1.";
        return false;
    }

    return true;
}

std::vector< bool > L1GtPsbSetupConfigOnlineProd::extractBoolVector ( const l1t::OMDSReader::QueryResults &  query, const std::string &  prefix, const std::string &  suffix, unsigned  nColumns  ) const

private

A function to extract a vector of booleans from the GT database format (NUMBER(1) columns labeled prefix<nn>suffix).

Definition at line 238 of file L1GtPsbSetupConfigOnlineProd.cc.

References getRequiredValue(), i, numberedColumnName(), and query::result.

Referenced by addPsbFromDb().

                                                          {

    std::vector<bool> result(nColumns);

    for (unsigned i = 0; i < nColumns; ++i) {
        bool dbValue;
        getRequiredValue(query, numberedColumnName(prefix, i, suffix), dbValue);
        result[i] = dbValue;
    }

    return result;
}

template<class T >

void L1GtPsbSetupConfigOnlineProd::getRequiredValue ( const l1t::OMDSReader::QueryResults &  result, const std::string &  colName, T &  value  ) const

inlineprivate

A wrapper for OMDSReader::QueryResults::fillVariable that throws an exception when the field it accesses was NULL.

Definition at line 70 of file L1GtPsbSetupConfigOnlineProd.h.

References edm::hlt::Exception, and l1t::OMDSReader::QueryResults::fillVariable().

Referenced by addPsbFromDb(), and extractBoolVector().

                                                                                               {
        if (!result.fillVariable(colName, value)) {
            throw cms::Exception("NullValue") << "Required field " << colName
                    << " is NULL in database!";
        }
    }

boost::shared_ptr< L1GtPsbSetup > L1GtPsbSetupConfigOnlineProd::newObject ( const std::string &  objectKey )

virtual

public methods

Implements L1ConfigOnlineProdBase< L1GtPsbSetupRcd, L1GtPsbSetup >.

Definition at line 45 of file L1GtPsbSetupConfigOnlineProd.cc.

References addDefaultPsb(), addPsbFromDb(), l1t::OMDSReader::basicQuery(), checkOneLineResult(), l1t::OMDSReader::columnNames(), l1t::OMDSReader::QueryResults::fillVariable(), edm::isDebugEnabled(), LogTrace, L1ConfigOnlineProdBase< L1GtPsbSetupRcd, L1GtPsbSetup >::m_omdsReader, notPsbColumnName(), and l1t::OMDSReader::singleAttribute().

                                    {

    // shared pointer for L1GtPsbSetup
    boost::shared_ptr<L1GtPsbSetup> pL1GtPsbSetup = boost::shared_ptr<L1GtPsbSetup>(
            new L1GtPsbSetup());

    const std::string gtSchema = "CMS_GT";

    // the setup's contents, to be filled from database
    std::vector<L1GtPsbConfig> psbConfigurations;

    // SELECT PSB_SLOT_*_SETUP_FK FROM CMS_GT.GT_SETUP WHERE GT_SETUP.ID = MyKey
    std::vector<std::string> psbColumns = m_omdsReader.columnNames(gtSchema, "GT_SETUP");

    std::vector<std::string>::iterator newEnd = std::remove_if(
            psbColumns.begin(), psbColumns.end(), &notPsbColumnName);
    psbColumns.erase(newEnd, psbColumns.end());

    // select * from CMS_GT.GT_SETUP where GT_SETUP.ID = objectKey
    l1t::OMDSReader::QueryResults psbKeys = m_omdsReader.basicQuery(
            psbColumns, gtSchema, "GT_SETUP", "GT_SETUP.ID",
            m_omdsReader.singleAttribute(objectKey));

    // check if query was successful and produced one line only
    if (!checkOneLineResult(psbKeys, "GT_SETUP query for PSB keys with ID = " + objectKey)) {
        edm::LogError("L1-O2O")
            << "Problem to get content of CMS_GT.GT_SETUP for GT_SETUP.ID key: "
            << objectKey;
        return pL1GtPsbSetup;
    }

    // fill the psbConfigurations vector
    for (std::vector<std::string>::const_iterator it = psbColumns.begin(); it != psbColumns.end(); ++it) {

        std::string psbKey;
        psbKeys.fillVariable(*it, psbKey);

        if (psbKey.empty()) {
            addDefaultPsb(*it, psbConfigurations);
        } else {
            addPsbFromDb(psbKey, psbConfigurations);
        }
    }

    // assign to the result object
    pL1GtPsbSetup->setGtPsbSetup(psbConfigurations);

    if (edm::isDebugEnabled()) {
        LogTrace("L1-O2O") << (*pL1GtPsbSetup) << std::endl;
    }

    return pL1GtPsbSetup;
}

bool L1GtPsbSetupConfigOnlineProd::notPsbColumnName ( const std::string &  columnName )

staticprivate

A predicate to filter the column names of GT_SETUP for those that contain foreign keys to GT_PSB_SETUP.

Definition at line 102 of file L1GtPsbSetupConfigOnlineProd.cc.

Referenced by newObject().

                                                                               {

    static std::string startMatch("PSB_SLOT_");
    static std::string endMatch("_SETUP_FK");

    unsigned len = columnName.size();

    // it's not a PSB column name if it's too short
    return len <= ( startMatch.size() + endMatch.size() ) ||
    // or the start doesn't match
            columnName.substr(0, startMatch.size()) != startMatch ||
    // or the end doesn't match
            columnName.substr(len - endMatch.size(), endMatch.size()) != endMatch;
}

std::string L1GtPsbSetupConfigOnlineProd::numberedColumnName ( const std::string &  prefix, unsigned  number, const std::string &  suffix  ) const

private

Concatenates prefix, number and suffix into a string.

Definition at line 278 of file L1GtPsbSetupConfigOnlineProd.cc.

References createPayload::suffix.

Referenced by addPsbFromDb(), extractBoolVector(), and numberedColumnName().

                                                                                 {

    std::ostringstream colName;
    colName << prefix << number << suffix;

    return colName.str();
}

std::string L1GtPsbSetupConfigOnlineProd::numberedColumnName ( const std::string &  prefix, unsigned  number  ) const

private

Special case for empty suffix.

Definition at line 271 of file L1GtPsbSetupConfigOnlineProd.cc.

References numberedColumnName().

                                                        {

    return numberedColumnName(prefix, number, "");

}

unsigned L1GtPsbSetupConfigOnlineProd::numberFromString ( const std::string &  aString ) const

private

Definition at line 287 of file L1GtPsbSetupConfigOnlineProd.cc.

References edm::hlt::Exception, i, and query::result.

Referenced by addDefaultPsb().

                                                                                      {

    std::istringstream stream(aString);
    unsigned result;

    for (unsigned i = 0; i < aString.size(); ++i) {
        if (stream >> result) {
            // we got a value
            return result;
        } else {
            // clear error flags from failed >>
            stream.clear();
            // skip another character
            stream.seekg(i);
        }
    }

    // throw here
    throw cms::Exception("NumberNotFound") << "Failed to extract numeric value from " << aString;
}