ThePEG::RemnantParticle Class Reference

Here is the documentation of the RemnantParticle class. More...

#include <RemnantParticle.h>

Inheritance diagram for ThePEG::RemnantParticle:

List of all members.

Public Member Functions
Standard constructors and destructors.
	RemnantParticle (const Particle &particle, RemDecPtr decayer, tPPtr parton=tPPtr())
	The standard constructor takes as argument the particle for which this is the remnant and a decayer capable of performing the decay.
bool	extract (tPPtr parton, bool fixcolour=false)
	Modify the properties to reflect that the given parton was extracted.
bool	reextract (tPPtr oldp, tPPtr newp, bool fixcolour=false)
	Modify the properties to reflect that the previously extracted parton, oldp, was evolved backwards to the the parton newp.
bool	remove (tPPtr parton)
	Modify the properties to reflect that the given parton which was previously extracted is removed.
const PVector &	extracted () const
	Acces the extracted partons.
Functions used by the persistent I/O system.
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 Public Member Functions
static void	Init ()
	The standard Init function used to initialize the interfaces.
Protected Member Functions
void	fixColourLines (tPPtr parton)
	If necessary, colour-connect this remnant to the given parton.
	RemnantParticle ()
	Private default constructor must only be used by the PersistentIStream class via the ClassTraits<RemnantParticle> class.
Private Member Functions
RemnantParticle &	operator= (const RemnantParticle &)
	The assignment operator is private and must never be called.
Private Attributes
RemPDPtr	remData
	The RemnantData object associated to this remnant.
tcPPtr	parent
	The parent from which this remnant resulted.
PVector	theExtracted
	The set of extracted partons.
Static Private Attributes
static ClassDescription < RemnantParticle >	initRemnantParticle
	The static object used to initialize the description of this class.
Friends
class	RemnantDecayer
	RemnantDecayer is a friend.
class	ClassTraits< RemnantParticle >
	The ClassTraits<RemnantParticle> class must be a friend to be able to use the private default constructor.

---

Detailed Description

Here is the documentation of the RemnantParticle class.

Definition at line 25 of file RemnantParticle.h.

---

Constructor & Destructor Documentation

ThePEG::RemnantParticle::RemnantParticle	(	const Particle &	particle,
		RemDecPtr	decayer,
		tPPtr	parton = tPPtr()
	)

The standard constructor takes as argument the particle for which this is the remnant and a decayer capable of performing the decay.

Optionally a parton that has been extracted. Note that if the parton is given, the extraction may silently fail.

---

Member Function Documentation

bool ThePEG::RemnantParticle::extract	(	tPPtr	parton,
		bool	fixcolour = false
	)

Modify the properties to reflect that the given parton was extracted.

If fixcolour is true a colour line is drawn from the remnant to the extracted parton.

bool ThePEG::RemnantParticle::reextract	(	tPPtr	oldp,
		tPPtr	newp,
		bool	fixcolour = false
	)

Modify the properties to reflect that the previously extracted parton, oldp, was evolved backwards to the the parton newp.

If fixcolour is true a colour line is drawn from the remnant to the extracted parton.

void ThePEG::RemnantParticle::persistentOutput

(

PersistentOStream &

os

)

const

Function used to write out object persistently.

Parameters:

os

the persistent output stream written to.

Reimplemented from ThePEG::Particle.

void ThePEG::RemnantParticle::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.

Reimplemented from ThePEG::Particle.

static void ThePEG::RemnantParticle::Init

(

)

[static]

The standard Init function used to initialize the interfaces.

Called exactly once for each class by the class description system before the main function starts or when this class is dynamically loaded.

Reimplemented from ThePEG::Particle.

RemnantParticle& ThePEG::RemnantParticle::operator=

(

const RemnantParticle &

)

[private]

The assignment operator is private and must never be called.

In fact, it should not even be implemented.

---

Member Data Documentation

ClassDescription<RemnantParticle> ThePEG::RemnantParticle::initRemnantParticle [static, private]

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

Indicates that this is a concrete class with persistent data.

Definition at line 147 of file RemnantParticle.h.

---

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

• RemnantParticle.h