BaseSimulationG4Svc.h

Go to the documentation of this file.

/*
  Copyright (C) 2002-2025 CERN for the benefit of the ATLAS collaboration
*/
 
#ifndef ISF_BASESIMULATIONG4SVC_H
#define ISF_BASESIMULATIONG4SVC_H 1
 
// STL includes
#include <memory.h>
#include <string>
 
// FrameWork includes
#include "AthenaBaseComps/AthService.h"
#include <GaudiKernel/StatusCode.h>
#include "GeneratorObjects/McEventCollection.h"
 
// ISF includes
#include "ISF_Event/ISFParticle.h"
#include "ISF_Interfaces/BaseSimulationSvc.h"
#include "ISF_Interfaces/ISimulationSvc.h"
 
class HitCollectionMap;
 
namespace ISF {
 
class IParticleBroker;
class ITruthSvc;

class BaseSimulationG4Svc : public ISF::BaseSimulationSvc {
 public:
  using BaseSimulationSvc::BaseSimulationSvc;

  virtual ~BaseSimulationG4Svc() = default;

  virtual StatusCode simulate(ISFParticle&, McEventCollection*,
                              std::shared_ptr<HitCollectionMap>) = 0;

  virtual StatusCode setupEvent(HitCollectionMap&) = 0;

  virtual StatusCode releaseEvent(HitCollectionMap&) = 0;

  virtual StatusCode simulateVector(const ISFParticleVector& particles,
                                    McEventCollection* mcEventCollection,
                                    std::shared_ptr<HitCollectionMap> hitCollections,
                                    McEventCollection*) {
    // this implementation is a wrapper in case the simulator does
    // implement particle-vector input
    StatusCode sc = StatusCode::SUCCESS;
    // simulate each particle individually
    for (ISF::ISFParticle* part : particles) {
      ATH_MSG_VERBOSE(m_screenOutputPrefix
                      << "Starting simulation of particle: " << part);
      if (this->simulate(*part, mcEventCollection, hitCollections).isFailure()) {
        ATH_MSG_WARNING("Simulation of particle failed!"
                        << endmsg
                        << "   -> simulator: " << this->simSvcDescriptor()
                        << "   -> particle : " << *part);
        sc = StatusCode::FAILURE;
      }
    }
    return sc;
  }


  virtual StatusCode simulate(ISFParticle&, McEventCollection*) override {
    return StatusCode::FAILURE;
  }

  virtual StatusCode setupEvent() override { return StatusCode::FAILURE; }

  virtual StatusCode releaseEvent() override { return StatusCode::FAILURE; }

  virtual StatusCode simulateVector(const ISFParticleVector&,
                                    McEventCollection*,
                                    McEventCollection*) override {
    return StatusCode::FAILURE;
  }
};
}  // namespace ISF
 
#endif  //> !ISF_BASESIMULATIONSVC_H