thepeg is hosted by Hepforge, IPPP Durham
ThePEG  2.1.4

The Strategy class represents a general strategy to be assigned to an EventGenerator. More...

#include <Strategy.h>

Inheritance diagram for ThePEG::Strategy:

Public Member Functions

virtual const string versionstring () const
 Return a freeform version string. More...
 
Access the special objects in this Strategy.
const ParticleMap & particles () const
 Return the map of local particles indexed by their PDG id number.
 
string localParticlesDir () const
 A directory in the repository which will be scanned for particles which will be included as default particles in a run. More...
 
const vector< string > & defaultParticlesDirs () const
 By default all particles in the Repository are included in a run, although only one particle per PDG id number. More...
 
const vector< IPtr > & defaultObjects () const
 Return the vector of default objects.
 
Functions used by the persistent I/O system.
void persistentOutput (PersistentOStream &os) const
 Function used to write out object persistently. More...
 
void persistentInput (PersistentIStream &is, int version)
 Function used to read in object persistently. More...
 
- Public Member Functions inherited from ThePEG::Interfaced
virtual ~Interfaced ()
 Empty virtual destructor.
 
virtual bool defaultInit ()
 Functions which are to be used during the actual event generation, after the setup is complete. More...
 
PPtr getParticle (PID) const
 Create a new Particle instance given a id number.
 
PDPtr getParticleData (PID) const
 Return a pointer to the ParticleData object corresponding to the given id number.
 
bool used () const
 Returns true if this object has actally been used.
 
void useMe () const
 Should be called to indicate that this object has actually been used.
 
tEGPtr generator () const
 Return a pointer to the EventGenerator controlling the run. More...
 
void persistentOutput (PersistentOStream &os) const
 Function used to write out object persistently. More...
 
void persistentInput (PersistentIStream &is, int version)
 Function used to read in object persistently. More...
 
- Public Member Functions inherited from ThePEG::InterfacedBase
virtual ~InterfacedBase ()
 The virtual (empty) destructor;.
 
string fullName () const
 Returns the full name of this object including its path, e.g. More...
 
string name () const
 Returns the name of this object, without the path.
 
string path () const
 Returns the path to this object including the trailing '/'. More...
 
string comment () const
 Returns a comment assigned to this object.
 
void setup (istream &is)
 Read setup info from a standard istream is. More...
 
virtual void debugme () const
 Print out debugging information for this object on std::cerr. More...
 
void update ()
 Calls the doupdate() function with recursion prevention.
 
void init ()
 Calls the doinit() function with recursion prevention.
 
virtual bool preInitialize () const
 Return true if this object needs to be initialized before all other objects (except those for which this function also returns true). More...
 
void initrun ()
 Calls the doinitrun() function with recursion prevention.
 
void finish ()
 Calls the dofinish() function with recursion prevention.
 
void touch ()
 This function should be called every time something in this object has changed in a way that a sanity check with update() is needed.
 
void reset ()
 Set the state of this object to uninitialized.
 
void clear ()
 Calls reset() and unTouch().
 
InitState state () const
 Return the state of initialization of this object.
 
bool locked () const
 Return true if the BaseRepository is not allowed to change the state of this object.
 
bool touched () const
 Return true if the state of this object has been changed since the last call to update().
 
void persistentOutput (PersistentOStream &os) const
 Function used to write out object persistently. More...
 
void persistentInput (PersistentIStream &is, int version)
 Function used to read in object persistently. More...
 
- Public Member Functions inherited from ThePEG::Base
virtual ~Base ()
 The virtual destructor.
 
void debug () const
 Print out debugging information for this object on std::cerr. More...
 
- Public Member Functions inherited from ThePEG::Pointer::ReferenceCounted
CounterType referenceCount () const
 Return the reference count.
 
- Public Member Functions inherited from ThePEG::Named
 Named (const string &newName=string())
 Constructor with name.
 
const string & name () const
 Return name.
 
bool operator== (const Named &other) const
 Test for equality.
 
bool operator< (const Named &other) const
 Lexicographical comparison.
 

Static Public Member Functions

static void Init ()
 Standard Init function used to initialize the interface.
 
- Static Public Member Functions inherited from ThePEG::Interfaced
static void Init ()
 Standard Init function.
 
- Static Public Member Functions inherited from ThePEG::InterfacedBase
static void Init ()
 Standard Init function.
 
- Static Public Member Functions inherited from ThePEG::Base
static void Init ()
 The standard Init function used to initialize the interfaces. More...
 

Protected Member Functions

Clone Methods.
virtual IBPtr clone () const
 Make a simple clone of this object. More...
 
virtual IBPtr fullclone () const
 Make a clone of this object, possibly modifying the cloned object to make it sane. More...
 
- Protected Member Functions inherited from ThePEG::Interfaced
void reporeg (IBPtr object, string name) const
 Register the given object in the Repository with the given name in a subdirectory with the same name as this object. More...
 
template<typename PtrT >
bool setDefaultReference (PtrT &ptr, string classname, string objectname)
 If the pointer, ptr, to an object is not set, create an object of class classname and register it with the Repository with the given objectname in a sib-directory with the same name as this object.
 
 Interfaced ()
 Protected default constructor.
 
 Interfaced (const string &newName)
 Protected constructor taking a name as argument.
 
 Interfaced (const Interfaced &i)
 Protected copy-constructor.
 
void setGenerator (tEGPtr generator)
 Protected function to reset the generator pointer, required for automatic decayer generation in Herwig++ BSM models.
 
- Protected Member Functions inherited from ThePEG::InterfacedBase
 InterfacedBase ()
 Protected default constructor.
 
 InterfacedBase (string newName)
 Protected constructor with the name given as argument.
 
 InterfacedBase (const InterfacedBase &i)
 Protected copy-constructor.
 
virtual void readSetup (istream &is)
 Read setup info from a standard istream is. More...
 
virtual void doupdate ()
 Check sanity of the object during the setup phase. More...
 
virtual void doinit ()
 Initialize this object after the setup phase before saving an EventGenerator to disk. More...
 
virtual void doinitrun ()
 Initialize this object. More...
 
virtual void dofinish ()
 Finalize this object. More...
 
virtual IVector getReferences ()
 Return a vector of all pointers to Interfaced objects used in this object. More...
 
virtual void rebind (const TranslationMap &)
 Rebind pointer to other Interfaced objects. More...
 
- Protected Member Functions inherited from ThePEG::Pointer::ReferenceCounted
 ReferenceCounted ()
 Default constructor.
 
 ReferenceCounted (const ReferenceCounted &)
 Copy-constructor.
 
ReferenceCountedoperator= (const ReferenceCounted &)
 Assignment.
 
- Protected Member Functions inherited from ThePEG::Named
const Namedoperator= (const Named &other)
 Assignment.
 
const string & name (const string &newName)
 Set new name.
 

Private Member Functions

ParticleMap & particles ()
 Return the map of local particles.
 
void setLocalParticles (PDPtr pd, int)
 Utility function used by the interface.
 
void insLocalParticles (PDPtr pd, int)
 Utility function used by the interface.
 
void delLocalParticles (int place)
 Utility function used by the interface.
 
vector< PDPtrgetLocalParticles () const
 Utility function used by the interface.
 
void setLocalParticlesDir (string)
 Utility function used by the interface.
 
void setDefaultParticlesDirs (string, int)
 Utility function used by the interface.
 
void insDefaultParticlesDirs (string, int)
 Utility function used by the interface.
 
Strategyoperator= (const Strategy &)
 Private and non-existent assignment operator.
 

Static Private Member Functions

static bool checkDir (string)
 Utility function used by the interface.
 

Private Attributes

ParticleMap theParticles
 the map of default particles.
 
string theLocalParticlesDir
 A directory in the repository which will be scanned for particles which will be included as default particles in a run. More...
 
vector< IPtrtheDefaultObjects
 A vector of default objects.
 
vector< string > theDefaultParticlesDirs
 By default all particles in the Repository are included in a run, although only one particle per PDG id number. More...
 

Static Private Attributes

static ClassDescription< StrategyinitStrategy
 Describe a concrete class with persistent data.
 

Additional Inherited Members

- Public Types inherited from ThePEG::InterfacedBase
enum  InitState { initializing = -1, uninitialized = 0, initialized = 1, runready = 2 }
 Enumeration reflecting the state of an InterfacedBase object. More...
 
- Public Types inherited from ThePEG::Pointer::ReferenceCounted
typedef unsigned int CounterType
 The integer type used for counting.
 
- Public Attributes inherited from ThePEG::Pointer::ReferenceCounted
const unsigned long uniqueId
 The unique ID. More...
 
- Static Protected Member Functions inherited from ThePEG::Interfaced
static void registerRepository (IBPtr)
 Register an Interfaced object with the Repository.
 
static void registerRepository (IBPtr, string newName)
 Register an Interfaced object with the Repository, giving it a name.
 

Detailed Description

The Strategy class represents a general strategy to be assigned to an EventGenerator.

It contains a set of default ParticleData objects which takes presedence over the ones in the Repository (although not over the ones in the EventGenerator). It also contains a set of other default objects which are automatically assigned to all Reference and RefVector interfaces which have the InterfaceBase::defaultIfNull() flag set. In this case each of the objects in defaultObjects() are tested in turn, and the first object which has the correct class and can be set will be used.

Sub-classes may implement other behaviors by overriding the doinit() function.

See also
The interfaces defined for Strategy.
EventGenerator
ParticleData
Repository
Reference

Definition at line 41 of file Strategy.h.

Member Function Documentation

◆ clone()

virtual IBPtr ThePEG::Strategy::clone ( ) const
protectedvirtual

Make a simple clone of this object.

Returns
a pointer to the new object.

Implements ThePEG::InterfacedBase.

Reimplemented in ThePEG::ThePEGStrategy.

Referenced by versionstring().

◆ defaultParticlesDirs()

const vector<string>& ThePEG::Strategy::defaultParticlesDirs ( ) const
inline

By default all particles in the Repository are included in a run, although only one particle per PDG id number.

If directories are listed here, only particles in these will be considered for inclusion in a run. Only particles which have a PDG id which is not given by particles in localParticlesDir(), particles(), or in EventGenerator::localParticles() will be considered.

Definition at line 69 of file Strategy.h.

References theDefaultParticlesDirs.

◆ fullclone()

virtual IBPtr ThePEG::Strategy::fullclone ( ) const
protectedvirtual

Make a clone of this object, possibly modifying the cloned object to make it sane.

Returns
a pointer to the new object.

Reimplemented from ThePEG::InterfacedBase.

Reimplemented in ThePEG::ThePEGStrategy.

Referenced by versionstring().

◆ localParticlesDir()

string ThePEG::Strategy::localParticlesDir ( ) const

A directory in the repository which will be scanned for particles which will be included as default particles in a run.

These particles will be overridden by particles specified in LocalParticles and default particles specified directly in the EventGenerator.

Referenced by particles().

◆ persistentInput()

void ThePEG::Strategy::persistentInput ( PersistentIStream is,
int  version 
)

Function used to read in object persistently.

Parameters
isthe persistent input stream read from.
versionthe version number of the object when written.

Referenced by versionstring().

◆ persistentOutput()

void ThePEG::Strategy::persistentOutput ( PersistentOStream os) const

Function used to write out object persistently.

Parameters
osthe persistent output stream written to.

Referenced by versionstring().

◆ versionstring()

virtual const string ThePEG::Strategy::versionstring ( ) const
inlinevirtual

Return a freeform version string.

Client code should not rely on the string's format. It can be used e.g. to annotate plots.

Reimplemented in ThePEG::ThePEGStrategy.

Definition at line 83 of file Strategy.h.

References clone(), fullclone(), Init(), persistentInput(), and persistentOutput().

Member Data Documentation

◆ theDefaultParticlesDirs

vector<string> ThePEG::Strategy::theDefaultParticlesDirs
private

By default all particles in the Repository are included in a run, although only one particle per PDG id number.

If directories are listed in theDefaultParticlesDirs, only particles in these will be considered for inclusion in a run. Only particles which have a PDG id which is not given by particles in localParticlesDir(), particles(), or in EventGenerator::localParticles() will be considered.

Definition at line 162 of file Strategy.h.

Referenced by defaultParticlesDirs().

◆ theLocalParticlesDir

string ThePEG::Strategy::theLocalParticlesDir
private

A directory in the repository which will be scanned for particles which will be included as default particles in a run.

These particles will be overridden by particles specified in LocalParticles and default particles specified directly in the EventGenerator.

Definition at line 146 of file Strategy.h.


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