The Interfaced class is derived from the InterfacedBase class adding a couple of things particular to ThePEG, in an attempt to keep the InterfacedBase class as generic as possible. More...

#include <Interfaced.h>

Inheritance diagram for ThePEG::Interfaced:

[legend]

Public Member Functions
virtual	~Interfaced ()
	Empty virtual destructor.

virtual bool	defaultInit ()
	Functions which are to be used during the actual event generation, after the setup is complete.

Functions used during the actual event generation, after
the setup is complete.
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.

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.

string	name () const
	Returns the name of this object, without the path.

string	path () const
	Returns the path to this object including the trailing '/'.

string	comment () const
	Returns a comment assigned to this object.

void	setup (istream &is)
	Read setup info from a standard istream is.

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).

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().

virtual IBPtr	fullclone () const
	Return a full clone of this object possibly doing things to the clone to make it sane.

void	persistentOutput (PersistentOStream &os) const
	Function used to write out object persistently.

void	persistentInput (PersistentIStream &is, int version)
	Function used to read in object persistently.

virtual void	debugme () const
	Print out debugging information for this object on std::cerr.

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.

virtual void	debugme () const
	Print out debugging information for this object on std::cerr.

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.

	Named (const Named &)=default
	Explicit default copy-constructor (too avoid compiler warnings)

const string &	name () const
	Return name.

bool	operator== (const Named &other) const
	Test for equality.

bool	operator< (const Named &other) const
	Lexicographical comparison.

Friends
class	Repository
	Repository is a friend.

class	EventGenerator
	EventGenerator is a friend.

Functions used by the persistent I/O system.
tEGPtr	theGenerator
	A pointer to the EventGenerator controlling the run.

bool	theUseFlag
	Flag to tell whether this object has been used or not.

static AbstractClassDescription< Interfaced >	initInterfaced
	Standard Initialization object.

void	persistentOutput (PersistentOStream &os) const
	Function used to write out object persistently.

void	persistentInput (PersistentIStream &is, int version)
	Function used to read in object persistently.

static void	Init ()
	Standard Init function.

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.

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.

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.

void	setUsed () const
	Used internally by 'useMe'.

string	doDefaultInit (string)
	Command interface function which calls defaultInit().

Interfaced &	operator= (const Interfaced &)=delete
	Private and non-existent assignment operator.

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.

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.

Public Attributes inherited from ThePEG::Pointer::ReferenceCounted
const unsigned long	uniqueId
	The unique ID.

Protected Member Functions inherited from ThePEG::InterfacedBase
virtual void	readSetup (istream &is)
	Read setup info from a standard istream is.

virtual void	doupdate ()
	Check sanity of the object during the setup phase.

virtual void	doinit ()
	Initialize this object after the setup phase before saving an EventGenerator to disk.

virtual void	doinitrun ()
	Initialize this object.

virtual void	dofinish ()
	Finalize this object.

virtual IVector	getReferences ()
	Return a vector of all pointers to Interfaced objects used in this object.

virtual void	rebind (const TranslationMap &)
	Rebind pointer to other Interfaced objects.

virtual IBPtr	clone () const =0
	Return a simple clone of this object.

	InterfacedBase ()
	Protected default constructor.

	InterfacedBase (string newName)
	Protected constructor with the name given as argument.

	InterfacedBase (const InterfacedBase &i)
	Protected copy-constructor.

Protected Member Functions inherited from ThePEG::Pointer::ReferenceCounted
	ReferenceCounted ()
	Default constructor.

	ReferenceCounted (const ReferenceCounted &)
	Copy-constructor.

ReferenceCounted &	operator= (const ReferenceCounted &)
	Assignment.

Protected Member Functions inherited from ThePEG::Named
const Named &	operator= (const Named &other)
	Assignment.

const string &	name (const string &newName)
	Set new name.

Detailed Description

The Interfaced class is derived from the InterfacedBase class adding a couple of things particular to ThePEG, in an attempt to keep the InterfacedBase class as generic as possible.

The main addition is that the Interfaced class has a pointer to an EventGenerator object. During the run-phase this points to the EventGenerator controlling the run in which the Interfaced object is used. Through this EventGenerator there is quick access to eg. the set of ParticleData objects used, and the default RandomGenerator for the run. Note that no EventGenerator object is available to the Interfaced object during the setup phase.

See also: InterfacedBase; EventGenerator; ParticleData; RandomGenerator

Definition at line 38 of file Interfaced.h.

Constructor & Destructor Documentation

◆ Interfaced() [1/3]

ThePEG::Interfaced::Interfaced ( )

inlineprotected

Protected default constructor.

Definition at line 168 of file Interfaced.h.

◆ Interfaced() [2/3]

ThePEG::Interfaced::Interfaced ( const string & newName )

inlineprotected

Protected constructor taking a name as argument.

Definition at line 173 of file Interfaced.h.

◆ Interfaced() [3/3]

ThePEG::Interfaced::Interfaced ( const Interfaced & i )

inlineprotected

Protected copy-constructor.

Definition at line 179 of file Interfaced.h.

Member Function Documentation

◆ defaultInit()

virtual bool ThePEG::Interfaced::defaultInit ( )

virtual

Functions which are to be used during the actual event generation, after the setup is complete.

A sub class can implement this function to implement some default initialization for this object during the setup phase. A typical example is if this object need some references to other objects and if these can be easily created. In this case the objects can be added to the repository in a sub-directory with the same name as this object.

Returns: false if the initialization failed.

◆ generator()

tEGPtr ThePEG::Interfaced::generator ( ) const

inline

Return a pointer to the EventGenerator controlling the run.

During the setup phase this returns a null pointer.

Definition at line 99 of file Interfaced.h.

References theGenerator.

Referenced by ThePEG::FuzzyTheta::bounds(), ThePEG::Helicity::VertexBase::electroMagneticCoupling(), setGenerator(), ThePEG::HandlerBaseT< T >::standardModel(), ThePEG::Helicity::VertexBase::strongCoupling(), ThePEG::RunningCoupling::value(), and ThePEG::Helicity::VertexBase::weakCoupling().

◆ persistentInput()

void ThePEG::Interfaced::persistentInput	(	PersistentIStream &	is,
		int	version
	)

Function used to read in object persistently.

Parameters

is	the persistent input stream read from.
version	the version number of the object when written.

◆ persistentOutput()

void ThePEG::Interfaced::persistentOutput ( PersistentOStream & os ) const

Function used to write out object persistently.

Parameters

os	the persistent output stream written to.

◆ reporeg()

void ThePEG::Interfaced::reporeg	(	IBPtr	object,
		string	name
	)		const

protected

Register the given object in the Repository with the given name in a subdirectory with the same name as this object.

If an object with that name already exists it will be removed unless there are other objects referring to it, in which case it will be renamed.

Referenced by setDefaultReference().

◆ setDefaultReference()

template<typename PtrT >

bool ThePEG::Interfaced::setDefaultReference	(	PtrT &	ptr,
		string	classname,
		string	objectname
	)

inlineprotected

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.

Definition at line 154 of file Interfaced.h.

References ThePEG::ClassDescriptionBase::create(), ThePEG::DescriptionList::find(), and reporeg().

◆ setGenerator()

void ThePEG::Interfaced::setGenerator ( tEGPtr generator )

inlineprotected

Protected function to reset the generator pointer, required for automatic decayer generation in Herwig++ BSM models.

Definition at line 188 of file Interfaced.h.

References generator(), and theGenerator.

◆ used()

bool ThePEG::Interfaced::used ( ) const

inline

Returns true if this object has actally been used.

Definition at line 87 of file Interfaced.h.

References theUseFlag.

Referenced by useMe().

◆ useMe()

void ThePEG::Interfaced::useMe ( ) const

inline

Should be called to indicate that this object has actually been used.

Definition at line 93 of file Interfaced.h.

References setUsed(), and used().

Referenced by ThePEG::MadGraphReader::dofinish().

Friends And Related Function Documentation

◆ EventGenerator

friend class EventGenerator

friend

EventGenerator is a friend.

Definition at line 44 of file Interfaced.h.

◆ Repository

friend class Repository

friend

Repository is a friend.

Definition at line 41 of file Interfaced.h.

Member Data Documentation

◆ initInterfaced

AbstractClassDescription<Interfaced> ThePEG::Interfaced::initInterfaced

staticprivate

Standard Initialization object.

Definition at line 217 of file Interfaced.h.

◆ theGenerator

tEGPtr ThePEG::Interfaced::theGenerator

private

A pointer to the EventGenerator controlling the run.

Definition at line 200 of file Interfaced.h.

Referenced by generator(), and setGenerator().

◆ theUseFlag

bool ThePEG::Interfaced::theUseFlag

mutableprivate

Flag to tell whether this object has been used or not.

Definition at line 205 of file Interfaced.h.

Referenced by used().

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

Interfaced.h

Public Member Functions

Friends

Functions used by the persistent I/O system.

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ Interfaced() [1/3]

◆ Interfaced() [2/3]

◆ Interfaced() [3/3]

Member Function Documentation

◆ defaultInit()

◆ generator()

◆ persistentInput()

◆ persistentOutput()

◆ reporeg()

◆ setDefaultReference()

◆ setGenerator()

◆ used()

◆ useMe()

Friends And Related Function Documentation

◆ EventGenerator

◆ Repository

Member Data Documentation

◆ initInterfaced

◆ theGenerator

◆ theUseFlag