InterfacedBase is the base class of all Interfaced objects to be handled by the BaseRepository class. More...

#include <InterfacedBase.h>

Inheritance diagram for ThePEG::InterfacedBase:

[legend]

Classes
struct	UpdateChecker
	Functor class to be used to update a range of dependent object. More...

struct	UpdateMapChecker
	Functor class to be used to update a range of dependent object in a map. More...

Public Types
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 Member Functions
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.

Inlined access function.
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.

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.

Protected Member Functions
Standard InterfacedBase virtual functions.
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.

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.

Friends
class	BaseRepository
	The BaseRepository is a close friend.

class	InterfaceBase
	The InterfaceBase is a close friend.

class	EventGenerator
	The EventGenerator is a friend.

Functions used by the persistent I/O system.
bool	isLocked
	True if this object is not to be changed by the user interface.

bool	isTouched
	True if this object has been chaged since the last call to update().

InitState	initState
	Indicate if this object has been initialized or not, or if it is being initialized.

string	theComment
	A comment assigned to this object.

map< string, string >	objectDefaults
	A map listing object-specific defaults set for the given interfaces.

static AbstractClassDescription< InterfacedBase >	initInterfacedBase
	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.

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

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.

static void	Init ()
	Standard Init function.

void	name (string newName)
	Set a new name (full name including path).

void	lock ()
	Lock this object.

void	unlock ()
	Unlock this object.

void	untouch ()
	Clear the isTouched flag.

string	addComment (string)
	Used by the interface to add comments.

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

Additional Inherited Members
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.

Detailed Description

InterfacedBase is the base class of all Interfaced objects to be handled by the BaseRepository class.

InterfacedBase objects can be manipulated through objects of the InterfaceBase class dealing with setting parameters, switches and pointers to other InterfacedBase objects.

The InterfacedBase has a number of virtual methods to be implemented by sub classes for checking the state of the object, initializing the object etc.

The InterfacedBase is derived from the PersistentBase class to allow for persistent I/O, and from the Named for handling the name of the object. The full name of the object is of the form /dir/subdir/name analogous to the file name in a Unix file system.

It is possible to lock an InterfacedBase object in which case the BaseRepository will not do anything that will change the state of this object.

See also: BaseRepository; InterfaceBase

Definition at line 45 of file InterfacedBase.h.

Member Enumeration Documentation

◆ InitState

enum ThePEG::InterfacedBase::InitState

Enumeration reflecting the state of an InterfacedBase object.

Enumerator
initializing	The object is currently being initialized. I.e. either of update(), init(), initrun() or finish() are being run.
uninitialized	The object has not been initialized.
initialized	The object has been initialized.
runready	The object is initialized and the initrun() method has been called.

Definition at line 61 of file InterfacedBase.h.

Constructor & Destructor Documentation

◆ InterfacedBase() [1/3]

ThePEG::InterfacedBase::InterfacedBase ( )

inlineprotected

Protected default constructor.

Definition at line 351 of file InterfacedBase.h.

◆ InterfacedBase() [2/3]

ThePEG::InterfacedBase::InterfacedBase ( string newName )

inlineprotected

Protected constructor with the name given as argument.

Definition at line 358 of file InterfacedBase.h.

◆ InterfacedBase() [3/3]

ThePEG::InterfacedBase::InterfacedBase ( const InterfacedBase & i )

inlineprotected

Protected copy-constructor.

Definition at line 365 of file InterfacedBase.h.

Member Function Documentation

◆ clear()

void ThePEG::InterfacedBase::clear ( )

inline

Calls reset() and unTouch().

Definition at line 290 of file InterfacedBase.h.

References reset(), and untouch().

Referenced by ThePEG::BaseRepository::clearAll().

◆ clone()

virtual IBPtr ThePEG::InterfacedBase::clone ( ) const

protectedpure virtual

Return a simple clone of this object.

Should be implemented as return new_ptr(*this); by a derived class.

Implemented in ThePEG::GraphvizPlot, ThePEG::HepMC3File, ThePEG::HepMCFile, ThePEG::HIHepMCFile, ThePEG::LWHFactory, ThePEG::NLOHepMC3File, ThePEG::NLOHepMCFile, ThePEG::NLORivetAnalysis, ThePEG::ProgressLog, ThePEG::RivetAnalysis, ThePEG::XSecCheck, ThePEG::Cuts, ThePEG::DeltaMeasureCuts, ThePEG::FastJetFinder, ThePEG::FuzzyTheta, ThePEG::JetCuts, ThePEG::JetPairRegion, ThePEG::JetRegion, ThePEG::KTClus, ThePEG::KTRapidityCut, ThePEG::MultiJetRegion, ThePEG::NJetsCut, ThePEG::OneJetCut, ThePEG::SimpleDISCut, ThePEG::SimpleKTCut, ThePEG::V2LeptonsCut, ThePEG::ACDCSampler, ThePEG::AnalysisHandler, ThePEG::ClusterCollapser, ThePEG::DecayHandler, ThePEG::EventHandler, ThePEG::FixedCMSLuminosity, ThePEG::FixedTargetLuminosity, ThePEG::GaussianPtGenerator, ThePEG::LuminosityFunction, ThePEG::SimpleFlavour, ThePEG::SimpleZGenerator, ThePEG::StandardEventHandler, ThePEG::SubProcessHandler, ThePEG::LesHouchesEventHandler, ThePEG::LesHouchesFileReader, ThePEG::MadGraphOneCut, ThePEG::MadGraphReader, ThePEG::MadGraphTwoCut, ThePEG::MECuts, ThePEG::MEee2gZ2qq, ThePEG::MEGG2GG, ThePEG::MEGG2QQ, ThePEG::MENCDIS, ThePEG::MEQG2QG, ThePEG::MEQQ2GG, ThePEG::MEqq2qq, ThePEG::MEQQ2qq, ThePEG::MEQQ2QQ, ThePEG::MEQq2Qq, ThePEG::ReweightConstant, ThePEG::ReweightMinPT, ThePEG::BudnevPDF, ThePEG::DipoleFormFactor, ThePEG::GRV94L, ThePEG::GRV94M, ThePEG::HardSphereYukawaFormFactor, ThePEG::LeptonLeptonPDF, ThePEG::LHAPDF, ThePEG::NoPDF, ThePEG::NoRemnants, ThePEG::NuclearPhotonPDF, ThePEG::PartonExtractor, ThePEG::SoftRemnantHandler, ThePEG::UnResolvedRemnant, ThePEG::WeizsackerWilliamsPDF, ThePEG::BreitWignerMass, ThePEG::ColourPairDecayer, ThePEG::DalitzDecayer, ThePEG::DecayMode, ThePEG::DummyDecayer, ThePEG::FlatDecayer, ThePEG::Matcher< T >, ThePEG::OmegaPhi3PiDecayer, ThePEG::Onium3GDecayer, ThePEG::ParticleData, ThePEG::QuarksToHadronsDecayer, ThePEG::RemnantData, ThePEG::SimpleBaryonRemnantDecayer, ThePEG::Tau2HadronsDecayer, ThePEG::V2PPDecayer, ThePEG::WeakToHadronsDecayer, ThePEG::EventGenerator, ThePEG::MultiEventGenerator, ThePEG::StandardRandom, ThePEG::Strategy, ThePEG::ThePEGStrategy, ThePEG::O1AlphaS, ThePEG::SimpleAlphaEM, ThePEG::StandardCKM, and ThePEG::StandardModelBase.

Referenced by fullclone().

◆ comment()

string ThePEG::InterfacedBase::comment ( ) const

inline

Returns a comment assigned to this object.

Definition at line 106 of file InterfacedBase.h.

References theComment.

◆ debugme()

virtual void ThePEG::InterfacedBase::debugme ( ) const

virtual

Print out debugging information for this object on std::cerr.

To be called from within a debugger via the debug() function.

Reimplemented from ThePEG::Base.

◆ dofinish()

virtual void ThePEG::InterfacedBase::dofinish ( )

inlineprotectedvirtual

Finalize this object.

Called in the run phase just after a run has ended. Used eg. to write out statistics.

This method is called after the running phase through the finish() and can eg. be used to write out statistics. When implemented by a sub class it is important that the dofinish() method of the base class is called while the finish() methd is called for other objects.

Reimplemented in ThePEG::FactoryBase, ThePEG::GraphvizPlot, ThePEG::HepMC3File, ThePEG::HepMCFile, ThePEG::HIHepMCFile, ThePEG::NLOHepMC3File, ThePEG::NLOHepMCFile, ThePEG::NLORivetAnalysis, ThePEG::RivetAnalysis, ThePEG::XSecCheck, ThePEG::ACDCSampler, ThePEG::EventHandler, ThePEG::StandardEventHandler, ThePEG::LesHouchesEventHandler, ThePEG::LesHouchesReader, ThePEG::MadGraphReader, ThePEG::LHAPDF, ThePEG::PartonExtractor, and ThePEG::EventGenerator.

Definition at line 208 of file InterfacedBase.h.

Referenced by ThePEG::EventHandler::dofinish(), ThePEG::LesHouchesReader::dofinish(), ThePEG::MadGraphReader::dofinish(), and finish().

◆ doinit()

virtual void ThePEG::InterfacedBase::doinit ( )

inlineprotectedvirtual

Initialize this object after the setup phase before saving an EventGenerator to disk.

Nothing should have changed since the last update() call.

This method is called after the setup phase through the init() method to indicate that the setup of a run is finished. This is typpically done in a setup program before this object has been saved to a run file. It must therefore be made sure that the state of this object after this method has been executed will not be changed if it is written to a file and read in again. When implemented by a sub class it is important that the doinit() method of the base class is called first and then, if the initialization of this object depends on other objects, that the init() method of these objects are called. Only then should the class-local initialization proceed. To avoid circular loops, it is important that the doinit() method is called for the base class, while the init() method is called for other objects.

Exceptions

InitException if object could not be initialized properly.

Reimplemented in ThePEG::NLORivetAnalysis, ThePEG::RivetAnalysis, ThePEG::FastJetFinder, ThePEG::FixedTargetLuminosity, ThePEG::SimpleFlavour, ThePEG::StandardEventHandler, ThePEG::SubProcessHandler, ThePEG::Helicity::VertexBase, ThePEG::LesHouchesEventHandler, ThePEG::LesHouchesFileReader, ThePEG::LesHouchesReader, ThePEG::MadGraphReader, ThePEG::MEBase, ThePEG::MEee2gZ2qq, ThePEG::MEGroup, ThePEG::MENCDIS, ThePEG::LHAPDF, ThePEG::PDFBase, ThePEG::UnResolvedRemnant, ThePEG::DalitzDecayer, ThePEG::MixedParticleData, ThePEG::ParticleData, ThePEG::RemnantDecayer, ThePEG::SimpleBaryonRemnantDecayer, ThePEG::EventGenerator, ThePEG::RandomGenerator, ThePEG::AlphaSBase, and ThePEG::StandardModelBase.

Definition at line 179 of file InterfacedBase.h.

Referenced by init().

◆ doinitrun()

virtual void ThePEG::InterfacedBase::doinitrun ( )

inlineprotectedvirtual

Initialize this object.

Called in the run phase just before a run begins.

This method is called just before running starts through the initrun() method to indicate that the actual running is to start. When implemented by a sub class it is important that the doinitrun() method of the base class is called first and then, if the initialization of this object depends on other objects, that the initrun() method of these objects are called. Only then should the class-local initialization proceed. To avoid circular loops, it is important that the doinitrun() method is called for the base class, while the initrun() method is called for other objects.

Reimplemented in ThePEG::FactoryBase, ThePEG::HepMC3File, ThePEG::HepMCFile, ThePEG::HIHepMCFile, ThePEG::LWHFactory, ThePEG::NLOHepMC3File, ThePEG::NLOHepMCFile, ThePEG::NLORivetAnalysis, ThePEG::ProgressLog, ThePEG::RivetAnalysis, ThePEG::XSecCheck, ThePEG::Cuts, ThePEG::FastJetFinder, ThePEG::ACDCSampler, ThePEG::SimpleFlavour, ThePEG::StandardEventHandler, ThePEG::SubProcessHandler, ThePEG::LesHouchesEventHandler, ThePEG::LesHouchesReader, ThePEG::MEBase, ThePEG::MEGroup, ThePEG::LHAPDF, ThePEG::ParticleData, and ThePEG::EventGenerator.

Definition at line 196 of file InterfacedBase.h.

Referenced by ThePEG::XSecCheck::doinitrun(), and initrun().

◆ doupdate()

virtual void ThePEG::InterfacedBase::doupdate ( )

inlineprotectedvirtual

Check sanity of the object during the setup phase.

This function is called everytime the object is changed through an interface during the setup phase. Also if the setup is changed for an object on which this is dependent. Note that the generator() is not available when this method is called.

This method may be called by the user interface during the setup phase through the update() method after manipulating objects to check the sanity of the object. When implemented by a sub class it is important that the doupdate() method of the base class is called, then if the sanity of this object depend on other objects, the update() method of these should be called. Then if touched() is true for this object or for the ones on which this depends, it is an indication that some things have changed since last time doupdate() was called, and the actual checking of the state of this object is called for. To avoid circular loops, it is important that the doupdate() method is called for the base class, while the update() method is called for other objects.

Exceptions

UpdateException if the setup is such that the object would not work properly.

Reimplemented in ThePEG::StandardEventHandler, ThePEG::MECuts, ThePEG::DecayMode, ThePEG::MatcherBase, and ThePEG::ParticleData.

Definition at line 156 of file InterfacedBase.h.

Referenced by update().

◆ finish()

void ThePEG::InterfacedBase::finish ( )

inline

Calls the dofinish() function with recursion prevention.

Definition at line 269 of file InterfacedBase.h.

References dofinish(), initializing, initState, and uninitialized.

◆ fullclone()

virtual IBPtr ThePEG::InterfacedBase::fullclone ( ) const

inlinevirtual

Return a full clone of this object possibly doing things to the clone to make it sane.

Reimplemented in ThePEG::GraphvizPlot, ThePEG::HepMC3File, ThePEG::HepMCFile, ThePEG::HIHepMCFile, ThePEG::LWHFactory, ThePEG::NLOHepMC3File, ThePEG::NLOHepMCFile, ThePEG::NLORivetAnalysis, ThePEG::ProgressLog, ThePEG::RivetAnalysis, ThePEG::XSecCheck, ThePEG::Cuts, ThePEG::DeltaMeasureCuts, ThePEG::FastJetFinder, ThePEG::FuzzyTheta, ThePEG::JetCuts, ThePEG::JetPairRegion, ThePEG::JetRegion, ThePEG::KTClus, ThePEG::KTRapidityCut, ThePEG::MultiJetRegion, ThePEG::NJetsCut, ThePEG::OneJetCut, ThePEG::SimpleDISCut, ThePEG::SimpleKTCut, ThePEG::V2LeptonsCut, ThePEG::ACDCSampler, ThePEG::AnalysisHandler, ThePEG::ClusterCollapser, ThePEG::DecayHandler, ThePEG::EventHandler, ThePEG::FixedCMSLuminosity, ThePEG::FixedTargetLuminosity, ThePEG::GaussianPtGenerator, ThePEG::LuminosityFunction, ThePEG::SimpleFlavour, ThePEG::SimpleZGenerator, ThePEG::StandardEventHandler, ThePEG::SubProcessHandler, ThePEG::LesHouchesEventHandler, ThePEG::LesHouchesFileReader, ThePEG::MadGraphOneCut, ThePEG::MadGraphReader, ThePEG::MadGraphTwoCut, ThePEG::MEee2gZ2qq, ThePEG::MEGG2GG, ThePEG::MEGG2QQ, ThePEG::MENCDIS, ThePEG::MEQG2QG, ThePEG::MEQQ2GG, ThePEG::MEqq2qq, ThePEG::MEQQ2qq, ThePEG::MEQQ2QQ, ThePEG::MEQq2Qq, ThePEG::ReweightConstant, ThePEG::ReweightMinPT, ThePEG::BudnevPDF, ThePEG::DipoleFormFactor, ThePEG::GRV94L, ThePEG::GRV94M, ThePEG::HardSphereYukawaFormFactor, ThePEG::LeptonLeptonPDF, ThePEG::LHAPDF, ThePEG::NoPDF, ThePEG::NoRemnants, ThePEG::NuclearPhotonPDF, ThePEG::PartonExtractor, ThePEG::SoftRemnantHandler, ThePEG::UnResolvedRemnant, ThePEG::WeizsackerWilliamsPDF, ThePEG::BreitWignerMass, ThePEG::ColourPairDecayer, ThePEG::DalitzDecayer, ThePEG::DecayMode, ThePEG::DummyDecayer, ThePEG::FlatDecayer, ThePEG::Matcher< T >, ThePEG::OmegaPhi3PiDecayer, ThePEG::Onium3GDecayer, ThePEG::ParticleData, ThePEG::QuarksToHadronsDecayer, ThePEG::RemnantData, ThePEG::SimpleBaryonRemnantDecayer, ThePEG::Tau2HadronsDecayer, ThePEG::V2PPDecayer, ThePEG::WeakToHadronsDecayer, ThePEG::EventGenerator, ThePEG::MultiEventGenerator, ThePEG::StandardRandom, ThePEG::Strategy, ThePEG::ThePEGStrategy, ThePEG::O1AlphaS, ThePEG::SimpleAlphaEM, ThePEG::StandardCKM, and ThePEG::StandardModelBase.

Definition at line 317 of file InterfacedBase.h.

References clone().

◆ fullName()

string ThePEG::InterfacedBase::fullName ( ) const

inline

Returns the full name of this object including its path, e.g.

/directory/subdirectory/name.

Definition at line 83 of file InterfacedBase.h.

References ThePEG::Named::name().

◆ getReferences()

virtual IVector ThePEG::InterfacedBase::getReferences ( )

inlineprotectedvirtual

Return a vector of all pointers to Interfaced objects used in this object.

Returns: a vector of pointers.

Reimplemented in ThePEG::EventHandler, ThePEG::Helicity::VertexBase, ThePEG::MEGroup, ThePEG::DalitzDecayer, ThePEG::DecayMode, ThePEG::ParticleData, and ThePEG::MultiEventGenerator.

Definition at line 215 of file InterfacedBase.h.

◆ init()

void ThePEG::InterfacedBase::init ( )

inline

Calls the doinit() function with recursion prevention.

Definition at line 243 of file InterfacedBase.h.

References doinit(), initialized, initializing, and initState.

◆ initrun()

void ThePEG::InterfacedBase::initrun ( )

inline

Calls the doinitrun() function with recursion prevention.

Definition at line 260 of file InterfacedBase.h.

References doinitrun(), initializing, initState, and runready.

◆ lock()

void ThePEG::InterfacedBase::lock ( )

inlineprivate

Lock this object.

Definition at line 380 of file InterfacedBase.h.

References isLocked.

◆ locked()

bool ThePEG::InterfacedBase::locked ( ) const

inline

Return true if the BaseRepository is not allowed to change the state of this object.

Definition at line 304 of file InterfacedBase.h.

References isLocked.

◆ name() [1/2]

string ThePEG::InterfacedBase::name ( ) const

inline

Returns the name of this object, without the path.

Definition at line 88 of file InterfacedBase.h.

References ThePEG::Named::name().

Referenced by ThePEG::EventGenerator::getObject(), and ThePEG::EventGenerator::runName().

◆ name() [2/2]

void ThePEG::InterfacedBase::name ( string newName )

inlineprivate

Set a new name (full name including path).

Definition at line 375 of file InterfacedBase.h.

References ThePEG::Named::name().

◆ path()

string ThePEG::InterfacedBase::path ( ) const

inline

Returns the path to this object including the trailing '/'.

fullName() = path() + name().

Definition at line 96 of file InterfacedBase.h.

References ThePEG::Named::name().

◆ persistentInput()

void ThePEG::InterfacedBase::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::InterfacedBase::persistentOutput ( PersistentOStream & os ) const

Function used to write out object persistently.

Parameters

os	the persistent output stream written to.

◆ preInitialize()

virtual bool ThePEG::InterfacedBase::preInitialize ( ) const

virtual

Return true if this object needs to be initialized before all other objects (except those for which this function also returns true).

This default version always returns false, but subclasses may override it to return true.

Reimplemented in ThePEG::LesHouchesFileReader, ThePEG::LesHouchesReader, ThePEG::MadGraphReader, ThePEG::RemnantDecayer, ThePEG::SimpleBaryonRemnantDecayer, and ThePEG::StandardModelBase.

◆ readSetup()

virtual void ThePEG::InterfacedBase::readSetup ( istream & is )

protectedvirtual

Read setup info from a standard istream is.

May be called by the Repository to initialize an object. This function is called by the non virtual setup() function. A sub-class implementing it should first call the base class version before parsing the is. If the is is not empty after readSetup is called the remaining string will be assigned to the comment() of the object.

Reimplemented in ThePEG::ConstituentParticleData, ThePEG::DecayMode, and ThePEG::ParticleData.

Referenced by setup().

◆ rebind()

virtual void ThePEG::InterfacedBase::rebind ( const TranslationMap & )

inlineprotectedvirtual

Rebind pointer to other Interfaced objects.

Called in the setup phase after all objects used in an EventGenerator has been cloned so that the pointers will refer to the cloned objects afterwards.

Exceptions

RebindException if no cloned object was found for a given pointer.

Reimplemented in ThePEG::EventHandler, ThePEG::Helicity::VertexBase, ThePEG::MEGroup, ThePEG::DalitzDecayer, ThePEG::DecayMode, ThePEG::ParticleData, and ThePEG::MultiEventGenerator.

Definition at line 224 of file InterfacedBase.h.

◆ reset()

void ThePEG::InterfacedBase::reset ( )

inline

Set the state of this object to uninitialized.

Definition at line 285 of file InterfacedBase.h.

References initState, and uninitialized.

Referenced by clear(), and ThePEG::BaseRepository::resetAll().

◆ setup()

void ThePEG::InterfacedBase::setup ( istream & is )

inline

Read setup info from a standard istream is.

May be called by the Repository to initialize an object. This function first calls the virtual readSetup() function to allow the sub classes the part is to initialize themselves. What ever is left in is after that will be assigned to the comment() of the object.

Definition at line 115 of file InterfacedBase.h.

References readSetup(), and theComment.

◆ state()

InitState ThePEG::InterfacedBase::state ( ) const

inline

Return the state of initialization of this object.

Definition at line 298 of file InterfacedBase.h.

References initState.

◆ touch()

void ThePEG::InterfacedBase::touch ( )

inline

This function should be called every time something in this object has changed in a way that a sanity check with update() is needed.

Definition at line 280 of file InterfacedBase.h.

References isTouched.

◆ touched()

bool ThePEG::InterfacedBase::touched ( ) const

inline

Return true if the state of this object has been changed since the last call to update().

Definition at line 310 of file InterfacedBase.h.

References isTouched.

◆ unlock()

void ThePEG::InterfacedBase::unlock ( )

inlineprivate

Unlock this object.

Definition at line 385 of file InterfacedBase.h.

References isLocked.

◆ untouch()

void ThePEG::InterfacedBase::untouch ( )

inlineprivate

Clear the isTouched flag.

Definition at line 390 of file InterfacedBase.h.

References isTouched.

Referenced by clear().

◆ update()

void ThePEG::InterfacedBase::update ( )

inline

Calls the doupdate() function with recursion prevention.

Definition at line 234 of file InterfacedBase.h.

References doupdate(), initialized, initializing, and initState.

Friends And Related Function Documentation

◆ BaseRepository

friend class BaseRepository

friend

The BaseRepository is a close friend.

Definition at line 48 of file InterfacedBase.h.

◆ EventGenerator

friend class EventGenerator

friend

The EventGenerator is a friend.

Definition at line 54 of file InterfacedBase.h.

◆ InterfaceBase

friend class InterfaceBase

friend

The InterfaceBase is a close friend.

Definition at line 51 of file InterfacedBase.h.

Member Data Documentation

◆ initInterfacedBase

AbstractClassDescription<InterfacedBase> ThePEG::InterfacedBase::initInterfacedBase

staticprivate

Standard Initialization object.

Definition at line 441 of file InterfacedBase.h.

◆ initState

InitState ThePEG::InterfacedBase::initState

private

Indicate if this object has been initialized or not, or if it is being initialized.

Definition at line 416 of file InterfacedBase.h.

Referenced by finish(), init(), initrun(), reset(), state(), and update().

◆ isLocked

bool ThePEG::InterfacedBase::isLocked

private

True if this object is not to be changed by the user interface.

Definition at line 404 of file InterfacedBase.h.

Referenced by lock(), locked(), and unlock().

◆ isTouched

bool ThePEG::InterfacedBase::isTouched

private

True if this object has been chaged since the last call to update().

Definition at line 410 of file InterfacedBase.h.

Referenced by touch(), touched(), and untouch().

◆ objectDefaults

map<string,string> ThePEG::InterfacedBase::objectDefaults

private

A map listing object-specific defaults set for the given interfaces.

Definition at line 426 of file InterfacedBase.h.

◆ theComment

string ThePEG::InterfacedBase::theComment

private

A comment assigned to this object.

Definition at line 421 of file InterfacedBase.h.

Referenced by comment(), and setup().

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

InterfacedBase.h

Classes

Public Types

Public Member Functions

Protected Member Functions

Friends

Functions used by the persistent I/O system.

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ InitState

Constructor & Destructor Documentation

◆ InterfacedBase() [1/3]

◆ InterfacedBase() [2/3]

◆ InterfacedBase() [3/3]

Member Function Documentation

◆ clear()

◆ clone()

◆ comment()

◆ debugme()

◆ dofinish()

◆ doinit()

◆ doinitrun()

◆ doupdate()

◆ finish()

◆ fullclone()

◆ fullName()

◆ getReferences()

◆ init()

◆ initrun()

◆ lock()

◆ locked()

◆ name() [1/2]

◆ name() [2/2]

◆ path()

◆ persistentInput()

◆ persistentOutput()

◆ preInitialize()

◆ readSetup()

◆ rebind()

◆ reset()

◆ setup()

◆ state()

◆ touch()

◆ touched()

◆ unlock()

◆ untouch()

◆ update()

Friends And Related Function Documentation

◆ BaseRepository

◆ EventGenerator

◆ InterfaceBase

Member Data Documentation

◆ initInterfacedBase

◆ initState

◆ isLocked

◆ isTouched

◆ objectDefaults

◆ theComment