ThePEG::RemnantData Class Reference

The RemnantData class is not a normal ParticleData class. More...

#include <RemnantData.h>

Inheritance diagram for ThePEG::RemnantData:

List of all members.

Public Member Functions

const RemnantDecayer & decayer () const

The Decayer responsible for for the decay of this remnant.

bool extract (tcPDPtr parton)

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

bool remove (tcPDPtr parton)

Modify the properties to reflect that the given parton which was previously extracted is removed.

bool reextract (tcPDPtr oldp, tcPDPtr newp)

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

Standard constructors and destructors.

RemnantData (tcPDPtr particle, RemDecPtr decayer)

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

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

bool fixColour ()

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

RemnantData ()

The default constructor is protected and must only be used by the PersistentIStream class via the ClassTraits<RemnantData> class.

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.

Private Member Functions

RemnantData & operator= (const RemnantData &)

The assignment operator is private and must never be called.

Private Attributes

tcPDPtr parentPD

The particle type of the parent.

RemDecPtr theDecayer

The Decayer responsible for for the decay of this remnant.

DMPtr decayMode

The only DecayMode available for this remnant.

multiset< tcPDPtr > extracted

The set of extracted particle types.

Static Private Attributes

static ClassDescription
< RemnantData > initRemnantData

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

Friends

class ClassTraits< RemnantData >

The ClassTraits<RemnantData> class must be a friend to be able to use the private default constructor.

Detailed Description

The RemnantData class is not a normal ParticleData class.

It should never be handled directly by the interface but is automatically created and assigned to an object of the SoftRemnant sub-class of Particle. The SoftRemnant in turn is not a proper Particle, but rather a place holder for what is left of a colliding particle after one or several partons has been extracted. To be able to retrieve properties of the SoftRemnant through its ParticleData the RemnantData is used to dynamically keep track of this.

The RemnantData is initialized by the ParticleData corresponding to the colliding particle. For each particle which is extracted the charge charge is changed accordingly. Also the colour charge is changed, but only such that the coloured(), hasColour() and hasAntiColour() returns relevant information. The actual colour can only be singlet, (anti-)triplet or octet.

When created the RemnantData object must be given a RemnantDecayer object and a single DecayMode object will be created with this Decayer.

See also:: The interfaces defined for RemnantData.

Definition at line 46 of file RemnantData.h.

Member Function Documentation

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

Function used to write out object persistently.

Parameters:

os

the persistent output stream written to.

Reimplemented from ThePEG::ParticleData.

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

static void ThePEG::RemnantData::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::ParticleData.

virtual IBPtr ThePEG::RemnantData::clone ( ) const [protected, virtual]

Make a simple clone of this object.

Returns:: a pointer to the new object.

Reimplemented from ThePEG::ParticleData.

virtual IBPtr ThePEG::RemnantData::fullclone ( ) const [protected, virtual]

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::ParticleData.

RemnantData& ThePEG::RemnantData::operator= ( const RemnantData & ) [private]

The assignment operator is private and must never be called.

In fact, it should not even be implemented.

Member Data Documentation

ClassDescription<RemnantData> ThePEG::RemnantData::initRemnantData [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 184 of file RemnantData.h.

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

RemnantData.h


Public Member Functions
const RemnantDecayer &	decayer () const
	The Decayer responsible for for the decay of this remnant.
bool	extract (tcPDPtr parton)
	Modify the properties to reflect that the given parton was extracted.
bool	remove (tcPDPtr parton)
	Modify the properties to reflect that the given parton which was previously extracted is removed.
bool	reextract (tcPDPtr oldp, tcPDPtr newp)
	Modify the properties to reflect that the previously extracted parton, oldp, was evolved backwards to the the parton newp.
Standard constructors and destructors.
	RemnantData (tcPDPtr particle, RemDecPtr decayer)
	The standard constructor takes as argument the particle type for which this is the remnant and a decayer capable of performing the decay.
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
bool	fixColour ()
	Modify the colour to reflect that the given parton was extracted.
	RemnantData ()
	The default constructor is protected and must only be used by the PersistentIStream class via the ClassTraits<RemnantData> class.
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.
Private Member Functions
RemnantData &	operator= (const RemnantData &)
	The assignment operator is private and must never be called.
Private Attributes
tcPDPtr	parentPD
	The particle type of the parent.
RemDecPtr	theDecayer
	The Decayer responsible for for the decay of this remnant.
DMPtr	decayMode
	The only DecayMode available for this remnant.
multiset< tcPDPtr >	extracted
	The set of extracted particle types.
Static Private Attributes
static ClassDescription < RemnantData >	initRemnantData
	The static object used to initialize the description of this class.
Friends
class	ClassTraits< RemnantData >
	The ClassTraits<RemnantData> class must be a friend to be able to use the private default constructor.