ATLAS Offline Software
Loading...
Searching...
No Matches
GeneratorInfoSvc Class Reference

Service holding generator metadata for event generation. More...

#include <GeneratorInfoSvc.h>

Inheritance diagram for GeneratorInfoSvc:
Collaboration diagram for GeneratorInfoSvc:

Public Member Functions

 GeneratorInfoSvc (const std::string &name, ISvcLocator *svcLoc)
 Standard service constructor.
virtual StatusCode initialize () override
 Initialize the service.
MsgStream & msg () const
bool msgLvl (const MSG::Level lvl) const

Protected Attributes

StringArrayProperty m_generators {this, "Generators", {}, "List of generators run", "OrderedSet<std::string>"}
 List of generators that were run.
StringProperty m_tune {this, "Tune", "", "Tune used"}
 Generator tune used for event generation.

Detailed Description

Service holding generator metadata for event generation.

This service stores metadata related to Monte Carlo event generation, such as the list of generators used and the generator tune.

Historically, this information was stored in the global object created from EvgenConfig.py, which is no longer available in the ComponentAccumulator-based configuration. GeneratorInfoSvc replaces that functionality.

Definition at line 24 of file GeneratorInfoSvc.h.

Constructor & Destructor Documentation

◆ GeneratorInfoSvc()

GeneratorInfoSvc::GeneratorInfoSvc ( const std::string & name,
ISvcLocator * svcLoc )

Standard service constructor.

Parameters
nameName of the service
svcLocPointer to the service locator

Definition at line 5 of file GeneratorInfoSvc.cxx.

6 : AthService(name, svcLoc)
7{
8}

Member Function Documentation

◆ initialize()

StatusCode GeneratorInfoSvc::initialize ( )
overridevirtual

Initialize the service.

Called by the framework during initialization.

Definition at line 10 of file GeneratorInfoSvc.cxx.

10 {
11 return StatusCode::SUCCESS;
12}

◆ msg()

MsgStream & AthCommonMsg< Service >::msg ( ) const
inlineinherited

Definition at line 24 of file AthCommonMsg.h.

24 {
25 return this->msgStream();
26 }

◆ msgLvl()

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

Definition at line 30 of file AthCommonMsg.h.

30 {
31 return this->msgLevel(lvl);
32 }

Member Data Documentation

◆ m_generators

StringArrayProperty GeneratorInfoSvc::m_generators {this, "Generators", {}, "List of generators run", "OrderedSet<std::string>"}
protected

List of generators that were run.

This property is typically populated by base generator configuration fragments e.g. Pythia8Config.py.

Definition at line 47 of file GeneratorInfoSvc.h.

47{this, "Generators", {}, "List of generators run", "OrderedSet<std::string>"};

◆ m_tune

StringProperty GeneratorInfoSvc::m_tune {this, "Tune", "", "Tune used"}
protected

Generator tune used for event generation.

Definition at line 51 of file GeneratorInfoSvc.h.

51{this, "Tune", "", "Tune used"};

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