ThePEG::ColourBase Class Reference

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:

ThePEG::EventInfoBase ThePEG::Base ThePEG::Pointer::ReferenceCounted ThePEG::MultiColour

List of all members.

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.
virtual vector< tcColinePtrcolourLines () const
 Return the colour lines to which this particle is connected.
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.
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.

Static Public Member Functions

static void Init ()
 Standard Init function.

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.

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
< ColourBase
initColourBase
 Describe concrete class with persistent data.

Friends

class ColourLine
 ColourLine is a good friend.


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

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.

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.

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.

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

Standard Init function.

See also:
Base::Init().

Reimplemented from ThePEG::EventInfoBase.

Reimplemented in ThePEG::MultiColour.


Friends And Related Function Documentation

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:

Generated on Thu Apr 29 12:42:59 2010 for ThePEG by  doxygen 1.5.5