Base class for common behaviour of generator interfaces. More...

#include <GenModule.h>

Inherited by BeamHaloGeneratorAlg, CosmicGenerator, Epos, Herwig7, Hijing, Hydjet, MultiParticleGunPileup, ParticleDecayer, Pythia8_i, Sherpa_i, Starlight_i, and TrackRecordGenerator.

Collaboration diagram for GenModule:

Public Member Functions
virtual StatusCode	sysInitialize () override
	Override sysInitialize. More...

virtual const DataObjIDColl &	extraOutputDeps () const override
	Return the list of extra output dependencies. More...

ServiceHandle< StoreGateSvc > &	evtStore ()
	The standard `StoreGateSvc` (event store) Returns (kind of) a pointer to the `StoreGateSvc`. More...

const ServiceHandle< StoreGateSvc > &	evtStore () const
	The standard `StoreGateSvc` (event store) Returns (kind of) a pointer to the `StoreGateSvc`. More...

const ServiceHandle< StoreGateSvc > &	detStore () const
	The standard `StoreGateSvc/DetectorStore` Returns (kind of) a pointer to the `StoreGateSvc`. More...

virtual StatusCode	sysStart () override
	Handle START transition. More...

virtual std::vector< Gaudi::DataHandle * >	inputHandles () const override
	Return this algorithm's input handles. More...

virtual std::vector< Gaudi::DataHandle * >	outputHandles () const override
	Return this algorithm's output handles. More...

Gaudi::Details::PropertyBase &	declareProperty (Gaudi::Property< T > &t)

Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, SG::VarHandleKey &hndl, const std::string &doc, const SG::VarHandleKeyType &)
	Declare a new Gaudi property. More...

Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, SG::VarHandleBase &hndl, const std::string &doc, const SG::VarHandleType &)
	Declare a new Gaudi property. More...

Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, SG::VarHandleKeyArray &hndArr, const std::string &doc, const SG::VarHandleKeyArrayType &)

Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, T &property, const std::string &doc, const SG::NotHandleType &)
	Declare a new Gaudi property. More...

Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, T &property, const std::string &doc="none")
	Declare a new Gaudi property. More...

void	updateVHKA (Gaudi::Details::PropertyBase &)

MsgStream &	msg () const

MsgStream &	msg (const MSG::Level lvl) const

bool	msgLvl (const MSG::Level lvl) const

Construction/destruction
	GenModule (const std::string &name, ISvcLocator *pSvcLocator)
	Constructor. More...

virtual	~GenModule ()
	Virtual destructor. More...

Protected Member Functions
void	renounceArray (SG::VarHandleKeyArray &handlesArray)
	remove all handles from I/O resolution More...

std::enable_if_t< std::is_void_v< std::result_of_t< decltype(&T::renounce)(T)> > &&!std::is_base_of_v< SG::VarHandleKeyArray, T > &&std::is_base_of_v< Gaudi::DataHandle, T >, void >	renounce (T &h)

void	extraDeps_update_handler (Gaudi::Details::PropertyBase &ExtraDeps)
	Add StoreName to extra input/output deps as needed. More...

Private Types
typedef ServiceHandle< StoreGateSvc >	StoreGateSvc_t

Private Member Functions
Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T > &hndl, const SG::VarHandleKeyType &)
	specialization for handling Gaudi::Property<SG::VarHandleKey> More...

Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T > &hndl, const SG::VarHandleKeyArrayType &)
	specialization for handling Gaudi::Property<SG::VarHandleKeyArray> More...

Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T > &hndl, const SG::VarHandleType &)
	specialization for handling Gaudi::Property<SG::VarHandleBase> More...

Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T > &t, const SG::NotHandleType &)
	specialization for handling everything that's not a Gaudi::Property<SG::VarHandleKey> or a <SG::VarHandleKeyArray> More...

Private Attributes
DataObjIDColl	m_extendedExtraObjects

StoreGateSvc_t	m_evtStore
	Pointer to StoreGate (event store by default) More...

StoreGateSvc_t	m_detStore
	Pointer to StoreGate (detector store by default) More...

std::vector< SG::VarHandleKeyArray * >	m_vhka

bool	m_varHandleArraysDeclared

Utility event-mangling functions
Todo: Replace with HepMC units when available
ServiceHandle< IPartPropSvc >	m_ppSvc {this, "PartPropSvc", "PartPropSvc"}
	Handle on the particle property service. More...

SG::ReadHandleKey< McEventCollection >	m_mcevents_const { this, "McEventKey", "GEN_EVENT", "StoreGate key of the MC event collection" }
	Const handle to the MC event collection. More...

void	GeVToMeV (HepMC::GenEvent *evt)
	Scale event energies/momenta by x 1000. More...

void	MeVToGeV (HepMC::GenEvent *evt)
	Scale event energies/momenta by x 1/1000. More...

void	cmTomm (HepMC::GenEvent *evt)
	Scale event lengths by x 10. More...

void	mmTocm (HepMC::GenEvent *evt)
	Scale event lengths by x 1/10. More...

Gen-specific event loop methods: to be overloaded
virtual StatusCode	genInitialize ()
	For initializing the generator, if required. More...

virtual StatusCode	genuserInitialize ()
	For initialization of user code, if required. Called after genInitialize. More...

virtual StatusCode	callGenerator ()
	For calling the generator on each iteration of the event loop. More...

virtual StatusCode	fillEvt (HepMC::GenEvent *evt)=0
	For filling the HepMC event object. More...

virtual StatusCode	genFinalize ()
	For finalising the generator, if required. More...

Features for derived classes to use internally
IntegerProperty	m_randomSeed {this, "RandomSeed", 1234567, "Random seed for the built-in random engine"}
	Seed for random number engine. More...

BooleanProperty	m_isAfterburner {this, "IsAfterburner", false, "Set true if generator modifies existing events rather than creating new ones"}
	Flag for normal vs. afterburner generators. More...

ServiceHandle< IAthRNGSvc >	m_rndmSvc {this, "RndmSvc", "AthRNGSvc"}
	Data members. More...

ServiceHandle< IIncidentSvc >	m_incidentSvc {this, "IncidentSvc", "IncidentSvc"}
	Handle on the incident service. More...

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

Detailed Description

Base class for common behaviour of generator interfaces.

This class is the base class used to specify the behavior of all event generator interface packages. It inherits the GenBase (and hence AthAlgorithm) interfaces.

The common behavior currently consists of:

Providing access to the ATLAS random number generator service
Creating the McEvent and if necessary the McEventCollection

The following virtual methods should be overloaded in the child class:

StatusCode genInitialize() StatusCode callGenerator() StatusCode genFinalize() StatusCode fillEvt(GeneratorEvent* evt)

Author: M. Shapiro: Initial code, March 2000; A. Buckley: Update to AthAlgorithm etc., November 2009 General interface/implementation improvements, Jan/Feb 2010 Removing stripPartons and multiple event mechanisms and rebasing on GenBase, Nov 2013

Definition at line 39 of file GenModule.h.

Member Typedef Documentation

◆ StoreGateSvc_t

typedef ServiceHandle<StoreGateSvc> AthCommonDataStore< AthCommonMsg< Algorithm > >::StoreGateSvc_t

privateinherited

Definition at line 388 of file AthCommonDataStore.h.

Constructor & Destructor Documentation

◆ GenModule()

GenModule::GenModule	(	const std::string &	name,
		ISvcLocator *	pSvcLocator
	)

Constructor.

Definition at line 14 of file GenModule.cxx.

   : GenBase(name, pSvcLocator)
 {
   m_mkMcEvent = true;
 }

◆ ~GenModule()

virtual GenModule::~GenModule ( )

inlinevirtual

Virtual destructor.

Definition at line 47 of file GenModule.h.

47 { }

Member Function Documentation

◆ ATLAS_NOT_CONST_THREAD_SAFE() [1/2]

HepMC::GenEvent* event GenBase::ATLAS_NOT_CONST_THREAD_SAFE ( )

inlineinherited

Access the current signal event (first in the McEventCollection)

Note: This function will make a new McEventCollection if there is not already a valid one and MakeMcEvent=True.

Definition at line 76 of file GenBase.h.

                                                       {
     if (events()->empty())
       ATH_MSG_ERROR("McEventCollection is empty during first event access");
     return *(events()->begin());
   }

◆ ATLAS_NOT_CONST_THREAD_SAFE() [2/2]

McEventCollection* events GenBase::ATLAS_NOT_CONST_THREAD_SAFE ( )

inherited

Access the current event's McEventCollection.

Note: This function will make a new McEventCollection if there is not already a valid one and MakeMcEvent=True.

◆ callGenerator()

virtual StatusCode GenModule::callGenerator ( )

inlinevirtual

For calling the generator on each iteration of the event loop.

Reimplemented in Hijing, Herwig7, CosmicGenerator, Pythia8_i, Hydjet, BeamHaloGeneratorAlg, Starlight_i, Epos, MultiParticleGunPileup, MultiPy8Pileup, TrackRecordGenerator, Pythia8B_i, and Sherpa_i.

Definition at line 66 of file GenModule.h.

66 { return StatusCode::SUCCESS; }

◆ cmTomm()

void GenBase::cmTomm ( HepMC::GenEvent * evt )

protectedinherited

Scale event lengths by x 10.

Definition at line 81 of file GenBase.cxx.

                                        {
   for (HepMC::GenEvent::vertex_iterator vtx = evt->vertices_begin(); vtx != evt->vertices_end(); ++vtx) {
     const HepMC::FourVector fv((*vtx)->position().x() * 10,
                                (*vtx)->position().y() * 10,
                                (*vtx)->position().z() * 10,
                                (*vtx)->position().t() * 10);
     (*vtx)->set_position(fv);
   }
 }

◆ declareGaudiProperty() [1/4]

Gaudi::Details::PropertyBase& AthCommonDataStore< AthCommonMsg< Algorithm > >::declareGaudiProperty	(	Gaudi::Property< T > &	hndl,
		const SG::VarHandleKeyArrayType &
	)

inlineprivateinherited

specialization for handling Gaudi::Property<SG::VarHandleKeyArray>

Definition at line 170 of file AthCommonDataStore.h.

   {
     return *AthCommonDataStore<PBASE>::declareProperty(hndl.name(),
                                                        hndl.value(), 
                                                        hndl.documentation());
  
   }

◆ declareGaudiProperty() [2/4]

Gaudi::Details::PropertyBase& AthCommonDataStore< AthCommonMsg< Algorithm > >::declareGaudiProperty	(	Gaudi::Property< T > &	hndl,
		const SG::VarHandleKeyType &
	)

inlineprivateinherited

specialization for handling Gaudi::Property<SG::VarHandleKey>

Definition at line 156 of file AthCommonDataStore.h.

   {
     return *AthCommonDataStore<PBASE>::declareProperty(hndl.name(),
                                                        hndl.value(), 
                                                        hndl.documentation());
  
   }

◆ declareGaudiProperty() [3/4]

Gaudi::Details::PropertyBase& AthCommonDataStore< AthCommonMsg< Algorithm > >::declareGaudiProperty	(	Gaudi::Property< T > &	hndl,
		const SG::VarHandleType &
	)

inlineprivateinherited

specialization for handling Gaudi::Property<SG::VarHandleBase>

Definition at line 184 of file AthCommonDataStore.h.

   {
     return *AthCommonDataStore<PBASE>::declareProperty(hndl.name(),
                                                        hndl.value(), 
                                                        hndl.documentation());
   }

◆ declareGaudiProperty() [4/4]

Gaudi::Details::PropertyBase& AthCommonDataStore< AthCommonMsg< Algorithm > >::declareGaudiProperty	(	Gaudi::Property< T > &	t,
		const SG::NotHandleType &
	)

inlineprivateinherited

specialization for handling everything that's not a Gaudi::Property<SG::VarHandleKey> or a <SG::VarHandleKeyArray>

Definition at line 199 of file AthCommonDataStore.h.

   {
     return PBASE::declareProperty(t);
   }

◆ declareProperty() [1/6]

Gaudi::Details::PropertyBase* AthCommonDataStore< AthCommonMsg< Algorithm > >::declareProperty	(	const std::string &	name,
		SG::VarHandleBase &	hndl,
		const std::string &	doc,
		const SG::VarHandleType &
	)

inlineinherited

Declare a new Gaudi property.

Parameters

name	Name of the property.
hndl	Object holding the property value.
doc	Documentation string for the property.

This is the version for types that derive from SG::VarHandleBase. The property value object is put on the input and output lists as appropriate; then we forward to the base class.

Definition at line 245 of file AthCommonDataStore.h.

   {
     this->declare(hndl.vhKey());
     hndl.vhKey().setOwner(this);
  
     return PBASE::declareProperty(name,hndl,doc);
   }

◆ declareProperty() [2/6]

Gaudi::Details::PropertyBase* AthCommonDataStore< AthCommonMsg< Algorithm > >::declareProperty	(	const std::string &	name,
		SG::VarHandleKey &	hndl,
		const std::string &	doc,
		const SG::VarHandleKeyType &
	)

inlineinherited

Declare a new Gaudi property.

Parameters

name	Name of the property.
hndl	Object holding the property value.
doc	Documentation string for the property.

This is the version for types that derive from SG::VarHandleKey. The property value object is put on the input and output lists as appropriate; then we forward to the base class.

Definition at line 221 of file AthCommonDataStore.h.

   {
     this->declare(hndl);
     hndl.setOwner(this);
  
     return PBASE::declareProperty(name,hndl,doc);
   }

◆ declareProperty() [3/6]

Gaudi::Details::PropertyBase* AthCommonDataStore< AthCommonMsg< Algorithm > >::declareProperty	(	const std::string &	name,
		SG::VarHandleKeyArray &	hndArr,
		const std::string &	doc,
		const SG::VarHandleKeyArrayType &
	)

inlineinherited

Definition at line 259 of file AthCommonDataStore.h.

   {
  
     // std::ostringstream ost;
     // ost << Algorithm::name() << " VHKA declareProp: " << name 
     //     << " size: " << hndArr.keys().size() 
     //     << " mode: " << hndArr.mode() 
     //     << "  vhka size: " << m_vhka.size()
     //     << "\n";
     // debug() << ost.str() << endmsg;
  
     hndArr.setOwner(this);
     m_vhka.push_back(&hndArr);
  
     Gaudi::Details::PropertyBase* p =  PBASE::declareProperty(name, hndArr, doc);
     if (p != 0) {
       p->declareUpdateHandler(&AthCommonDataStore<PBASE>::updateVHKA, this);
     } else {
       ATH_MSG_ERROR("unable to call declareProperty on VarHandleKeyArray " 
                     << name);
     }
  
     return p;
  
   }

◆ declareProperty() [4/6]

Gaudi::Details::PropertyBase* AthCommonDataStore< AthCommonMsg< Algorithm > >::declareProperty	(	const std::string &	name,
		T &	property,
		const std::string &	doc,
		const SG::NotHandleType &
	)

inlineinherited

Declare a new Gaudi property.

Parameters

name	Name of the property.
property	Object holding the property value.
doc	Documentation string for the property.

This is the generic version, for types that do not derive from SG::VarHandleKey. It just forwards to the base class version of declareProperty.

Definition at line 333 of file AthCommonDataStore.h.

   {
     return PBASE::declareProperty(name, property, doc);
   }

◆ declareProperty() [5/6]

Gaudi::Details::PropertyBase* AthCommonDataStore< AthCommonMsg< Algorithm > >::declareProperty	(	const std::string &	name,
		T &	property,
		const std::string &	doc = `"none"`
	)

inlineinherited

Declare a new Gaudi property.

Parameters

name	Name of the property.
property	Object holding the property value.
doc	Documentation string for the property.

This dispatches to either the generic declareProperty or the one for VarHandle/Key/KeyArray.

Definition at line 352 of file AthCommonDataStore.h.

   {
     typedef typename SG::HandleClassifier<T>::type htype;
     return declareProperty (name, property, doc, htype());
   }

◆ declareProperty() [6/6]

Gaudi::Details::PropertyBase& AthCommonDataStore< AthCommonMsg< Algorithm > >::declareProperty ( Gaudi::Property< T > & t )

inlineinherited

Definition at line 145 of file AthCommonDataStore.h.

                                                                  {
     typedef typename SG::HandleClassifier<T>::type htype;
     return AthCommonDataStore<PBASE>::declareGaudiProperty(t, htype());
   }

◆ detStore()

const ServiceHandle<StoreGateSvc>& AthCommonDataStore< AthCommonMsg< Algorithm > >::detStore ( ) const

inlineinherited

The standard StoreGateSvc/DetectorStore Returns (kind of) a pointer to the StoreGateSvc.

Definition at line 95 of file AthCommonDataStore.h.

95 { return m_detStore; }

◆ event_const()

const HepMC::GenEvent* GenBase::event_const ( ) const

inlineinherited

Access the current signal event (const)

Definition at line 83 of file GenBase.h.

                                            {
     if (events_const()->empty())
       ATH_MSG_ERROR("Const McEventCollection is empty during first event access");
     return *(events_const()->begin());
   }

◆ events_const() [1/2]

const McEventCollection* GenBase::events_const ( ) const

inlineinherited

Access the current event's McEventCollection (const)

Definition at line 96 of file GenBase.h.

                                                 {
     return events_const( getContext() );
   }

◆ events_const() [2/2]

const McEventCollection* GenBase::events_const ( const EventContext & ctx ) const

inlineinherited

Definition at line 99 of file GenBase.h.

                                                                          {
     SG::ReadHandle<McEventCollection> ret = SG::makeHandle(m_mcevents_const, ctx);
     if (!ret.isValid())
       ATH_MSG_ERROR("No McEventCollection found in StoreGate with key " << m_mcevents_const.key());
     return ret.cptr();
   }

◆ evtStore() [1/2]

ServiceHandle<StoreGateSvc>& AthCommonDataStore< AthCommonMsg< Algorithm > >::evtStore ( )

inlineinherited

The standard StoreGateSvc (event store) Returns (kind of) a pointer to the StoreGateSvc.

Definition at line 85 of file AthCommonDataStore.h.

85 { return m_evtStore; }

◆ evtStore() [2/2]

const ServiceHandle<StoreGateSvc>& AthCommonDataStore< AthCommonMsg< Algorithm > >::evtStore ( ) const

inlineinherited

The standard StoreGateSvc (event store) Returns (kind of) a pointer to the StoreGateSvc.

Definition at line 90 of file AthCommonDataStore.h.

90 { return m_evtStore; }

◆ execute()

StatusCode GenModule::execute ( )

virtual

Todo:: Remove hard-coded alg name checking (already incomplete)

Reimplemented from GenBase.

Definition at line 70 of file GenModule.cxx.

                               {
   // Examples of how to retrieve the random number engine for a given
   // stream.
   // NB getRandomEngine should only be called once per event for a
   // given stream, as it causes the stream to be re-seeded each time
   // it is called.
  
   // Example 1 - seeded based on the current event number (+ slot, run, streamName)
   //const EventContext& ctx = Gaudi::Hive::currentContext();
   //CLHEP::HepRandomEngine* rndmEngine = this->getRandomEngine("MyStream", ctx);
  
   // Example 2 - seeded based on the m_randomSeed property (+ slot, run, streamName)
   //const EventContext& ctx = Gaudi::Hive::currentContext();
   //CLHEP::HepRandomEngine* rndmEngine = this->getRandomEngine("MyStream", m_randomSeed.value(), ctx);
  
   // Call the code that generates an event
   CHECK(this->callGenerator());
  
   // Create the MC event and send the GeneratorEvent stored in it to fillEvt
   HepMC::GenEvent* evt = HepMC::newGenEvent(1,1);
   CHECK(this->fillEvt(evt));
   HepMC::fillBarcodesAttribute(evt);
  
   // Add the event to the MC event collection
   if (events()) {
     // If this is an "afterburner" generator, replace the last event rather than add a new one
     if (m_isAfterburner.value() || name() == "Tauola" || name() == "Photos") {
       events()->pop_back();
     }
     // Add the event to the end of the collection
     events()->push_back(evt);
     ATH_MSG_DEBUG("MC event added to McEventCollection");
  
     // remove the empty event in case of ParticleDecayer
     if (name() == "ParticleDecayer") {
       events()->pop_back();
     }
   }
  
   // Call the incident service to notify that an event has been made
   m_incidentSvc->fireIncident( Incident(name(), "McEventGenerated") );
   return StatusCode::SUCCESS;
 }

◆ extraDeps_update_handler()

void AthCommonDataStore< AthCommonMsg< Algorithm > >::extraDeps_update_handler ( Gaudi::Details::PropertyBase & ExtraDeps )

protectedinherited

Add StoreName to extra input/output deps as needed.

use the logic of the VarHandleKey to parse the DataObjID keys supplied via the ExtraInputs and ExtraOuputs Properties to add the StoreName if it's not explicitly given

◆ extraOutputDeps()

const DataObjIDColl & AthAlgorithm::extraOutputDeps ( ) const

overridevirtualinherited

Return the list of extra output dependencies.

This list is extended to include symlinks implied by inheritance relations.

Definition at line 50 of file AthAlgorithm.cxx.

 {
   // If we didn't find any symlinks to add, just return the collection
   // from the base class.  Otherwise, return the extended collection.
   if (!m_extendedExtraObjects.empty()) {
     return m_extendedExtraObjects;
   }
   return Algorithm::extraOutputDeps();
 }

◆ fillEvt()

virtual StatusCode GenModule::fillEvt ( HepMC::GenEvent * evt )

pure virtual

For filling the HepMC event object.

Implemented in Hijing, Herwig7, CosmicGenerator, Pythia8_i, Hydjet, BeamHaloGeneratorAlg, Starlight_i, Epos, TrackRecordGenerator, Sherpa_i, MultiParticleGunPileup, MultiPy8Pileup, ParticleDecayer, and Pythia8B_i.

◆ finalize()

StatusCode GenModule::finalize ( )

inline

Definition at line 55 of file GenModule.h.

55 { return genFinalize(); }

◆ genFinalize()

virtual StatusCode GenModule::genFinalize ( )

inlinevirtual

For finalising the generator, if required.

Reimplemented in Hijing, Herwig7, CosmicGenerator, Pythia8_i, Hydjet, Starlight_i, Epos, BeamHaloGeneratorAlg, MultiParticleGunPileup, MultiPy8Pileup, Pythia8B_i, and Sherpa_i.

Definition at line 70 of file GenModule.h.

70 { return StatusCode::SUCCESS; }

◆ genInitialize()

virtual StatusCode GenModule::genInitialize ( )

inlinevirtual

For initializing the generator, if required.

Reimplemented in Hijing, Herwig7, CosmicGenerator, Pythia8_i, Hydjet, Starlight_i, ParticleDecayer, Epos, BeamHaloGeneratorAlg, MultiParticleGunPileup, MultiPy8Pileup, Pythia8B_i, and Sherpa_i.

Definition at line 62 of file GenModule.h.

62 { return StatusCode::SUCCESS; }

◆ genuserInitialize()

virtual StatusCode GenModule::genuserInitialize ( )

inlinevirtual

For initialization of user code, if required. Called after genInitialize.

Reimplemented in Pythia8B_i.

Definition at line 64 of file GenModule.h.

64 { return StatusCode::SUCCESS; }

◆ getRandomEngine() [1/2]

CLHEP::HepRandomEngine * GenModule::getRandomEngine	(	const std::string &	streamName,
		const EventContext &	ctx
	)		const

protected

Definition at line 34 of file GenModule.cxx.

 {
   ATHRNG::RNGWrapper* rngWrapper = m_rndmSvc->getEngine(this, streamName);
   std::string rngName = name()+streamName;
   rngWrapper->setSeed( rngName, ctx );
   return rngWrapper->getEngine(ctx);
 }

◆ getRandomEngine() [2/2]

CLHEP::HepRandomEngine * GenModule::getRandomEngine	(	const std::string &	streamName,
		unsigned long int	randomSeedOffset,
		const EventContext &	ctx
	)		const

protected

Definition at line 44 of file GenModule.cxx.

 {
   ATHRNG::RNGWrapper* rngWrapper = m_rndmSvc->getEngine(this, streamName);
   rngWrapper->setSeed( streamName, ctx.slot(), randomSeedOffset, ctx.eventID().run_number() );
   return rngWrapper->getEngine(ctx);
 }

◆ getRandomEngineDuringInitialize()

CLHEP::HepRandomEngine * GenModule::getRandomEngineDuringInitialize	(	const std::string &	streamName,
		unsigned long int	randomSeedOffset,
		unsigned int	conditionsRun = `1`,
		unsigned int	lbn = `1`
	)		const

protected

Definition at line 53 of file GenModule.cxx.

 {
   const size_t slot=0;
   EventContext ctx;
   ctx.setSlot( slot );
   ctx.setEventID (EventIDBase (conditionsRun,
                EventIDBase::UNDEFEVT,  // event
                EventIDBase::UNDEFNUM,  // timestamp
                EventIDBase::UNDEFNUM,  // timestamp ns
                lbn));
   Atlas::setExtendedEventContext(ctx,
                                  Atlas::ExtendedEventContext( evtStore()->hiveProxyDict(),
                                                               conditionsRun) );
   return getRandomEngine(streamName, randomSeedOffset, ctx);
 }

◆ GeVToMeV()

void GenBase::GeVToMeV ( HepMC::GenEvent * evt )

protectedinherited

Scale event energies/momenta by x 1000.

Todo:: Add HepMC units awareness and do it differently when HepMC provides this functionality directly (and reference-based FourVector accessors)

Definition at line 61 of file GenBase.cxx.

                                          {
   for (HepMC::GenEvent::particle_iterator p = evt->particles_begin(); p != evt->particles_end(); ++p) {
     const HepMC::FourVector fv((*p)->momentum().px() * 1000,
                                (*p)->momentum().py() * 1000,
                                (*p)->momentum().pz() * 1000,
                                (*p)->momentum().e()  * 1000);
     (*p)->set_momentum(fv);
     (*p)->set_generated_mass(1000 * (*p)->generated_mass());
   }
 }

◆ initialize()

StatusCode GenModule::initialize ( )

virtual

Reimplemented from GenBase.

Definition at line 21 of file GenModule.cxx.

                                  {
   // Base class initializations
   CHECK(GenBase::initialize());
   // Get the random number service
   CHECK(m_rndmSvc.retrieve());
   // Get the incident service
   CHECK(m_incidentSvc.retrieve());
   CHECK(genInitialize());
   CHECK(genuserInitialize());
   return StatusCode::SUCCESS;
 }

◆ inputHandles()

virtual std::vector<Gaudi::DataHandle*> AthCommonDataStore< AthCommonMsg< Algorithm > >::inputHandles ( ) const

overridevirtualinherited

Return this algorithm's input handles.

We override this to include handle instances from key arrays if they have not yet been declared. See comments on updateVHKA.

◆ MeVToGeV()

void GenBase::MeVToGeV ( HepMC::GenEvent * evt )

protectedinherited

Scale event energies/momenta by x 1/1000.

Definition at line 71 of file GenBase.cxx.

                                          {
   for (HepMC::GenEvent::particle_iterator p = evt->particles_begin(); p != evt->particles_end(); ++p) {
     const HepMC::FourVector fv((*p)->momentum().px() / 1000,
                                (*p)->momentum().py() / 1000,
                                (*p)->momentum().pz() / 1000,
                                (*p)->momentum().e()  / 1000);
     (*p)->set_momentum(fv);
     (*p)->set_generated_mass((*p)->generated_mass() / 1000);
   }
 }

◆ mmTocm()

void GenBase::mmTocm ( HepMC::GenEvent * evt )

protectedinherited

Scale event lengths by x 1/10.

Definition at line 90 of file GenBase.cxx.

                                        {
   for (HepMC::GenEvent::vertex_iterator vtx = evt->vertices_begin(); vtx != evt->vertices_end(); ++vtx) {
     const HepMC::FourVector fv((*vtx)->position().x() / 10,
                                (*vtx)->position().y() / 10,
                                (*vtx)->position().z() / 10,
                                (*vtx)->position().t() / 10);
     (*vtx)->set_position(fv);
   }
 }

◆ msg() [1/2]

MsgStream& AthCommonMsg< Algorithm >::msg ( ) const

inlineinherited

Definition at line 24 of file AthCommonMsg.h.

                                 {
     return this->msgStream();
   }

◆ msg() [2/2]

MsgStream& AthCommonMsg< Algorithm >::msg ( const MSG::Level lvl ) const

inlineinherited

Definition at line 27 of file AthCommonMsg.h.

                                                   {
     return this->msgStream(lvl);
   }

◆ msgLvl()

bool AthCommonMsg< Algorithm >::msgLvl ( const MSG::Level lvl ) const

inlineinherited

Definition at line 30 of file AthCommonMsg.h.

                                                {
     return this->msgLevel(lvl);
   }

◆ outputHandles()

virtual std::vector<Gaudi::DataHandle*> AthCommonDataStore< AthCommonMsg< Algorithm > >::outputHandles ( ) const

overridevirtualinherited

Return this algorithm's output handles.

We override this to include handle instances from key arrays if they have not yet been declared. See comments on updateVHKA.

◆ particleData()

const HepPDT::ParticleData* GenBase::particleData ( int pid ) const

inlineinherited

Access an element in the particle data table.

Definition at line 126 of file GenBase.h.

                                                         {
     return pdt().particle(HepPDT::ParticleID(std::abs(pid)));
   }

◆ particleTable()

const HepPDT::ParticleDataTable& GenBase::particleTable ( ) const

inlineinherited

Get a particle data table.

Definition at line 118 of file GenBase.h.

                                                        {
     return *(m_ppSvc->PDT());
   }

◆ partPropSvc()

const ServiceHandle<IPartPropSvc> GenBase::partPropSvc ( ) const

inlineinherited

Access the particle property service.

Definition at line 113 of file GenBase.h.

                                                         {
     return m_ppSvc;
   }

◆ pdt()

const HepPDT::ParticleDataTable& GenBase::pdt ( ) const

inlineinherited

Shorter alias to get a particle data table.

Definition at line 123 of file GenBase.h.

123 { return particleTable(); }

◆ renounce()

std::enable_if_t<std::is_void_v<std::result_of_t<decltype(&T::renounce)(T)> > && !std::is_base_of_v<SG::VarHandleKeyArray, T> && std::is_base_of_v<Gaudi::DataHandle, T>, void> AthCommonDataStore< AthCommonMsg< Algorithm > >::renounce ( T & h )

inlineprotectedinherited

Definition at line 380 of file AthCommonDataStore.h.

   {
     h.renounce();
     PBASE::renounce (h);
   }

◆ renounceArray()

void AthCommonDataStore< AthCommonMsg< Algorithm > >::renounceArray ( SG::VarHandleKeyArray & handlesArray )

inlineprotectedinherited

remove all handles from I/O resolution

Definition at line 364 of file AthCommonDataStore.h.

                                                           {
     handlesArray.renounce();
   }

◆ sysInitialize()

StatusCode AthAlgorithm::sysInitialize ( )

overridevirtualinherited

Override sysInitialize.

Override sysInitialize from the base class.

Loop through all output handles, and if they're WriteCondHandles, automatically register them and this Algorithm with the CondSvc

Scan through all outputHandles, and if they're WriteCondHandles, register them with the CondSvc

Reimplemented from AthCommonDataStore< AthCommonMsg< Algorithm > >.

Reimplemented in AthAnalysisAlgorithm, AthFilterAlgorithm, PyAthena::Alg, and AthHistogramAlgorithm.

Definition at line 66 of file AthAlgorithm.cxx.

                                        {
   StatusCode sc=AthCommonDataStore<AthCommonMsg<Algorithm>>::sysInitialize();
  
   if (sc.isFailure()) {
     return sc;
   }
   ServiceHandle<ICondSvc> cs("CondSvc",name());
   for (auto h : outputHandles()) {
     if (h->isCondition() && h->mode() == Gaudi::DataHandle::Writer) {
       // do this inside the loop so we don't create the CondSvc until needed
       if ( cs.retrieve().isFailure() ) {
         ATH_MSG_WARNING("no CondSvc found: won't autoreg WriteCondHandles");
         return StatusCode::SUCCESS;
       }
       if (cs->regHandle(this,*h).isFailure()) {
         sc = StatusCode::FAILURE;
         ATH_MSG_ERROR("unable to register WriteCondHandle " << h->fullKey()
                       << " with CondSvc");
       }
     }
   }
   return sc;
 }

◆ sysStart()

virtual StatusCode AthCommonDataStore< AthCommonMsg< Algorithm > >::sysStart ( )

overridevirtualinherited

Handle START transition.

We override this in order to make sure that conditions handle keys can cache a pointer to the conditions container.

◆ updateVHKA()

void AthCommonDataStore< AthCommonMsg< Algorithm > >::updateVHKA ( Gaudi::Details::PropertyBase & )

inlineinherited

Definition at line 308 of file AthCommonDataStore.h.

                                                {
     // debug() << "updateVHKA for property " << p.name() << " " << p.toString() 
     //         << "  size: " << m_vhka.size() << endmsg;
     for (auto &a : m_vhka) {
       std::vector<SG::VarHandleKey*> keys = a->keys();
       for (auto k : keys) {
         k->setOwner(this);
       }
     }
   }

Member Data Documentation

◆ m_detStore

StoreGateSvc_t AthCommonDataStore< AthCommonMsg< Algorithm > >::m_detStore

privateinherited

Pointer to StoreGate (detector store by default)

Definition at line 393 of file AthCommonDataStore.h.

◆ m_evtStore

StoreGateSvc_t AthCommonDataStore< AthCommonMsg< Algorithm > >::m_evtStore

privateinherited

Pointer to StoreGate (event store by default)

Definition at line 390 of file AthCommonDataStore.h.

◆ m_extendedExtraObjects

DataObjIDColl AthAlgorithm::m_extendedExtraObjects

privateinherited

Definition at line 79 of file AthAlgorithm.h.

◆ m_incidentSvc

ServiceHandle<IIncidentSvc> GenModule::m_incidentSvc {this, "IncidentSvc", "IncidentSvc"}

private

Handle on the incident service.

Definition at line 101 of file GenModule.h.

◆ m_isAfterburner

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

protected

Flag for normal vs. afterburner generators.

Definition at line 87 of file GenModule.h.

◆ m_mcEventKey

std::string GenBase::m_mcEventKey {}

protectedinherited

StoreGate key for the MC event collection (defaults to GEN_EVENT)

Definition at line 137 of file GenBase.h.

◆ m_mcevents_const

SG::ReadHandleKey<McEventCollection> GenBase::m_mcevents_const { this, "McEventKey", "GEN_EVENT", "StoreGate key of the MC event collection" }

privateinherited

Const handle to the MC event collection.

Definition at line 163 of file GenBase.h.

◆ m_mkMcEvent

BooleanProperty GenBase::m_mkMcEvent {this, "MakeMcEvent", false, "Create a new MC event collection if it doesn't exist"}

protectedinherited

Flag to determine if a new MC event collection should be made if it doesn't exist.

Definition at line 139 of file GenBase.h.

◆ m_ppSvc

ServiceHandle<IPartPropSvc> GenBase::m_ppSvc {this, "PartPropSvc", "PartPropSvc"}

privateinherited

Handle on the particle property service.

Definition at line 160 of file GenBase.h.

◆ m_randomSeed

IntegerProperty GenModule::m_randomSeed {this, "RandomSeed", 1234567, "Random seed for the built-in random engine"}

protected

Seed for random number engine.

Definition at line 84 of file GenModule.h.

◆ m_rndmSvc

ServiceHandle<IAthRNGSvc> GenModule::m_rndmSvc {this, "RndmSvc", "AthRNGSvc"}

private

Data members.

Definition at line 99 of file GenModule.h.

◆ m_varHandleArraysDeclared

bool AthCommonDataStore< AthCommonMsg< Algorithm > >::m_varHandleArraysDeclared

privateinherited

Definition at line 399 of file AthCommonDataStore.h.

◆ m_vhka

std::vector<SG::VarHandleKeyArray*> AthCommonDataStore< AthCommonMsg< Algorithm > >::m_vhka

privateinherited

Definition at line 398 of file AthCommonDataStore.h.

The documentation for this class was generated from the following files:

Public Member Functions

Protected Member Functions

Private Types

Private Member Functions

Private Attributes

Utility event-mangling functions

Gen-specific event loop methods: to be overloaded

Features for derived classes to use internally

Detailed Description

Member Typedef Documentation

◆ StoreGateSvc_t

Constructor & Destructor Documentation

◆ GenModule()

◆ ~GenModule()

Member Function Documentation

◆ ATLAS_NOT_CONST_THREAD_SAFE() [1/2]

◆ ATLAS_NOT_CONST_THREAD_SAFE() [2/2]

◆ callGenerator()

◆ cmTomm()

◆ declareGaudiProperty() [1/4]

◆ declareGaudiProperty() [2/4]

◆ declareGaudiProperty() [3/4]

◆ declareGaudiProperty() [4/4]

◆ declareProperty() [1/6]

◆ declareProperty() [2/6]

◆ declareProperty() [3/6]

◆ declareProperty() [4/6]

◆ declareProperty() [5/6]

◆ declareProperty() [6/6]

◆ detStore()

◆ event_const()

◆ events_const() [1/2]

◆ events_const() [2/2]

◆ evtStore() [1/2]

◆ evtStore() [2/2]

◆ execute()

◆ extraDeps_update_handler()

◆ extraOutputDeps()

◆ fillEvt()

◆ finalize()

◆ genFinalize()

◆ genInitialize()

◆ genuserInitialize()

◆ getRandomEngine() [1/2]

◆ getRandomEngine() [2/2]

◆ getRandomEngineDuringInitialize()

◆ GeVToMeV()

◆ initialize()

◆ inputHandles()

◆ MeVToGeV()

◆ mmTocm()

◆ msg() [1/2]

◆ msg() [2/2]

◆ msgLvl()

◆ outputHandles()

◆ particleData()

◆ particleTable()

◆ partPropSvc()

◆ pdt()

◆ renounce()

◆ renounceArray()

◆ sysInitialize()

◆ sysStart()

◆ updateVHKA()

Member Data Documentation

◆ m_detStore

◆ m_evtStore

◆ m_extendedExtraObjects

◆ m_incidentSvc

◆ m_isAfterburner

◆ m_mcEventKey

◆ m_mcevents_const

◆ m_mkMcEvent

◆ m_ppSvc

◆ m_randomSeed

◆ m_rndmSvc

◆ m_varHandleArraysDeclared

◆ m_vhka