GenModule.h

Go to the documentation of this file.

/*
  Copyright (C) 2002-2022 CERN for the benefit of the ATLAS collaboration
*/
 
#ifndef GENERATORMODULES_GENMODULE_H
#define GENERATORMODULES_GENMODULE_H
 
#include "GeneratorModules/GenBase.h"
#include "AthenaKernel/IAthRNGSvc.h"
#include "CLHEP/Random/RandomEngine.h"
#include "CLHEP/Random/RandPoisson.h"
#include <memory>
#include "AtlasHepMC/GenEvent.h"
 

class GenModule : public GenBase {
public:



  GenModule(const std::string& name, ISvcLocator* pSvcLocator);
  virtual ~GenModule() { }
 


  StatusCode initialize();
  StatusCode execute(const EventContext& ctx);
  StatusCode finalize() { return genFinalize(); }
 



  virtual StatusCode genInitialize() { return StatusCode::SUCCESS; }
  virtual StatusCode genuserInitialize() { return StatusCode::SUCCESS; }
  virtual StatusCode callGenerator() { return StatusCode::SUCCESS; }
  virtual StatusCode fillEvt(HepMC::GenEvent* evt) = 0;
  virtual StatusCode genFinalize() { return StatusCode::SUCCESS; }
 
 
protected:


  CLHEP::HepRandomEngine* getRandomEngine(const std::string& streamName, const EventContext& ctx) const;
  CLHEP::HepRandomEngine* getRandomEngine(const std::string& streamName, unsigned long int randomSeedOffset, const EventContext& ctx) const;
  CLHEP::HepRandomEngine* getRandomEngineDuringInitialize(const std::string& streamName, unsigned long int randomSeedOffset, unsigned int conditionsRun=1, unsigned int lbn=1) const;

  IntegerProperty m_randomSeed{this, "RandomSeed", 1234567, "Random seed for the built-in random engine"}; // FIXME make this into an unsigned long int?

  BooleanProperty m_isAfterburner{this, "IsAfterburner", false, "Set true if generator modifies existing events rather than creating new ones"};

  std::shared_ptr<HepMC3::GenRunInfo> m_runinfo{};
 
private:


  // Random number service
  ServiceHandle<IAthRNGSvc> m_rndmSvc{this, "RndmSvc", "AthRNGSvc"};
  ServiceHandle<IIncidentSvc> m_incidentSvc{this, "IncidentSvc", "IncidentSvc"};
 
};
 
 
#endif