ParticleBrokerDynamicOnReadIn.h

Go to the documentation of this file.

/*
  Copyright (C) 2002-2024 CERN for the benefit of the ATLAS collaboration
*/
 
#ifndef ISF_SERVICES_PARTICLEBROKERDYNAMICONREADIN_H
#define ISF_SERVICES_PARTICLEBROKERDYNAMICONREADIN_H 1
 
// STL includes
#include <string>
#include <set>
 
// FrameWork includes
#include "GaudiKernel/ToolHandle.h"
#include "GaudiKernel/ServiceHandle.h"
#include "AthenaBaseComps/AthService.h"
#include "GaudiKernel/ITHistSvc.h"
 
// ISF includes
#include "ISF_Interfaces/IParticleBroker.h"
#include "ISF_Interfaces/IParticleOrderingTool.h"
#include "ISF_Interfaces/IEntryLayerTool.h"
#include "ISF_Interfaces/IGeoIDSvc.h"
#include "ISF_Interfaces/SimulationFlavor.h"
#include "ISF_Event/EntryLayer.h"
#include "ISF_Event/ISFParticleContainer.h"
#include "ISF_Event/ISFParticleOrderedQueue.h"
 
// AtlasDetDescr
#include "AtlasDetDescr/AtlasRegion.h"
 
// forward declarations
namespace PMonUtils {
  class CustomBenchmark;
}
// ROOT forward declarations
class TTree;
 
namespace ISF {
 
  class ISimulationSelector;
 
  typedef std::vector<ISimulationSelector*>      SimSelectorArray;
  typedef std::set<ISimulationSelector*>         SimSelectorSet;

  class ATLAS_NOT_THREAD_SAFE ParticleBrokerDynamicOnReadIn : public extends<AthService, IParticleBroker> {
    public:
 
      //** Constructor with parameters */
      ParticleBrokerDynamicOnReadIn( const std::string& name, ISvcLocator* pSvcLocator );

      virtual ~ParticleBrokerDynamicOnReadIn();

      StatusCode  initialize();

      StatusCode initializeEvent(ISFParticleContainer&& simParticles);

      virtual StatusCode finalizeEvent();

      virtual void push( ISFParticle *particle, const ISFParticle *ancestor);

      virtual const ISFParticleVector& popVector(size_t maxVectorSize);

      virtual size_t numParticles() const;

      //const ParticleContainer& particleStack() const;
 
      /* Dump the stack to the screen */
      StatusCode dump() const;

      StatusCode registerSimSelector(SimSelectorToolArray &simSelectorTools, AtlasDetDescr::AtlasRegion geoID);
 
    private:
      ParticleBrokerDynamicOnReadIn();

      StatusCode registerPosValTree( const char *treeName,
                                     const char *treeDescr,
                                     TTree      *&tree );

      void fillPosValTree( TTree *tree, const ISFParticle &particle);

      void updateAllSelectors(const ISFParticle &particle);

      void selectAndStore( ISFParticle* p);

      ISF::SimSvcID identifySimID( const ISF::ISFParticle* p);

      PublicToolHandle<IEntryLayerTool> m_entryLayerTool{this, "EntryLayerTool", "iGeant4::EntryLayerTool/ISF_EntryLayerTool"};

      PublicToolHandle<IParticleOrderingTool> m_orderingTool{this, "ParticleOrderingTool", ""};

      ServiceHandle<IGeoIDSvc> m_geoIDSvc{this, "GeoIDSvc", ""};
      IGeoIDSvc *m_geoIDSvcQuick{};         

      BooleanProperty m_forceGeoIDSvc{this, "AlwaysUseGeoIDSvc", false};

      BooleanProperty m_validateGeoID{this, "ValidateGeoIDs", false};

      ISFParticleOrderedQueue                   m_particles;

      ISFParticleVector                         m_popParticles;

      SimSelectorArray                          m_simSelector[AtlasDetDescr::fNumAtlasRegions]; 
      SimSelectorSet                            m_simSelectorSet; 

      std::string                               m_screenOutputPrefix{"isf >> "};
      std::string                               m_screenEmptyPrefix{""};

      BooleanProperty m_doSelectorCPUMon{this, "SimSelectorCPUMonitoring", false}; 
      PMonUtils::CustomBenchmark               *m_benchPDGCode{};
      PMonUtils::CustomBenchmark               *m_benchGeoID{};

      BooleanProperty m_validationOutput{this, "ValidationOutput", false, "If turned on, write out a ROOT tree."}; 
      ServiceHandle<ITHistSvc> m_thistSvc{this, "THistService", "THistSvc"};         
      StringProperty m_validationStream{this, "ValidationStreamName", "ParticleBroker"}; 
      TTree                                    *m_t_pushPosition{};
      TTree                                    *m_t_entryLayerPos[ISF::fNumAtlasEntryLayers];
      int m_val_pdg{0};
      float  m_val_p{0.f};
      float  m_val_x{0.f};
      float m_val_y{0.f};
      float m_val_z{0.f};
  };

  inline size_t ParticleBrokerDynamicOnReadIn::numParticles() const { return m_particles.size(); }

  /* inline const ParticleContainer& ParticleBrokerDynamicOnReadIn::particleStack() const
  {
    // @TODO:
    //ATH_MSG_WARNING("TODO: the ParticleBrokerDynamicOnReadIn::particleStack() method only returns the active part of the partilce stack");
    return m_activeStack;
  } */
 
}
 
#endif //> !ISF_SERVICES_PARTICLEBROKERDYNAMICONREADIN_H