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:

[legend]

Public Member Functions
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< tcColinePtr >	antiColourLines () const
	Return the anti-colour lines to which this particle is connected.

virtual vector< tcColinePtr >	colourLines () 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.

virtual void	rebind (const EventTranslationMap &)
	Rebind to cloned objects.

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.

virtual void	debugme () const
	Print out debugging information for this object on std::cerr.

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.

Static Public Member Functions inherited from ThePEG::EventInfoBase
static void	Init ()
	Standard Init function.

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

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.

ReferenceCounted &	operator= (const ReferenceCounted &)
	Assignment.

Private Member Functions
ColourBase &	operator= (const ColourBase &)=delete
	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.

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.

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

◆ antiColourLine() [1/2]

tColinePtr ThePEG::ColourBase::antiColourLine ( ) const

inline

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

Definition at line 44 of file ColourBase.h.

References theAntiColourLine.

Referenced by colourLine(), and removeAntiColourLine().

◆ antiColourLine() [2/2]

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

inlineprotectedvirtual

Set the anti-colour line to which this particle is connected.

Reimplemented in ThePEG::MultiColour, and ThePEG::MultiColour.

Definition at line 82 of file ColourBase.h.

References theAntiColourLine.

◆ 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.

◆ clone()

virtual EIPtr ThePEG::ColourBase::clone ( ) const

virtual

Standard clone method.

Reimplemented from ThePEG::EventInfoBase.

Reimplemented in ThePEG::MultiColour.

◆ colourLine() [1/2]

tColinePtr ThePEG::ColourBase::colourLine ( ) const

inline

Return the colour line to which this particle is connected.

Definition at line 49 of file ColourBase.h.

References theColourLine.

Referenced by removeColourLine().

◆ colourLine() [2/2]

virtual void ThePEG::ColourBase::colourLine	(	tColinePtr	l,
		bool	anti = `false`
	)

inlineprotectedvirtual

Set the (anti-) colour line to which this particle is connected.

Reimplemented in ThePEG::MultiColour, and ThePEG::MultiColour.

Definition at line 89 of file ColourBase.h.

References antiColourLine(), and theColourLine.

◆ 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.

◆ hasAntiColourLine()

bool ThePEG::ColourBase::hasAntiColourLine ( tcColinePtr line ) const

inline

Return true if the particle is connected to the given anti-colour line.

Definition at line 73 of file ColourBase.h.

References hasColourLine().

◆ hasColourLine()

virtual bool ThePEG::ColourBase::hasColourLine	(	tcColinePtr	line,
		bool	anti = `false`
	)		const

virtual

Return true if the particle is connected to the given (anti-) colour line.

Reimplemented in ThePEG::MultiColour.

Referenced by hasAntiColourLine().

◆ Init()

static void ThePEG::ColourBase::Init ( )

static

Standard Init function.

See also: Base::Init().

◆ 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.

◆ removeAntiColourLine()

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

inlineprotectedvirtual

Remove the anti-colour line to which this particle is connected.

Reimplemented in ThePEG::MultiColour.

Definition at line 97 of file ColourBase.h.

References antiColourLine(), and theAntiColourLine.

Referenced by removeColourLine().

◆ removeColourLine()

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

inlineprotectedvirtual

Remove the (anti-) colour line to which this particle is connected.

Reimplemented in ThePEG::MultiColour.

Definition at line 104 of file ColourBase.h.

References colourLine(), removeAntiColourLine(), and theColourLine.

Friends And Related Function Documentation

◆ ColourLine

friend class ColourLine

friend

ColourLine is a good friend.

Definition at line 37 of file ColourBase.h.

Member Data Documentation

◆ initColourBase

ClassDescription<ColourBase> ThePEG::ColourBase::initColourBase

staticprivate

Describe concrete class with persistent data.

Definition at line 157 of file ColourBase.h.

◆ theAntiColourLine

ColinePtr ThePEG::ColourBase::theAntiColourLine

private

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

Definition at line 145 of file ColourBase.h.

Referenced by antiColourLine(), and removeAntiColourLine().

◆ theColourLine

ColinePtr ThePEG::ColourBase::theColourLine

private

The colour line to which this particle is connected.

Definition at line 150 of file ColourBase.h.

Referenced by colourLine(), and removeColourLine().

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

ColourBase.h

Public Member Functions

Static Public Member Functions

Protected Member Functions

Private Member Functions

Private Attributes

Static Private Attributes

Friends

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ antiColourLine() [1/2]

◆ antiColourLine() [2/2]

◆ antiColourLines()

◆ clone()

◆ colourLine() [1/2]

◆ colourLine() [2/2]

◆ colourLines()

◆ hasAntiColourLine()

◆ hasColourLine()

◆ Init()

◆ rebind()

◆ removeAntiColourLine()

◆ removeColourLine()

Friends And Related Function Documentation

◆ ColourLine

Member Data Documentation

◆ initColourBase

◆ theAntiColourLine

◆ theColourLine