ThePEG::Hint Class Reference

Hint is a base class to be used to pass information between StepHandler s, which cannot be convayed through the Event record. More...

#include <Hint.h>

Inheritance diagram for ThePEG::Hint:

List of all members.

Public Member Functions
bool	tagged () const
	Return true if there are tagged particles in the hint.
tPVector	tagged (const Step &s) const
	Return a list of pointers to particles to be handled.
template<typename InputIterator>
void	tag (InputIterator first, InputIterator last)
	Add a range of particles to the list of tagged particles.
void	tag (tPPtr p)
	Add a particle to the list of tagged particles.
void	stop (bool newStopFlag)
	Set the stop hint.
bool	stop () const
	Get the stop hint.
void	scale (const Scale &newScale)
	Set the scale.
const Scale &	scale () const
	Get the scale.
Standard constructors and destructors.
	Hint ()
	Default constructor.
Functions used by the persistent I/O system.
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.
Static Public Member Functions
static tHintPtr	Default ()
	Return a pointer to the default hint.
static void	Init ()
	Standard Init function used to initialize the interface.
Private Member Functions
Hint &	operator= (const Hint &h)
	Assignment is private and non-existing.
Private Attributes
tPVector	theTagged
	The vector of tagged particles.
Scale	theScale
	The scale.
bool	theStopFlag
	The stop hint.
Static Private Attributes
static Hint	theDefaultHint
	The default hint.
static ClassDescription< Hint >	initHint
	Describe a concrete class with persistent data.

---

Detailed Description

Hint is a base class to be used to pass information between StepHandler s, which cannot be convayed through the Event record.

The base class contains a vector of of tagged particles. A StepHandler is always given a hint, and is only allowed to treat Particles from the current Step which are listed in the vector of tagged particles in the hint (if this vector is empty the StepHandler may treat all particles in the Step.

A Hint may have the stop flag set. In this case the StepHandler to which the hint is assigned is not called, and the event generation is stopped.

A Hint may be given a scale, but what a StepHandler does with this and other pieces of information possibly supplied by subclasses of Hint, is not defined.

There is a special Hint which is kept as the static member called Hint::theDefaultHint. Although any default constructed Hint object would work as a default hint, only pointers to this static object should be used where a default hint is needed.

See also:

StepHandler

EventHandler

Particle

Event

Step

Definition at line 48 of file Hint.h.

---

Member Function Documentation

tPVector ThePEG::Hint::tagged

(

const Step &

s

)

const

Return a list of pointers to particles to be handled.

A handler is not allowed to touch other particles in the event record. If a particle which has been flagged by the hint is no longer present in the current Step, a null pointer is inserted in its place.

void ThePEG::Hint::persistentOutput

(

PersistentOStream &

os

)

const

Function used to write out object persistently.

Parameters:

os

the persistent output stream written to.

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

---

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

• Hint.h