ThePEG::Matcher< T > Class Template Reference

Matcher is a templated class inheriting from MatcherBase. More...

#include <Matcher.h>

Inheritance diagram for ThePEG::Matcher< T >:

Public Member Functions
Standard constructors and destructors.
virtual	~Matcher ()
	Destructor.
Public Member Functions inherited from ThePEG::MatcherBase
	MatcherBase ()
	Default constructor.
	MatcherBase (const MatcherBase &)
	Copy-constructor.
bool	checkp (const Particle &p) const
	Check if a Particle meets the criteria.
bool	matches (const ParticleData &pd) const
	Check if a given particle type belongs to the set of matches.
bool	matches (const Particle &p) const
	Check if a given particle belongs to the set of matches.
bool	matches (const MatcherBase &pm) const
	Check if a given particle matcher belongs to the set of matches.
const tPDSet &	particles () const
	Access to the set of matching particles.
const tPMSet &	matchers () const
	Access to the set of matching matchers.
Energy	minMass () const
	Returns the minimum mass of the matching particles.
Energy	maxMass () const
	Returns the maximum mass of the matching particles.
Energy	mass () const
	Returns the common mass of the matching particles.
Energy	width () const
	Returns the common width of the matching particles.
Length	cTau () const
	Returns the common decay length of the matching particles.
PDT::Charge	iCharge () const
	Return common charge.
bool	charged () const
	Are the particles charged? If all matching particles are charged, return true, otherwise false.
bool	positive () const
	Are the particles positively charged? If all matching particles are positively charged, return true, otherwise false.
bool	negative () const
	Are the particles negatively charged? If all matching particles are negatively charged, return true, otherwise false.
PDT::Spin	iSpin () const
	Return common spin.
PDT::Colour	iColour () const
	If all matching particles have the same colour, the common colour is returned.
bool	coloured () const
	Are the particles coloured? If all matching particles are coloured, return true, otherwise false.
int	stable () const
	Are the particles stable? Returns (0)1 if all matching particles are (un)stable.
tPMPtr	CC () const
	Get the matcher object matching the antiparticles of this.
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.
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.
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.
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.
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().
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.

Protected Member Functions
Clone Methods.
virtual IBPtr	clone () const
	Make a simple clone of this object.
virtual IBPtr	fullclone () const
	Make a clone of this object, possibly modifying the cloned object to make it sane.
Protected Member Functions inherited from ThePEG::MatcherBase
virtual void	doupdate ()
	Check sanity of the object during the setup phase.
void	addPIfMatch (tPDPtr)
	Add a particle to the set of matching particles if it meets the criteria.
void	addMIfMatch (tPMPtr)
	Add a particle matcher to the set of matching matchers if it meets the criteria.
template<typename Iterator >
void	addPIfMatch (Iterator first, Iterator last)
	Add a number of particles to the set of matching particles if they meets the criteria.
template<typename Cont >
void	addPIfMatchFrom (const Cont &c)
	Add a number of particles to the set of matching particles if they meets the criteria.
template<typename Iterator >
void	addMIfMatch (Iterator first, Iterator last)
	Add a number of particle matchers to the set of matching matchers if they meets the criteria.
template<typename Cont >
void	addMIfMatchFrom (const Cont &c)
	Add a number of particle matchers to the set of matching matchers if they meets the criteria.
void	clear ()
	Clear information about matching particles and matchers.
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.
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
virtual void	readSetup (istream &is)
	Read setup info from a standard istream is.
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.
	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.

Virtual and static versions of the check functions.
static NoPIOClassDescription< Matcher< T > >	initMatcher
	The static object used to initialize the description of this class.
virtual bool	check (const ParticleData &pd) const
	Virtual function overriding the one in MatcherBase.
static bool	Check (const ParticleData &pd)
	Static check function.
static void	setCC (tPMPtr pm, tPMPtr apm)
	Set antipartner.

Special clone and create functions used by the Repository.
virtual PMPtr	pmclone () const
	Create and clone Matcher objects.
static PMPtr	Create (const string &newName, string antiName)
	Create and clone Matcher objects.

Additional Inherited Members
Public Types inherited from ThePEG::MatcherBase
typedef set< tPDPtr >	tPDSet
	Convenient typedef.
typedef set< tPMPtr >	tPMSet
	Convenient typedef.
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::MatcherBase
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.
Public Attributes inherited from ThePEG::Pointer::ReferenceCounted
const unsigned long	uniqueId
	The unique ID.
Static Protected Member Functions inherited from ThePEG::MatcherBase
static void	setCC (tPMPtr pm, tPMPtr apm)
	Set antipartner.
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

template<class T>
class ThePEG::Matcher< T >

Matcher is a templated class inheriting from MatcherBase.

It is used to conveniently create interfaced classes inheriting from MatcherBase giving a class with a static T::Check() method as template argument.

See also

MatcherBase

Definition at line 27 of file Matcher.h.

Member Function Documentation

Check()

template<class T >

static bool ThePEG::Matcher< T >::Check ( const ParticleData &  pd )

inlinestaticprotected

Static check function.

Return true if a given particle type, pd, is matched by this Matcher, ie. if the T::Check() function of the template argument returns true.

Definition at line 83 of file Matcher.h.

check()

template<class T >

virtual bool ThePEG::Matcher< T >::check ( const ParticleData &  pd ) const

inlineprotectedvirtual

Virtual function overriding the one in MatcherBase.

Simply calls Check().

Implements ThePEG::MatcherBase.

Definition at line 76 of file Matcher.h.

clone()

template<class T >

virtual IBPtr ThePEG::Matcher< T >::clone ( ) const

protectedvirtual

Make a simple clone of this object.

Returns

a pointer to the new object.

Implements ThePEG::InterfacedBase.

fullclone()

template<class T >

virtual IBPtr ThePEG::Matcher< T >::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.

pmclone()

template<class T >

virtual PMPtr ThePEG::Matcher< T >::pmclone ( ) const

virtual

Create and clone Matcher objects.

Implements ThePEG::MatcherBase.

setCC()

template<class T >

static void ThePEG::Matcher< T >::setCC ( tPMPtr  pm, tPMPtr  apm  )

inlinestaticprotected

Set antipartner.

Definition at line 91 of file Matcher.h.

References ThePEG::MatcherBase::setCC().

Member Data Documentation

initMatcher

template<class T >

NoPIOClassDescription< Matcher<T> > ThePEG::Matcher< T >::initMatcher

staticprivate

The static object used to initialize the description of this class.

Indicates that this is a concrete class without persistent data.

Definition at line 99 of file Matcher.h.

---

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

• Matcher.h