L1GtVhdlWriterCore.h

Go to the documentation of this file.

#ifndef L1GtConfigProducers_L1GtVhdlWriterCore_h
#define L1GtConfigProducers_L1GtVhdlWriterCore_h

// system include files

#include <iostream>
#include <fstream>
#include <map>
#include <string>
#include <vector>

// CMSSW headers
#include "L1GtVhdlTemplateFile.h"

#include "CondFormats/L1TObjects/interface/L1GtTriggerMenuFwd.h"
#include "CondFormats/L1TObjects/interface/L1GtFwd.h"
#include "DataFormats/L1GlobalTrigger/interface/L1GlobalTriggerReadoutSetupFwd.h"

#include "CondFormats/L1TObjects/interface/L1GtMuonTemplate.h"
#include "CondFormats/L1TObjects/interface/L1GtCaloTemplate.h"
#include "CondFormats/L1TObjects/interface/L1GtEnergySumTemplate.h"

#include "L1TriggerConfig/L1GtConfigProducers/interface/L1GtVhdlDefinitions.h"
#include "L1TriggerConfig/L1GtConfigProducers/interface/L1GtVhdlWriterBitManager.h"
#include "L1TriggerConfig/L1GtConfigProducers/interface/L1GtVhdlWriterCore.h"

class L1GtVhdlWriterCore : public L1GtVhdlDefinitions
{

    public:

        L1GtVhdlWriterCore(const std::string &templatesDirectory, const std::string &outputDirectory, const bool &debug);

        ~L1GtVhdlWriterCore();

        bool returnConditionsOfOneClass(const L1GtConditionType &type,  const L1GtConditionCategory &category, const L1GtObject &object, const ConditionMap &map,  ConditionMap &outputMap);

        void getMuonSetupContentFromTriggerMenu(const unsigned short int &condChip, std::map<std::string,std::string> &muonParameters);

        bool getSubstParamCommonFromTriggerMenu(const unsigned short int &condChip, L1GtVhdlTemplateFile &particle, const L1GtObject &object, const L1GtConditionCategory &category,
            std::string &parameterStr);

        bool getCaloSetupContentFromTriggerMenu(const unsigned short int &condChip, std::map<std::string,std::string> &caloParameters,
            const L1GtObject &caloObject);
        
        bool getEsumsSetupContentFromTriggerMenu(const unsigned short int &condChip,  const L1GtObject &object, std::string &energySumParameter);

        bool getCondChipVhdContentFromTriggerMenu(const unsigned short int &condChip, std::map<std::string, L1GtVhdlTemplateFile> &templates,
            std::map<std::string, std::string> &commonParams);

        std::string retNumberOfConditionsString(const std::string &typeStr, const int &number);
        
        bool findObjectType(const L1GtObject &object, ConditionMap &map);
        
        // builds the parameters particle_common for the cond_chip.vhd's
        // bool buildCommonParameter(L1GtVhdlTemplateFile &particle,const L1GtObject &object, const L1GtConditionCategory &category, std::string &parameterStr, const ConditionMap &conditionMap);

        void addJetCountsToCond2IntMap(const int chip, const std::vector<ConditionMap> &conditionMap, std::map<std::string,int> &conditionToIntegerMap);

        bool processAlgorithmMap(std::vector< std::map<int, std::string> > &algoStrings);
        
        void buildCommonHeader(std::map<std::string,std::string> &headerParameters , const std::vector<std::string> &connectedChannels);

        L1GtVhdlTemplateFile openVhdlFileWithCommonHeader(const std::string &filename, const std::string &outputFilename);

        L1GtVhdlTemplateFile retrunCommonHeader();

        void printCommonHeader();

        bool makeFirmware(const std::vector<ConditionMap> &conditionMap,const AlgorithmMap &algorithmMap);

        void writeMuonSetupVhdl(std::map<std::string,std::string> &muonParameters, const std::string &particle, unsigned short int &condChip);

        void writeConditionChipSetup(const std::map<std::string, L1GtVhdlTemplateFile>& templates, const std::map<std::string, std::string> &common, const unsigned short int &chip);

        void writeDefValPkg(const std::vector<ConditionMap> &conditionMap, const int &chip);
        
        void writeEtmSetup(std::string &etmString, const int &condChip);

        void writeAlgoSetup(std::vector< std::map<int, std::string> > &algoStrings);

        void writeQsfSetupFiles(const std::string &version);

        static std::string int2str(const int &integerValue);

        bool getIntVal(const std::map<std::string,int> &map,  const std::string &searchValue, int &intVal);

        std::string gtTemplatesPath();

        void msg(const std::string &message);

        std::vector<std::string> getMsgBuf();

        std::string index4CondChipVhd(int intval);

        void countCondsAndAdd2NumberVec(const L1GtConditionType &type,  const L1GtConditionCategory &category, const L1GtObject &object, const ConditionMap &map, ConditionMap &outputMap,const int &condChip);

        void initializeDeltaConditions();

        void writeCond2intMap2File();

        void printConditionsOfCategory(const L1GtConditionCategory &category, const ConditionMap &map);

        L1GtConditionCategory getCategoryFromObject(const L1GtObject &object);
        
        std:: string buildDefValString(const int &conditionIndex, const std::vector<int> &values);
        
        void writeCondChipPkg(const int &chip);
        
        std::map<std::string,int> getCond2IntMap();
        
        bool buildDefValuesBuffer(L1GtVhdlTemplateFile &buffer, const std::map<L1GtConditionType,std::string> &typeList, const std::vector<std::string> &defValuesList, const L1GtObject &object);

        std::string getDefValsFromTriggerMenu(const L1GtConditionType &type, const L1GtObject &object, const VmeRegister &reg);
        
        std::string sp(const std::string &name);
        
        std::string chip2OutputSubDir(const int &chip);

    private:
        
        const std::vector<ConditionMap> * conditionMap_;
        
        const AlgorithmMap * algorithmMap_;

        std::map<std::string,int> conditionToIntegerMap_;
        
        std::map<L1GtConditionType,std::string> condType2Str_;

        std::map<L1GtObject,std::string> caloType2Int_;

        std::map<L1GtObject,std::string> objType2Str_;

        std::vector<L1GtObject> caloObjects_;

        std::vector<L1GtObject> esumObjects_;

        std::string vhdlDir_;

        std::string outputDir_;

        L1GtVhdlWriterBitManager bm_;
        
        std::string version_;

        L1GtVhdlTemplateFile commonHeader_;

        std::vector<std::string> internMessageBuf_;

        std::vector<std::vector<std::string> > numberOfConditions_;

        bool debugMode_;

};
#endif                                            /*L1GtConfigProducers_L1GtVhdlWriterCore_h*/