thepeg is hosted by Hepforge, IPPP Durham
ThePEG  2.1.4

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:

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. More...
 
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 Scalescale () 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. More...
 
void persistentInput (PersistentIStream &is, int version)
 Function used to read in object persistently. More...
 
- 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 tHintPtr Default ()
 Return a pointer to the default hint.
 
static void Init ()
 Standard Init function used to initialize the interface.
 
- Static Public Member Functions inherited from ThePEG::Base
static void Init ()
 The standard Init function used to initialize the interfaces. More...
 

Private Member Functions

Hintoperator= (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< HintinitHint
 Describe a concrete class with persistent data.
 

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...
 
- Protected Member Functions inherited from ThePEG::Pointer::ReferenceCounted
 ReferenceCounted ()
 Default constructor.
 
 ReferenceCounted (const ReferenceCounted &)
 Copy-constructor.
 
ReferenceCountedoperator= (const ReferenceCounted &)
 Assignment.
 

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

◆ persistentInput()

void ThePEG::Hint::persistentInput ( PersistentIStream is,
int  version 
)

Function used to read in object persistently.

Parameters
isthe persistent input stream read from.
versionthe version number of the object when written.

Referenced by Default().

◆ persistentOutput()

void ThePEG::Hint::persistentOutput ( PersistentOStream os) const

Function used to write out object persistently.

Parameters
osthe persistent output stream written to.

Referenced by Default().

◆ tagged()

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.


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