L1GtfeExtWord.h

Go to the documentation of this file.

#ifndef L1GlobalTrigger_L1GtfeExtWord_h
#define L1GlobalTrigger_L1GtfeExtWord_h

// system include files
#include <vector>
#include <iosfwd>

// user include files
#include "FWCore/Utilities/interface/typedefs.h"

// base class
#include "DataFormats/L1GlobalTrigger/interface/L1GtfeWord.h"

// forward declarations

// class declaration
class L1GtfeExtWord : public L1GtfeWord
{

public:

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

    L1GtfeExtWord(int bstSizeBytes);

    L1GtfeExtWord(
        cms_uint16_t boardIdValue,
        cms_uint16_t recordLengthValue,
        cms_uint16_t recordLength1Value,
        cms_uint16_t bxNrValue,
        cms_uint32_t setupVersionValue,
        cms_uint16_t activeBoardsValue,
        cms_uint16_t altNrBxBoardValue,
        cms_uint32_t totalTriggerNrValue, // end of L1GtfeWord
        const std::vector<cms_uint16_t>& bstValue,
        cms_uint16_t bstSourceValue
    );


    ~L1GtfeExtWord() override;

    bool operator==(const L1GtfeExtWord&) const;

    bool operator!=(const L1GtfeExtWord&) const;

public:

    inline const std::vector<cms_uint16_t>&  bst() const {
        return m_bst;
    }

    inline const unsigned int bstLengthBytes() const {
        return m_bst.size();
    }

public:


    const cms_uint64_t gpsTime() const;
    void setGpsTime(const cms_uint64_t);

    const cms_uint16_t bstMasterStatus() const;
    const cms_uint32_t turnCountNumber() const;
    const cms_uint32_t lhcFillNumber() const;
    const cms_uint16_t beamMode() const;
    const cms_uint16_t particleTypeBeam1() const;
    const cms_uint16_t particleTypeBeam2() const;
    const cms_uint16_t beamMomentum() const;
    const cms_uint32_t totalIntensityBeam1() const;
    const cms_uint32_t totalIntensityBeam2() const;



public:

    const cms_uint16_t bst(int iB) const;
    void setBst(const cms_uint16_t bstVal, const int iB);

    void setBst(const cms_uint64_t& word64, const int iB);

    void setBstWord64(cms_uint64_t& word64, int iB, const int iWord);


    inline const cms_uint16_t bstSource() const {
        return m_bstSource;
    }

    inline void setBstSource(const cms_uint16_t bstSourceVal) {
        m_bstSource = bstSourceVal;
    }

    void setBstSource(const cms_uint64_t& word64);

    void setBstSourceWord64(cms_uint64_t& word64, const int iWord);

public:

    const unsigned int getSize() const;

public:

    void resize(int bstSizeBytes);

    void reset() override;

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

    void unpack(const unsigned char* gtfePtr) override;

private:


    static const int BstFirstWord;

    static const int BstBitSize;

    static const cms_uint64_t BstBlockMask;


    static const int GpsTimeFirstBlock;
    static const int GpsTimeLastBlock;

    static const int BstMasterStatusFirstBlock;
    static const int BstMasterStatusLastBlock;

    static const int TurnCountNumberFirstBlock;
    static const int TurnCountNumberLastBlock;

    static const int LhcFillNumberFirstBlock;
    static const int LhcFillNumberLastBlock;

    static const int BeamModeFirstBlock;
    static const int BeamModeLastBlock;

    static const int ParticleTypeBeam1FirstBlock;
    static const int ParticleTypeBeam1LastBlock;

    static const int ParticleTypeBeam2FirstBlock;
    static const int ParticleTypeBeam2LastBlock;

    static const int BeamMomentumFirstBlock;
    static const int BeamMomentumLastBlock;

    static const int TotalIntensityBeam1FirstBlock;
    static const int TotalIntensityBeam1LastBlock;

    static const int TotalIntensityBeam2FirstBlock;
    static const int TotalIntensityBeam2LastBlock;

    // BST message source written always in the last word of GTFE extended
    static const cms_uint64_t BstSourceMask;

    static const int BstSourceShift;



private:

    std::vector<cms_uint16_t> m_bst;

    cms_uint16_t m_bstSource;

};

#endif /*L1GlobalTrigger_L1GtfeExtWord_h*/