L1TcsWord.h

Go to the documentation of this file.

#ifndef L1GlobalTrigger_L1TcsWord_h
#define L1GlobalTrigger_L1TcsWord_h

// system include files
#include <boost/cstdint.hpp>
#include <iosfwd>

// user include files
#include "DataFormats/L1GlobalTrigger/interface/L1GlobalTriggerReadoutSetupFwd.h"
#include "DataFormats/L1GlobalTrigger/interface/L1GlobalTriggerReadoutSetup.h"

// forward declarations

// class declaration
class L1TcsWord
{

public:

    L1TcsWord();    // empty constructor, all members set to zero;

    L1TcsWord(
        boost::uint16_t boardIdValue,
        boost::uint16_t bxNrValue,
        boost::uint16_t daqNrValue,
        boost::uint16_t triggerTypeValue,
        boost::uint16_t statusValue,
        boost::uint16_t luminositySegmentNrValue,
        boost::uint32_t partRunNrValue,
        boost::uint32_t assignedPartitionsValue,
        boost::uint32_t partTrigNrValue,
        boost::uint32_t eventNrValue,
        boost::uint64_t orbitNrValue );


    virtual ~L1TcsWord();

    bool operator==(const L1TcsWord&) const;

    bool operator!=(const L1TcsWord&) const;

public:


    inline const boost::uint16_t boardId() const
    {
        return m_boardId;
    }

    void setBoardId(const boost::uint16_t boardIdValue)
    {
        m_boardId = boardIdValue;
    }

    void setBoardId(const boost::uint64_t& word64);

    void setBoardIdWord64(boost::uint64_t& word64, int iWord);



    inline const boost::uint16_t bxNr() const
    {
        return m_bxNr;
    }

    void setBxNr(const boost::uint16_t bxNrValue)
    {
        m_bxNr = bxNrValue;
    }

    void setBxNr(const boost::uint64_t& word64);

    void setBxNrWord64(boost::uint64_t& word64, int iWord);



    inline const boost::uint16_t daqNr() const
    {
        return m_daqNr;
    }

    void setDaqNr(const boost::uint16_t daqNrValue)
    {
        m_daqNr = daqNrValue;
    }

    void setDaqNr(const boost::uint64_t& word64);

    void setDaqNrWord64(boost::uint64_t& word64, int iWord);



    inline const boost::uint16_t triggerType() const
    {
        return m_triggerType;
    }

    void setTriggerType(const boost::uint16_t triggerTypeValue)
    {
        m_triggerType = triggerTypeValue;
    }

    void setTriggerType(const boost::uint64_t& word64);

    void setTriggerTypeWord64(boost::uint64_t& word64, int iWord);



    inline const boost::uint16_t status() const
    {
        return m_status;
    }

    void setStatus(const boost::uint16_t statusValue)
    {
        m_status = statusValue;
    }

    void setStatus(const boost::uint64_t& word64);

    void setStatusWord64(boost::uint64_t& word64, int iWord);


    inline const boost::uint16_t luminositySegmentNr() const
    {
        return m_luminositySegmentNr;
    }

    void setLuminositySegmentNr(const boost::uint16_t luminositySegmentNrValue)
    {
        m_luminositySegmentNr = luminositySegmentNrValue;
    }

    void setLuminositySegmentNr(const boost::uint64_t& word64);

    void setLuminositySegmentNrWord64(boost::uint64_t& word64, int iWord);



    inline const boost::uint32_t partRunNr() const
    {
        return m_partRunNr;
    }

    void setPartRunNr(const boost::uint32_t partRunNrValue)
    {
        m_partRunNr = partRunNrValue;
    }

    void setPartRunNr(const boost::uint64_t& word64);

    void setPartRunNrWord64(boost::uint64_t& word64, int iWord);



    inline const boost::uint32_t assignedPartitions() const
    {
        return m_assignedPartitions;
    }

    void setAssignedPartitions(const boost::uint32_t assignedPartitionsValue)
    {
        m_assignedPartitions = assignedPartitionsValue;
    }

    void setAssignedPartitions(const boost::uint64_t& word64);

    void setAssignedPartitionsWord64(boost::uint64_t& word64, int iWord);



    inline const boost::uint32_t partTrigNr() const
    {
        return m_partTrigNr;
    }

    void setPartTrigNr(const boost::uint32_t partTrigNrValue)
    {
        m_partTrigNr = partTrigNrValue;
    }

    void setPartTrigNr(const boost::uint64_t& word64);

    void setPartTrigNrWord64(boost::uint64_t& word64, int iWord);



    inline const boost::uint32_t eventNr() const
    {
        return m_eventNr;
    }

    void setEventNr(const boost::uint32_t eventNrValue)
    {
        m_eventNr = eventNrValue;
    }

    void setEventNr(const boost::uint64_t& word64);

    void setEventNrWord64(boost::uint64_t& word64, int iWord);



    inline const boost::uint64_t orbitNr() const
    {
        return m_orbitNr;
    }

    void setOrbitNr(const boost::uint64_t orbitNrValue)
    {
        m_orbitNr = orbitNrValue;
    }

    void setOrbitNrFrom(const boost::uint64_t& word64);

    void setOrbitNrWord64(boost::uint64_t& word64, int iWord);


    inline const unsigned int getSize() const
    {
        int unitLengthBits = L1GlobalTriggerReadoutSetup::UnitLength;

        return BlockSize*unitLengthBits;
    }

public:

    void reset();

    void print(std::ostream& myCout) const;

    void unpack(const unsigned char* tcsPtr);



private:

    // block description in the raw GT record

    // block size in 64bits words (BlockSize * 64 bits)
    static const int BlockSize;

    // word 0

    // index of the word in the TCS block containig the variable
    static const int BoardIdWord;
    static const int BxNrWord;
    static const int DaqNrWord;
    static const int TriggerTypeWord;
    static const int StatusWord;
    static const int LuminositySegmentNrWord;

    // mask to get the 64-bit-value from the corresponding word in the TCS block
    static const boost::uint64_t BoardIdMask;
    static const boost::uint64_t BxNrMask;
    static const boost::uint64_t DaqNrMask;
    static const boost::uint64_t TriggerTypeMask;
    static const boost::uint64_t StatusMask;
    static const boost::uint64_t LuminositySegmentNrMask;

    // shift to the right to get the value from the "64-bit-value"
    static const int BoardIdShift;
    static const int BxNrShift;
    static const int DaqNrShift;
    static const int TriggerTypeShift;
    static const int StatusShift;
    static const int LuminositySegmentNrShift;

    // word 1

    static const int PartRunNrWord;
    static const int AssignedPartitionsWord;

    static const boost::uint64_t PartRunNrMask;
    static const boost::uint64_t AssignedPartitionsMask;

    static const int PartRunNrShift;
    static const int AssignedPartitionsShift;

    // word 2

    static const int PartTrigNrWord;
    static const int EventNrWord;

    static const boost::uint64_t PartTrigNrMask;
    static const boost::uint64_t EventNrMask;

    static const int PartTrigNrShift;
    static const int EventNrShift;

    // word 3

    static const int OrbitNrWord;

    static const boost::uint64_t OrbitNrMask;

    static const int OrbitNrShift;


    // word 4

    // empty



private:

    boost::uint16_t m_boardId;

    boost::uint16_t m_bxNr;

    boost::uint16_t m_daqNr;

    boost::uint16_t m_triggerType;

    boost::uint16_t m_status;

    boost::uint16_t m_luminositySegmentNr;

    //

    boost::uint32_t m_partRunNr;

    boost::uint32_t m_assignedPartitions;

    //

    boost::uint32_t m_partTrigNr;

    boost::uint32_t m_eventNr;

    //

    boost::uint64_t m_orbitNr;

    //
    // empty word

};

#endif /*L1GlobalTrigger_L1TcsWord_h*/