IParticleBroker.h

Go to the documentation of this file.

/*
  Copyright (C) 2002-2022 CERN for the benefit of the ATLAS collaboration
*/

// IParticleBroker.h, (c) ATLAS Detector software
#ifndef ISF_INTERFACES_IPARTICLEBROKER_H
#define ISF_INTERFACES_IPARTICLEBROKER_H 1
 
// Framework includes
#include "GaudiKernel/IInterface.h"
#include "GaudiKernel/StatusCode.h"
#include "GaudiKernel/ToolHandle.h"
#include "GaudiKernel/ServiceHandle.h"
 
// DetectorDescription
#include "AtlasDetDescr/AtlasRegion.h"
 
// ISF includes
#include "ISF_Event/SimSvcID.h"
#include "ISF_Event/ISFParticleContainer.h"
#include "ISF_Event/EntryLayer.h"
#include "ISF_Interfaces/ISimulationSelector.h"
 
#include "CxxUtils/checker_macros.h"
 
namespace ISF {
 
  class ISFParticle;
  class IStackFiller;

  class ATLAS_NOT_THREAD_SAFE IParticleBroker : virtual public IInterface {

      // Public methods: 
    public: 

      DeclareInterfaceID(IParticleBroker, 1, 0);
      
      virtual StatusCode registerSimSelector(SimSelectorToolArray &simSelectorTools, AtlasDetDescr::AtlasRegion geoID) = 0;

      virtual StatusCode initializeEvent(ISFParticleContainer&& simParticles) = 0;

      virtual StatusCode finalizeEvent() = 0;

      virtual void push( ISFParticle *particle, const ISFParticle *parent) = 0;
           
      virtual const ISFParticleVector& popVector(size_t maxVectorSize=10240) = 0;

      virtual size_t numParticles() const = 0;
 
      /* Dump the stack to the screen */
      virtual StatusCode dump() const = 0;
  }; 
}
 
#endif //> !ISF_INTERFACES_IPARTICLEBROKER_H