L1GlobalTriggerEvmReadoutRecord.cc

Go to the documentation of this file.

// this class header
#include "DataFormats/L1GlobalTrigger/interface/L1GlobalTriggerEvmReadoutRecord.h"

// system include files
#include <iomanip>
#include <bitset>
#include <cstdint>

// user include files


#include "FWCore/Utilities/interface/EDMException.h"
#include "FWCore/MessageLogger/interface/MessageLogger.h"

// constructors
L1GlobalTriggerEvmReadoutRecord::L1GlobalTriggerEvmReadoutRecord()
{

    m_gtfeWord = L1GtfeExtWord();
    m_tcsWord  = L1TcsWord();

    // reserve just one L1GtFdlWord
    m_gtFdlWord.reserve(1);

}

L1GlobalTriggerEvmReadoutRecord::L1GlobalTriggerEvmReadoutRecord(int NumberBxInEvent)
{

    m_gtfeWord = L1GtfeExtWord();
    m_tcsWord  = L1TcsWord();

    m_gtFdlWord.reserve(NumberBxInEvent);
    m_gtFdlWord.assign(NumberBxInEvent, L1GtFdlWord());

    // min value of bxInEvent
    int minBxInEvent = (NumberBxInEvent + 1)/2 - NumberBxInEvent;
    //int maxBxInEvent = (NumberBxInEvent + 1)/2 - 1; // not needed

    // matrix index [0, NumberBxInEvent) -> bxInEvent [minBxInEvent, maxBxInEvent]
    // warning: matrix index != bxInEvent
    for (int iFdl = 0; iFdl < NumberBxInEvent; ++iFdl) {
        int iBxInEvent = minBxInEvent + iFdl;
        m_gtFdlWord[iFdl].setBxInEvent(iBxInEvent);
    }

}

L1GlobalTriggerEvmReadoutRecord::L1GlobalTriggerEvmReadoutRecord(
    const int numberBxInEvent,
    const int numberFdlBoards)
{

    // GTFE board
    m_gtfeWord = L1GtfeExtWord();

    // TCS board
    m_tcsWord  = L1TcsWord();

    // FDL board
    if (numberFdlBoards > 0) {
        m_gtFdlWord.reserve(numberBxInEvent);
    }

}


// copy constructor
L1GlobalTriggerEvmReadoutRecord::L1GlobalTriggerEvmReadoutRecord(
    const L1GlobalTriggerEvmReadoutRecord& result)
{

    m_gtfeWord = result.m_gtfeWord;
    m_tcsWord = result.m_tcsWord;
    m_gtFdlWord = result.m_gtFdlWord;

}

// destructor
L1GlobalTriggerEvmReadoutRecord::~L1GlobalTriggerEvmReadoutRecord()
{

    // empty now

}

// assignment operator
L1GlobalTriggerEvmReadoutRecord& L1GlobalTriggerEvmReadoutRecord::operator=(
    const L1GlobalTriggerEvmReadoutRecord& result)
{

    if ( this != &result ) {

        m_gtfeWord = result.m_gtfeWord;
        m_tcsWord  = result.m_tcsWord;
        m_gtFdlWord  = result.m_gtFdlWord;

    }

    return *this;

}

// equal operator
bool L1GlobalTriggerEvmReadoutRecord::operator==(
    const L1GlobalTriggerEvmReadoutRecord& result) const
{

    if (m_gtfeWord != result.m_gtfeWord) {
        return false;
    }

    if (m_tcsWord  != result.m_tcsWord) {
        return false;
    }

    if (m_gtFdlWord  != result.m_gtFdlWord) {
        return false;
    }

    // all members identical
    return true;

}

// unequal operator
bool L1GlobalTriggerEvmReadoutRecord::operator!=(
    const L1GlobalTriggerEvmReadoutRecord& result) const
{

    return !( result == *this);

}
// methods


// get Global Trigger decision and the decision word
//    general bxInEvent
const bool L1GlobalTriggerEvmReadoutRecord::decision(int bxInEventValue) const
{

    for (std::vector<L1GtFdlWord>::const_iterator itBx = m_gtFdlWord.begin();
            itBx != m_gtFdlWord.end(); ++itBx) {

        if ( (*itBx).bxInEvent() == bxInEventValue ) {
            return (*itBx).finalOR();
        }
    }

    // if bunch cross not found, throw exception (action: SkipEvent)

    throw cms::Exception("NotFound")
    << "\nError: requested GtFdlWord for bx = " << bxInEventValue << " does not exist.\n"
    << "Can not return global decision for this bx!\n"
    << std::endl;

    return false;
}

const DecisionWord L1GlobalTriggerEvmReadoutRecord::decisionWord(
    int bxInEventValue) const
{

    for (std::vector<L1GtFdlWord>::const_iterator itBx = m_gtFdlWord.begin();
            itBx != m_gtFdlWord.end(); ++itBx) {

        if ( (*itBx).bxInEvent() == bxInEventValue ) {
            return (*itBx).gtDecisionWord();
        }
    }

    // if bunch cross not found, throw exception (action: SkipEvent)

    throw cms::Exception("NotFound")
    << "\nError: requested GtFdlWord for bx = " << bxInEventValue << " does not exist.\n"
    << "Can not return decision word for this bx!\n"
    << std::endl;

    DecisionWord dW; // empty; it does not arrive here
    return dW;
}

//    bxInEvent = 0
const bool L1GlobalTriggerEvmReadoutRecord::decision() const
{

    int bxInEventL1Accept = 0;
    return decision(bxInEventL1Accept);
}

const DecisionWord
L1GlobalTriggerEvmReadoutRecord::decisionWord() const
{

    int bxInEventL1Accept = 0;
    return decisionWord(bxInEventL1Accept);
}


// set global decision and the decision word
//    general
void L1GlobalTriggerEvmReadoutRecord::setDecision(bool t, int bxInEventValue)
{

    for (std::vector<L1GtFdlWord>::iterator itBx = m_gtFdlWord.begin();
            itBx != m_gtFdlWord.end(); ++itBx) {

        if ( (*itBx).bxInEvent() == bxInEventValue ) {
            (*itBx).setFinalOR(static_cast<uint16_t> (t)); // TODO FIXME when manipulating partitions
        }
    }

    // if bunch cross not found, throw exception (action: SkipEvent)

    throw cms::Exception("NotFound")
    << "\nError: requested GtFdlWord for bx = " << bxInEventValue << " does not exist.\n"
    << "Can not set global decision for this bx!\n"
    << std::endl;

}

void L1GlobalTriggerEvmReadoutRecord::setDecisionWord(
    const DecisionWord& decisionWordValue,
    int bxInEventValue)
{

    for (std::vector<L1GtFdlWord>::iterator itBx = m_gtFdlWord.begin();
            itBx != m_gtFdlWord.end(); ++itBx) {

        if ( (*itBx).bxInEvent() == bxInEventValue ) {
            (*itBx).setGtDecisionWord (decisionWordValue);
        }
    }

    // if bunch cross not found, throw exception (action: SkipEvent)

    throw cms::Exception("NotFound")
    << "\nError: requested GtFdlWord for bx = " << bxInEventValue << " does not exist.\n"
    << "Can not set decision word for this bx!\n"
    << std::endl;

}

//    bxInEvent = 0
void L1GlobalTriggerEvmReadoutRecord::setDecision(bool t)
{

    int bxInEventL1Accept = 0;
    setDecision(t, bxInEventL1Accept);
}

void L1GlobalTriggerEvmReadoutRecord::setDecisionWord(
    const DecisionWord& decisionWordValue)
{

    int bxInEventL1Accept = 0;
    setDecisionWord(decisionWordValue, bxInEventL1Accept);

}

// print global decision and algorithm decision word
void L1GlobalTriggerEvmReadoutRecord::printGtDecision(
    std::ostream& myCout, int bxInEventValue) const
{

    for (std::vector<L1GtFdlWord>::const_iterator itBx = m_gtFdlWord.begin();
            itBx != m_gtFdlWord.end(); ++itBx) {

        if ( (*itBx).bxInEvent() == bxInEventValue ) {

            myCout << "\nL1 Global Trigger Record: " << std::endl;

            myCout
            << "\t Bunch cross " << bxInEventValue
            << std::endl
            << "\t Global Decision = " << std::setw(5) << (*itBx).globalDecision()
            << std::endl
            << "\t Decision word (bitset style) = ";

            (*itBx).printGtDecisionWord(myCout);
        }
    }

    myCout << std::endl;

}

void L1GlobalTriggerEvmReadoutRecord::printGtDecision(std::ostream& myCout) const
{

    int bxInEventL1Accept = 0;
    printGtDecision(myCout, bxInEventL1Accept);

}

// print technical trigger word (reverse order for vector<bool>)
void L1GlobalTriggerEvmReadoutRecord::printTechnicalTrigger(
    std::ostream& myCout, int bxInEventValue
) const
{

    for (std::vector<L1GtFdlWord>::const_iterator itBx = m_gtFdlWord.begin();
            itBx != m_gtFdlWord.end(); ++itBx) {

        if ( (*itBx).bxInEvent() == bxInEventValue ) {

            myCout << "\nL1 Global Trigger Record: " << std::endl;

            myCout
            << "\t Bunch cross " << bxInEventValue
            << std::endl
            << "\t Technical Trigger word (bitset style) = ";

            (*itBx).printGtTechnicalTriggerWord(myCout);
        }
    }

    myCout << std::endl;

}

void L1GlobalTriggerEvmReadoutRecord::printTechnicalTrigger(std::ostream& myCout) const
{

    int bxInEventL1Accept = 0;
    printTechnicalTrigger(myCout, bxInEventL1Accept);

}

// get/set hardware-related words

// get / set GTFE word (record) in the GT readout record
const L1GtfeExtWord L1GlobalTriggerEvmReadoutRecord::gtfeWord() const
{

    return m_gtfeWord;

}

void L1GlobalTriggerEvmReadoutRecord::setGtfeWord(const L1GtfeExtWord& gtfeWordValue)
{

    m_gtfeWord = gtfeWordValue;

}

// get / set TCS word (record) in the GT readout record
const L1TcsWord L1GlobalTriggerEvmReadoutRecord::tcsWord() const
{

    return m_tcsWord;

}

void L1GlobalTriggerEvmReadoutRecord::setTcsWord(const L1TcsWord& tcsWordValue)
{

    m_tcsWord = tcsWordValue;

}

// get / set FDL word (record) in the GT readout record
const L1GtFdlWord L1GlobalTriggerEvmReadoutRecord::gtFdlWord(int bxInEventValue) const
{

    for (std::vector<L1GtFdlWord>::const_iterator itBx = m_gtFdlWord.begin();
            itBx != m_gtFdlWord.end(); ++itBx) {

        if ( (*itBx).bxInEvent() == bxInEventValue ) {
            return (*itBx);
        }
    }

    // if bunch cross not found, throw exception (action: SkipEvent)

    throw cms::Exception("NotFound")
    << "\nError: requested L1GtFdlWord for bx = " << bxInEventValue << " does not exist.\n"
    << std::endl;

    // return empty record - actually does not arrive here
    return L1GtFdlWord();

}

const L1GtFdlWord L1GlobalTriggerEvmReadoutRecord::gtFdlWord() const
{

    int bxInEventL1Accept = 0;
    return gtFdlWord(bxInEventL1Accept);
}

void L1GlobalTriggerEvmReadoutRecord::setGtFdlWord(
    const L1GtFdlWord& gtFdlWordValue, int bxInEventValue)
{

    // if a L1GtFdlWord exists for bxInEventValue, replace it
    for (std::vector<L1GtFdlWord>::iterator itBx = m_gtFdlWord.begin();
            itBx != m_gtFdlWord.end(); ++itBx) {

        if ( (*itBx).bxInEvent() == bxInEventValue ) {
            *itBx = gtFdlWordValue;
            LogDebug("L1GlobalTriggerEvmReadoutRecord")
            << "Replacing L1GtFdlWord for bunch bx = " << bxInEventValue << "\n"
            << std::endl;
            return;
        }
    }

    // if bunch cross not found, throw exception (action: SkipEvent)
    // all L1GtFdlWord are created in the record constructor for allowed bunch crosses

    throw cms::Exception("NotFound")
    << "\nError: Cannot set L1GtFdlWord for bx = " << bxInEventValue
    << std::endl;

}

void L1GlobalTriggerEvmReadoutRecord::setGtFdlWord(const L1GtFdlWord& gtFdlWordValue)
{

    // just push back the new FDL block
    m_gtFdlWord.push_back(gtFdlWordValue);

}


// other methods

// clear the record
void L1GlobalTriggerEvmReadoutRecord::reset()
{

    // TODO FIXME clear GTFE, TCS, FDL?

}

void L1GlobalTriggerEvmReadoutRecord::print(std::ostream& myCout) const
{

    myCout << "\n L1GlobalTriggerEvmReadoutRecord::print \n" << std::endl;

    m_gtfeWord.print(myCout);

    m_tcsWord.print(myCout);

    for (std::vector<L1GtFdlWord>::const_iterator itFdl = m_gtFdlWord.begin();
            itFdl != m_gtFdlWord.end(); ++itFdl) {

        itFdl->print(myCout);

    }

}


// output stream operator
std::ostream& operator<<(std::ostream& s, const L1GlobalTriggerEvmReadoutRecord& result)
{
    // TODO FIXME put together all prints
    s << "Not available yet - sorry";

    return s;

}