thepeg is hosted by Hepforge, IPPP Durham
ThePEG  2.1.4

ColourBase is the base class to be used to supply a Particle with information about its colour state. More...

#include <ColourBase.h>

Inheritance diagram for ThePEG::ColourBase:

Public Member Functions

virtual ~ColourBase ()
 Destructor.
 
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.
 
virtual vector< tcColinePtrantiColourLines () const
 Return the anti-colour lines to which this particle is connected. More...
 
virtual vector< tcColinePtrcolourLines () const
 Return the colour lines to which this particle is connected. More...
 
virtual bool hasColourLine (tcColinePtr line, bool anti=false) const
 Return true if the particle is connected to the given (anti-) colour line.
 
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.
 
virtual EIPtr clone () const
 Standard clone method.
 
- 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 ()
 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...
 

Protected Member Functions

virtual void antiColourLine (tColinePtr line)
 Set the anti-colour line to which this particle is connected.
 
virtual void colourLine (tColinePtr l, bool anti=false)
 Set the (anti-) colour line to which this particle is connected.
 
virtual void removeAntiColourLine (tcColinePtr line)
 Remove the anti-colour line to which this particle is connected.
 
virtual void removeColourLine (tcColinePtr line, bool anti=false)
 Remove the (anti-) colour line to which this particle is connected.
 
- Protected Member Functions inherited from ThePEG::Pointer::ReferenceCounted
 ReferenceCounted ()
 Default constructor.
 
 ReferenceCounted (const ReferenceCounted &)
 Copy-constructor.
 
ReferenceCountedoperator= (const ReferenceCounted &)
 Assignment.
 

Private Member Functions

ColourBaseoperator= (const ColourBase &)
 Private and non-existent assignment operator.
 

Private Attributes

ColinePtr theAntiColourLine
 The anti-colour line to which this particle is connected.
 
ColinePtr theColourLine
 The colour line to which this particle is connected.
 

Static Private Attributes

static ClassDescription< ColourBaseinitColourBase
 Describe concrete class with persistent data.
 

Friends

class ColourLine
 ColourLine is a good friend. 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...
 

Detailed Description

ColourBase is the base class to be used to supply a Particle with information about its colour state.

This base class supplies information about the ColourLines to which the particle is connected. This should be sufficient for most uses. If any other info is required for a particle, it may be supplied by an object of a sub-class of ColourBase, the additional information would then have to be extracted by dynamically casting to the sub-class.

See also
Particle
ColourLine

Definition at line 32 of file ColourBase.h.

Member Function Documentation

◆ antiColourLines()

virtual vector<tcColinePtr> ThePEG::ColourBase::antiColourLines ( ) const
virtual

Return the anti-colour lines to which this particle is connected.

(Always only one colour line for this base class.)

Reimplemented in ThePEG::MultiColour.

Referenced by colourLine().

◆ colourLines()

virtual vector<tcColinePtr> ThePEG::ColourBase::colourLines ( ) const
virtual

Return the colour lines to which this particle is connected.

(Always only one colour line for this base class.)

Reimplemented in ThePEG::MultiColour.

Referenced by colourLine().

◆ Init()

static void ThePEG::ColourBase::Init ( )
static

Standard Init function.

See also
Base::Init().

Referenced by removeColourLine().

◆ rebind()

virtual void ThePEG::ColourBase::rebind ( const EventTranslationMap trans)
virtual

Rebind to cloned objects.

When a ColourBase is cloned, a shallow copy is done first, then all ColourLines etc, are cloned, and finally this method is used to see to that the pointers in the cloned ColourBase points to the cloned ColourLines etc.

Reimplemented from ThePEG::EventInfoBase.

Referenced by removeColourLine().

Friends And Related Function Documentation

◆ ColourLine

friend class ColourLine
friend

ColourLine is a good friend.

Definition at line 37 of file ColourBase.h.


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