ThePEG  1.8.0
Static Public Member Functions | Private Member Functions | Static Private Attributes
ThePEG::HandlerBase Class Reference

HandlerBase is an abstract base class derived from the Interfaced class via the HandlerBaseT class adding some functionality such as easy acces to the RandomGenerator and the StandardModel object of the controlling EventGenerator object. More...

#include <HandlerBase.h>

Inheritance diagram for ThePEG::HandlerBase:
Inheritance graph
[legend]

List of all members.

Static Public Member Functions

static void Init ()
 Standard Init function used to initialize the interface.

Private Member Functions

HandlerBaseoperator= (const HandlerBase &)
 Private and non-existent assignment operator.

Static Private Attributes

static
AbstractNoPIOClassDescription
< HandlerBase
initHandlerBase
 Describe an abstract class without persistent data.

Additional Inherited Members

- Public Member Functions inherited from ThePEG::HandlerBaseT< UseRandom >
double rnd () const
 Return a simple flat random number in the range ]0,1[.
double rnd (double xu) const
 Return a simple flat random number in the range ]0,xu[.
double rnd (double xl, double xu) const
 Return a simple flat random number in the range ]xl,xu[.
bool rndbool () const
 Return true with 50% probability.
bool rndbool (double p) const
 Return a true with probability p.
bool rndbool (double p1, double p2) const
 Return a true with probability p1/(p1+p2).
int rndsign (double p1, double p2, double p3) const
 Return -1, 0, or 1 with relative probabilities p1, p2, p3.
int rnd2 (double p0, double p1) const
 Return an integer $i$ with probability p $i$/(p0+p1).
int rnd3 (double p0, double p1, double p2) const
 Return an integer $i$ with probability p $i$/(p0+p1+p2).
int rnd4 (double p0, double p1, double p2, double p3) const
 Return an integer/ $i$ with probability p $i$(p0+p1+p2+p3).
long irnd (long xu=2) const
 Return a simple flat random integrer number in the range [0,xu[.
long irnd (long xl, long xu) const
 Return a simple flat random integrer number in the range [xl,xu[.
const StandardModelBaseSM () const
 Return a reference to the object containing the standard model parameters for this run.
tSMPtr standardModel () const
 Return a pointer to the object containing the standard model parameters for this run.
virtual ~HandlerBaseT ()
 Destructor.
- Public Member Functions inherited from ThePEG::Interfaced
virtual ~Interfaced ()
 Empty virtual destructor.
virtual bool defaultInit ()
 Functions which are to be used during the actual event generation, after the setup is complete.
PPtr getParticle (PID) const
 Create a new Particle instance given a id number.
PDPtr getParticleData (PID) const
 Return a pointer to the ParticleData object corresponding to the given id number.
bool used () const
 Returns true if this object has actally been used.
void useMe () const
 Should be called to indicate that this object has actually been used.
tEGPtr generator () const
 Return a pointer to the EventGenerator controlling the run.
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.
- Public Member Functions inherited from ThePEG::InterfacedBase
virtual ~InterfacedBase ()
 The virtual (empty) destructor;.
string fullName () const
 Returns the full name of this object including its path, e.g.
string name () const
 Returns the name of this object, without the path.
string path () const
 Returns the path to this object including the trailing '/'.
string comment () const
 Returns a comment assigned to this object.
void setup (istream &is)
 Read setup info from a standard istream is.
virtual IBPtr fullclone () const
 Return a full clone of this object possibly doing things to the clone to make it sane.
virtual void debugme () const
 Print out debugging information for this object on std::cerr.
void update ()
 Calls the doupdate() function with recursion prevention.
void init ()
 Calls the doinit() function with recursion prevention.
virtual bool preInitialize () const
 Return true if this object needs to be initialized before all other objects (except those for which this function also returns true).
void initrun ()
 Calls the doinitrun() function with recursion prevention.
void finish ()
 Calls the dofinish() function with recursion prevention.
void touch ()
 This function should be called every time something in this object has changed in a way that a sanity check with update() is needed.
void reset ()
 Set the state of this object to uninitialized.
void clear ()
 Calls reset() and unTouch().
InitState state () const
 Return the state of initialization of this object.
bool locked () const
 Return true if the BaseRepository is not allowed to change the state of this object.
bool touched () const
 Return true if the state of this object has been changed since the last call to update().
- 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.
- Public Member Functions inherited from ThePEG::Pointer::ReferenceCounted
CounterType referenceCount () const
 Return the reference count.
- Public Member Functions inherited from ThePEG::Named
 Named (const string &newName=string())
 Constructor with name.
bool operator== (const Named &other) const
 Test for equality.
bool operator< (const Named &other) const
 Lexicographical comparison.

Detailed Description

HandlerBase is an abstract base class derived from the Interfaced class via the HandlerBaseT class adding some functionality such as easy acces to the RandomGenerator and the StandardModel object of the controlling EventGenerator object.

See also:
Interfaced
RandomGenerator
StandardModel
EventGenerator

Definition at line 151 of file HandlerBase.h.


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