ShowerVeto is a general interface for performing vetoes during showering. More...

#include <ShowerVeto.h>

Inheritance diagram for Herwig::ShowerVeto:

[legend]

Public Types
enum	ShowerVetoType { Emission = 1 , Shower , Event }
	Define types of ShowerVetoes. More...

Public Types inherited from ThePEG::InterfacedBase
enum	InitState

Public Types inherited from ThePEG::Pointer::ReferenceCounted
typedef unsigned int	CounterType

Public Member Functions
	ShowerVeto (ShowerVetoType vetoType)
	Constructor giving the behaviour of this veto.

ShowerVetoType	vetoType () const
	Return the type of this veto.

Public Member Functions inherited from ThePEG::Interfaced
virtual bool	defaultInit ()

PPtr	getParticle (PID) const

PDPtr	getParticleData (PID) const

bool	used () const

void	useMe () const

tEGPtr	generator () const

void	persistentOutput (PersistentOStream &os) const

void	persistentInput (PersistentIStream &is, int version)

PPtr	getParticle (PID) const

PDPtr	getParticleData (PID) const

bool	used () const

void	useMe () const

tEGPtr	generator () const

Public Member Functions inherited from ThePEG::InterfacedBase
string	fullName () const

string	name () const

string	path () const

string	comment () const

void	setup (istream &is)

void	update ()

void	init ()

virtual bool	preInitialize () const

void	initrun ()

void	finish ()

void	touch ()

void	reset ()

void	clear ()

InitState	state () const

bool	locked () const

bool	touched () const

virtual IBPtr	fullclone () const

void	persistentOutput (PersistentOStream &os) const

void	persistentInput (PersistentIStream &is, int version)

virtual void	debugme () const

void	update ()

void	init ()

virtual bool	preInitialize () const

void	initrun ()

void	finish ()

void	touch ()

void	reset ()

void	clear ()

InitState	state () const

bool	locked () const

bool	touched () const

virtual IBPtr	fullclone () const

Public Member Functions inherited from ThePEG::Base
void	debug () const

virtual void	debugme () const

Public Member Functions inherited from ThePEG::Pointer::ReferenceCounted
CounterType	referenceCount () const

Public Member Functions inherited from ThePEG::Named
	Named (const string &newName=string())

	Named (const Named &)=default

const string &	name () const

bool	operator== (const Named &other) const

bool	operator< (const Named &other) const

Functions used by the persistent I/O system.
ShowerVetoType	_vetoType
	The type of this veto.

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.

virtual bool	vetoTimeLike (tcShowerProgenitorPtr, tcShowerParticlePtr, const Branching &, tcShowerTreePtr)=0
	Return true, if the selected emission off the given particle and progenitor is vetoed.

virtual bool	vetoSpaceLike (tcShowerProgenitorPtr, tcShowerParticlePtr, const Branching &, tcShowerTreePtr)=0
	Return true, if the selected emission off the given particle and progenitor is vetoed.

static void	Init ()
	The standard Init function used to initialize the interfaces.

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

Additional Inherited Members
Static Public Member Functions inherited from ThePEG::Interfaced
static void	Init ()

Static Public Member Functions inherited from ThePEG::InterfacedBase
static void	Init ()

Static Public Member Functions inherited from ThePEG::Base
static void	Init ()

Public Attributes inherited from ThePEG::InterfacedBase
	initializing

	uninitialized

	initialized

	runready

Public Attributes inherited from ThePEG::Pointer::ReferenceCounted
const unsigned long	uniqueId

Protected Member Functions inherited from ThePEG::Interfaced
void	reporeg (IBPtr object, string name) const

bool	setDefaultReference (PtrT &ptr, string classname, string objectname)

	Interfaced (const string &newName)

	Interfaced (const Interfaced &i)

void	setGenerator (tEGPtr generator)

Protected Member Functions inherited from ThePEG::InterfacedBase
virtual void	readSetup (istream &is)

virtual void	doupdate ()

virtual void	doinit ()

virtual void	doinitrun ()

virtual void	dofinish ()

virtual IVector	getReferences ()

virtual void	rebind (const TranslationMap &)

virtual IBPtr	clone () const=0

	InterfacedBase (string newName)

	InterfacedBase (const InterfacedBase &i)

virtual void	readSetup (istream &is)

virtual void	doupdate ()

virtual void	doinit ()

virtual void	doinitrun ()

virtual void	dofinish ()

virtual IVector	getReferences ()

virtual void	rebind (const TranslationMap &)

Protected Member Functions inherited from ThePEG::Pointer::ReferenceCounted
	ReferenceCounted (const ReferenceCounted &)

ReferenceCounted &	operator= (const ReferenceCounted &)

Protected Member Functions inherited from ThePEG::Named
const Named &	operator= (const Named &other)

const string &	name (const string &newName)

Static Protected Member Functions inherited from ThePEG::Interfaced
static void	registerRepository (IBPtr)

static void	registerRepository (IBPtr, string newName)

Detailed Description

ShowerVeto is a general interface for performing vetoes during showering.

See also: The interfaces defined for ShowerVeto.

Definition at line 40 of file ShowerVeto.h.

Member Enumeration Documentation

◆ ShowerVetoType

enum Herwig::ShowerVeto::ShowerVetoType

Define types of ShowerVetoes.

Enumerator

Emission

Throw away emission, if veto encountered.

Set the scale to the scale of vetoed emission.

Shower

Throw away showering.

Event

Throw away event.

Definition at line 47 of file ShowerVeto.h.

Constructor & Destructor Documentation

◆ ShowerVeto()

Herwig::ShowerVeto::ShowerVeto ( ShowerVetoType vetoType )

inline

Constructor giving the behaviour of this veto.

Definition at line 71 of file ShowerVeto.h.

Member Function Documentation

◆ Init()

static void Herwig::ShowerVeto::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=()

ShowerVeto & Herwig::ShowerVeto::operator= ( const ShowerVeto & )

privatedelete

The assignment operator is private and must never be called.

In fact, it should not even be implemented.

◆ persistentInput()

void Herwig::ShowerVeto::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.

◆ persistentOutput()

void Herwig::ShowerVeto::persistentOutput ( PersistentOStream & os ) const

Function used to write out object persistently.

Parameters

os	the persistent output stream written to.

◆ vetoType()

ShowerVetoType Herwig::ShowerVeto::vetoType ( ) const

inline

Return the type of this veto.

Definition at line 76 of file ShowerVeto.h.

References _vetoType.

Member Data Documentation

◆ _vetoType

ShowerVetoType Herwig::ShowerVeto::_vetoType

private

The type of this veto.

Definition at line 133 of file ShowerVeto.h.

Referenced by vetoType().

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

ShowerVeto.h

Public Types

Public Member Functions

Functions used by the persistent I/O system.

Additional Inherited Members