thepeg is hosted by Hepforge, IPPP Durham
ThePEG  2.1.5
ThePEG::MultiColour Class Reference

This class is used to store colour information of RemnantParticle objects and other particle classes with complicated colour structures. More...

#include <MultiColour.h>

Inheritance diagram for ThePEG::MultiColour:

Public Member Functions

virtual vector< tcColinePtrantiColourLines () const
 Return the anti-colour lines to which this particle is connected.
 
virtual vector< tcColinePtrcolourLines () const
 Return the colour lines to which this particle is connected.
 
virtual void colourLine (tColinePtr line, bool anti=false)
 Add the given (anti-) colour line to the particle. More...
 
virtual void colourLine (tColinePtr line, int index, bool anti=false)
 Add the given (anti-) colour line to the particle. More...
 
virtual void antiColourLine (tColinePtr line)
 Add the given anti-colour line to the particle. More...
 
virtual void antiColourLine (tColinePtr line, int index)
 Add the given anti-colour line to the particle. More...
 
virtual void removeColourLine (tcColinePtr line, bool anti=false)
 Remove the given (anti-) colour line from the particle. More...
 
virtual void removeAntiColourLine (tcColinePtr line)
 Remove the given anti-colour line from the particle. More...
 
virtual bool hasColourLine (tcColinePtr line, bool anti=false) const
 Return true if the particle is connected to the given (anti-) colour line.
 
virtual EIPtr clone () const
 Standard clone method.
 
Functions used by the persistent I/O system.
void persistentOutput (PersistentOStream &os) const
 Function used to write out object persistently. More...
 
void persistentInput (PersistentIStream &is, int version)
 Function used to read in object persistently. More...
 
- Public Member Functions inherited from ThePEG::ColourBase
tColinePtr antiColourLine () const
 Return the anti-colour line to which this particle is connected.
 
tColinePtr colourLine () const
 Return the colour line to which this particle is connected.
 
bool hasAntiColourLine (tcColinePtr line) const
 Return true if the particle is connected to the given anti-colour line.
 
virtual void rebind (const EventTranslationMap &trans)
 Rebind to cloned objects. More...
 
void persistentOutput (PersistentOStream &) const
 Standard function for writing to a persistent stream.
 
void persistentInput (PersistentIStream &, int)
 Standard functions for reading from a persistent stream.
 
- 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. More...
 
virtual void debugme () const
 Print out debugging information for this object on std::cerr. More...
 
- Public Member Functions inherited from ThePEG::Pointer::ReferenceCounted
CounterType referenceCount () const
 Return the reference count.
 

Static Public Member Functions

static void Init ()
 The standard Init function used to initialize the interfaces. More...
 
- Static Public Member Functions inherited from ThePEG::ColourBase
static void Init ()
 Standard Init function. More...
 
- Static Public Member Functions inherited from ThePEG::EventInfoBase
static void Init ()
 Standard Init function. More...
 
- Static Public Member Functions inherited from ThePEG::Base
static void Init ()
 The standard Init function used to initialize the interfaces. More...
 

Private Member Functions

MultiColouroperator= (const MultiColour &)=delete
 The assignment operator is private and must never be called. More...
 

Private Attributes

list< cColinePtrtheColourLines
 The set of colour lines to which a particle is attached.
 
list< cColinePtrtheAntiColourLines
 The set of anti-colour lines to which a particle is attached.
 

Static Private Attributes

static ClassDescription< MultiColourinitMultiColour
 The static object used to initialize the description of this class. More...
 

Additional Inherited Members

- Public Types inherited from ThePEG::Pointer::ReferenceCounted
typedef unsigned int CounterType
 The integer type used for counting.
 
- Public Attributes inherited from ThePEG::Pointer::ReferenceCounted
const unsigned long uniqueId
 The unique ID. More...
 
- Protected Member Functions inherited from ThePEG::Pointer::ReferenceCounted
 ReferenceCounted ()
 Default constructor.
 
 ReferenceCounted (const ReferenceCounted &)
 Copy-constructor.
 
ReferenceCountedoperator= (const ReferenceCounted &)
 Assignment.
 

Detailed Description

This class is used to store colour information of RemnantParticle objects and other particle classes with complicated colour structures.

Rather than just having a

Definition at line 24 of file MultiColour.h.

Member Function Documentation

◆ antiColourLine() [1/2]

virtual void ThePEG::MultiColour::antiColourLine ( tColinePtr  line)
virtual

Add the given anti-colour line to the particle.

If the base class has no anti-colour line, it will also be set.

Reimplemented from ThePEG::ColourBase.

◆ antiColourLine() [2/2]

virtual void ThePEG::MultiColour::antiColourLine ( tColinePtr  line,
int  index 
)
virtual

Add the given anti-colour line to the particle.

If the base class has no anti-colour line, it will also be set.

◆ colourLine() [1/2]

virtual void ThePEG::MultiColour::colourLine ( tColinePtr  line,
bool  anti = false 
)
virtual

Add the given (anti-) colour line to the particle.

If the base class has no (anti-) colour line, it will also be set.

Reimplemented from ThePEG::ColourBase.

◆ colourLine() [2/2]

virtual void ThePEG::MultiColour::colourLine ( tColinePtr  line,
int  index,
bool  anti = false 
)
virtual

Add the given (anti-) colour line to the particle.

If the base class has no (anti-) colour line, it will also be set.

◆ Init()

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

◆ operator=()

MultiColour& ThePEG::MultiColour::operator= ( const MultiColour )
privatedelete

The assignment operator is private and must never be called.

In fact, it should not even be implemented.

◆ persistentInput()

void ThePEG::MultiColour::persistentInput ( PersistentIStream is,
int  version 
)

Function used to read in object persistently.

Parameters
isthe persistent input stream read from.
versionthe version number of the object when written.

◆ persistentOutput()

void ThePEG::MultiColour::persistentOutput ( PersistentOStream os) const

Function used to write out object persistently.

Parameters
osthe persistent output stream written to.

◆ removeAntiColourLine()

virtual void ThePEG::MultiColour::removeAntiColourLine ( tcColinePtr  line)
virtual

Remove the given anti-colour line from the particle.

If the line is the antiColourLine() of the base class, it will be removed there as well.

Reimplemented from ThePEG::ColourBase.

◆ removeColourLine()

virtual void ThePEG::MultiColour::removeColourLine ( tcColinePtr  line,
bool  anti = false 
)
virtual

Remove the given (anti-) colour line from the particle.

If the line is the colourLine() of the base class, it will be removed there as well.

Reimplemented from ThePEG::ColourBase.

Member Data Documentation

◆ initMultiColour

ClassDescription<MultiColour> ThePEG::MultiColour::initMultiColour
staticprivate

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

Indicates that this is a concrete class with persistent data.

Definition at line 136 of file MultiColour.h.


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