TopoSteering.h

Go to the documentation of this file.

/*
  Copyright (C) 2002-2024 CERN for the benefit of the ATLAS collaboration
*/
 
#ifndef L1TopoCoreSim_TopoSteering
#define L1TopoCoreSim_TopoSteering
 
 
 
#include "CxxUtils/checker_macros.h"
 
#include "TrigConfBase/TrigConfMessaging.h"
 
#include "L1TopoCommon/StatusCode.h"
#include "L1TopoEvent/TopoInputEvent.h"
#include "L1TopoInterfaces/ParameterSpace.h"
#include "L1TopoCoreSim/TopoCoreSimResult.h"
#include "L1TopoCoreSim/TopoSteeringStructure.h"
 
// Menu related dependencies
#include "TrigConfData/L1Menu.h"
#include <bitset>
#include <iosfwd>
#include <memory>
#include <vector>
#include <string>
 
namespace TXC {
   class L1TopoMenu;
}
 
class IL1TopoHistSvc;
 
namespace TCS {
 
   class InputConnector;
   class SortingConnector;
   class DecisionConnector;
   class CountingConnector;
   class ConfigurableAlg;
   class SortingAlg;
   class Decision;
   class DecisionAlg;
   class Count;
   class CountingAlg;
 
   class TopoSteering : public TrigConf::TrigConfMessaging {
   public:
     
      // default constructor
      TopoSteering();
     
      const TopoSteeringStructure & structure() const { return m_structure; }
 
      TopoInputEvent & inputEvent() { return m_inputEvent; }
 
      const TopoCoreSimResult & simulationResult() const { return m_simulationResult; }
 
 
      // @brief: build the execution structure and parameterspace from
      // the configuration
      StatusCode setupFromConfiguration ATLAS_NOT_THREAD_SAFE (const TrigConf::L1Menu& l1menu);
 
      void setUseBitwise(bool useBitwise) { m_useBitwise = useBitwise; }
 
      // @brief: call the initialize function of the algorithms
      // will be called after the parameters are set and before the event loop starts
      StatusCode initializeAlgorithms();
 
 
      // run the topo simulation
      StatusCode executeEvent();
      
      StatusCode executeTrigger(const std::string & triggerName);
 
      // resets the inputEvent, connectors (status, intermediate TOBs,
      // and decision of algs), and the simulation result
      StatusCode reset();
      
      void printDebugInfo();
 
      const TCS::ParameterSpace & parameters(const std::string & algName) const;
      
      const std::vector<TCS::Connector*> & connectors() const { return structure().connectors(); } //added
 
      void printConfiguration(std::ostream & o) const;
 
      void setMsgLevel( TrigConf::MSGTC::Level lvl );
 
      void setAlgMsgLevel( TrigConf::MSGTC::Level lvl );
 
      void setLegacyMode(bool isLegacyTopo) {m_isLegacyTopo=isLegacyTopo;}

      StatusCode setHistSvc(std::shared_ptr<IL1TopoHistSvc> histSvc);
 
      StatusCode saveHist();
 
      static const unsigned int numberOfL1TopoBits = 128;
      void setHardwareBits(const std::bitset<numberOfL1TopoBits> &triggerBits,
                           const std::bitset<numberOfL1TopoBits> &ovrflowBits);
      void propagateHardwareBitsToAlgos();
      void setOutputAlgosFillBasedOnHardware(const bool &value);
      void setOutputAlgosSkipHistograms(const bool &value);
   private:
 
      // execution
      StatusCode executeConnector(TCS::Connector *conn);
 
      StatusCode executeInputConnector(TCS::InputConnector *conn);
 
      StatusCode executeSortingConnector(TCS::SortingConnector *conn);
 
      StatusCode executeDecisionConnector(TCS::DecisionConnector *conn);
 
      StatusCode executeCountingConnector(TCS::CountingConnector *conn);
      
      StatusCode executeAlgorithm(ConfigurableAlg *alg, Connector* connector);
      
      StatusCode executeSortingAlgorithm(SortingAlg *alg, TCS::InputConnector* inputConnector, TOBArray * & output);
      
      StatusCode executeDecisionAlgorithm(TCS::DecisionAlg *alg, const std::vector<Connector*> & inputConnectors, const std::vector<TCS::TOBArray *> & output, Decision & decsion);
      
      StatusCode executeCountingAlgorithm(TCS::CountingAlg *alg, TCS::InputConnector* inputConnector, Count & count);
 
 
 
   private:
      bool m_useBitwise{false};                  // Using bitwise algorithms? Disabled by default. Needs a menu global flag.
 
      bool m_isLegacyTopo{false};
     
      TopoInputEvent         m_inputEvent;       // the input event
 
      TopoCoreSimResult      m_simulationResult; // the result of the execution
      
      TopoSteeringStructure  m_structure;
 
      unsigned int m_evtCounter {1};
      
      TrigConf::MSGTC::Level m_AlgMsgLvl { TrigConf::MSGTC::WARNING };
 
      std::shared_ptr<IL1TopoHistSvc>  m_histSvc;
 
      std::bitset<numberOfL1TopoBits> m_triggerHdwBits;
      std::bitset<numberOfL1TopoBits> m_ovrflowHdwBits;
   };
 
   
} 
 
#endif