Public Member Functions | Protected Member Functions | List of all members
genie::EventGeneratorI Class Referenceabstract

Defines the EventGeneratorI interface. More...

#include <EventGeneratorI.h>

Inheritance diagram for genie::EventGeneratorI:
genie::EventRecordVisitorI genie::Algorithm genie::EventGenerator

Public Member Functions

virtual ~EventGeneratorI ()
 
virtual const GVldContextValidityContext (void) const =0
 
virtual const InteractionListGeneratorIIntListGenerator (void) const =0
 
virtual const XSecAlgorithmICrossSectionAlg (void) const =0
 
- Public Member Functions inherited from genie::EventRecordVisitorI
virtual ~EventRecordVisitorI ()
 
virtual void ProcessEventRecord (GHepRecord *event_rec) const =0
 
- Public Member Functions inherited from genie::Algorithm
virtual ~Algorithm ()
 
virtual void Configure (const Registry &config)
 
virtual void Configure (string config)
 
virtual void FindConfig (void)
 
virtual const RegistryGetConfig (void) const
 
RegistryGetOwnedConfig (void)
 
virtual const AlgIdId (void) const
 Get algorithm ID. More...
 
virtual AlgStatus_t GetStatus (void) const
 Get algorithm status. More...
 
virtual bool AllowReconfig (void) const
 
virtual AlgCmp_t Compare (const Algorithm *alg) const
 Compare with input algorithm. More...
 
virtual void SetId (const AlgId &id)
 Set algorithm ID. More...
 
virtual void SetId (string name, string config)
 
const AlgorithmSubAlg (const RgKey &registry_key) const
 
void AdoptConfig (void)
 
void AdoptSubstructure (void)
 
virtual void Print (ostream &stream) const
 Print algorithm info. More...
 

Protected Member Functions

 EventGeneratorI ()
 
 EventGeneratorI (string name)
 
 EventGeneratorI (string name, string config)
 
- Protected Member Functions inherited from genie::EventRecordVisitorI
 EventRecordVisitorI ()
 
 EventRecordVisitorI (string name)
 
 EventRecordVisitorI (string name, string config)
 
- Protected Member Functions inherited from genie::Algorithm
 Algorithm ()
 
 Algorithm (string name)
 
 Algorithm (string name, string config)
 
void Initialize (void)
 
void DeleteConfig (void)
 
void DeleteSubstructure (void)
 
RegistryExtractLocalConfig (const Registry &in) const
 
RegistryExtractLowerConfig (const Registry &in, const string &alg_key) const
 Split an incoming configuration Registry into a block valid for the sub-algo identified by alg_key. More...
 
template<class T >
bool GetParam (const RgKey &name, T &p, bool is_top_call=true) const
 
template<class T >
bool GetParamDef (const RgKey &name, T &p, const T &def) const
 
template<class T >
int GetParamVect (const std::string &comm_name, std::vector< T > &v, bool is_top_call=true) const
 Handle to load vectors of parameters. More...
 
int GetParamVectKeys (const std::string &comm_name, std::vector< RgKey > &k, bool is_top_call=true) const
 
int AddTopRegistry (Registry *rp, bool owns=true)
 add registry with top priority, also update ownership More...
 
int AddLowRegistry (Registry *rp, bool owns=true)
 add registry with lowest priority, also update ownership More...
 
int MergeTopRegistry (const Registry &r)
 
int AddTopRegisties (const vector< Registry * > &rs, bool owns=false)
 Add registries with top priority, also udated Ownerships. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from genie::Algorithm
static string BuildParamVectKey (const std::string &comm_name, unsigned int i)
 
static string BuildParamVectSizeKey (const std::string &comm_name)
 
- Protected Attributes inherited from genie::Algorithm
bool fAllowReconfig
 
bool fOwnsSubstruc
 true if it owns its substructure (sub-algs,...) More...
 
AlgId fID
 algorithm name and configuration set More...
 
vector< Registry * > fConfVect
 
vector< boolfOwnerships
 ownership for every registry in fConfVect More...
 
AlgStatus_t fStatus
 algorithm execution status More...
 
AlgMapfOwnedSubAlgMp
 local pool for owned sub-algs (taken out of the factory pool) More...
 

Detailed Description

Defines the EventGeneratorI interface.

The concrete implementations of this interface are Event Record Visitors (subclasses of the EventRecordVisitorI pABC) that, additionally, declare a 'Validity Context'.
The declared validity context is used for selecting the appropriate concrete EventGeneratorI to generate the interacion at hand using the 'chain-of-responsibility' design pattern.

Author
Costas Andreopoulos <constantinos.andreopoulos cern.ch> University of Liverpool & STFC Rutherford Appleton Laboratory

November 22, 2004

Copyright (c) 2003-2020, The GENIE Collaboration For the full text of the license visit http://copyright.genie-mc.org

Definition at line 38 of file EventGeneratorI.h.

Constructor & Destructor Documentation

EventGeneratorI::~EventGeneratorI ( )
virtual

Definition at line 34 of file EventGeneratorI.cxx.

35 {
36 
37 }
EventGeneratorI::EventGeneratorI ( )
protected

Definition at line 16 of file EventGeneratorI.cxx.

16  :
18 {
19 
20 }
EventGeneratorI::EventGeneratorI ( string  name)
protected

Definition at line 22 of file EventGeneratorI.cxx.

22  :
24 {
25 
26 }
static QCString name
Definition: declinfo.cpp:673
EventGeneratorI::EventGeneratorI ( string  name,
string  config 
)
protected

Definition at line 28 of file EventGeneratorI.cxx.

28  :
30 {
31 
32 }
static QCString name
Definition: declinfo.cpp:673
static Config * config
Definition: config.cpp:1054

Member Function Documentation

virtual const XSecAlgorithmI* genie::EventGeneratorI::CrossSectionAlg ( void  ) const
pure virtual

Implemented in genie::EventGenerator.

virtual const InteractionListGeneratorI* genie::EventGeneratorI::IntListGenerator ( void  ) const
pure virtual

Implemented in genie::EventGenerator.

virtual const GVldContext& genie::EventGeneratorI::ValidityContext ( void  ) const
pure virtual

Implemented in genie::EventGenerator.


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