ThePEG::XSecCheck Class Reference

The XSecCheck class is a simple analysis class used for testing purposes. More...

#include <XSecCheck.h>

Inheritance diagram for ThePEG::XSecCheck:

List of all members.

Public Member Functions
Standard constructors and destructors.
	XSecCheck ()
	The default constructor.
virtual	~XSecCheck ()
	The destructor.
Virtual functions required by the AnalysisHandler class.
virtual void	analyze (tEventPtr event, long ieve, int loop, int state)
	Analyze a given Event.
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 void	Init ()
	The standard Init function used to initialize the interfaces.
Protected Member Functions
Clone Methods.
virtual IBPtr	clone () const
	Make a simple clone of this object.
virtual IBPtr	fullclone () const
	Make a clone of this object, possibly modifying the cloned object to make it sane.
Standard Interfaced functions.
virtual void	doinitrun ()
	Initialize this object.
virtual void	dofinish ()
	Finalize this object.
Private Member Functions
XSecCheck &	operator= (const XSecCheck &)
	The assignment operator is private and must never be called.
Private Attributes
CrossSection	target
	The expected total cross section.
double	tol
	The relative tolerance accepted when comparing the total cross section with the target.
double	sumw
	The sum of the weights of the events analyzed.
Static Private Attributes
static ClassDescription < XSecCheck >	initXSecCheck
	The static object used to initialize the description of this class.
Classes
struct	UnexpectedXSec
	The exception class used if the target cross section was not met. More...

---

Detailed Description

The XSecCheck class is a simple analysis class used for testing purposes.

If the total cross section does not match the one specified by TargetXSec, an exception will be thrown.

See also:

The interfaces defined for XSecCheck.

Definition at line 21 of file XSecCheck.h.

---

Member Function Documentation

virtual void ThePEG::XSecCheck::analyze	(	tEventPtr	event,
		long	ieve,
		int	loop,
		int	state
	)			[virtual]

Analyze a given Event.

Note that a fully generated event may be presented several times, if it has been manipulated in between. The default version of this function will call transform to make a lorentz transformation of the whole event, then extract all final state particles and call analyze(tPVector) of this analysis object and those of all associated analysis objects. The default version will not, however, do anything on events which have not been fully generated, or have been manipulated in any way.

Parameters:

	event	pointer to the Event to be analyzed.
	ieve	the event number.
	loop	the number of times this event has been presented. If negative the event is now fully generated.
	state	a number different from zero if the event has been manipulated in some way since it was last presented.

Reimplemented from ThePEG::AnalysisHandler.

void ThePEG::XSecCheck::persistentOutput

(

PersistentOStream &

os

)

const

Function used to write out object persistently.

Parameters:

os

the persistent output stream written to.

Reimplemented from ThePEG::AnalysisHandler.

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

Reimplemented from ThePEG::AnalysisHandler.

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

Reimplemented from ThePEG::AnalysisHandler.

virtual IBPtr ThePEG::XSecCheck::clone

(

)

const [protected, virtual]

Make a simple clone of this object.

Returns:

a pointer to the new object.

Reimplemented from ThePEG::AnalysisHandler.

virtual IBPtr ThePEG::XSecCheck::fullclone

(

)

const [protected, virtual]

Make a clone of this object, possibly modifying the cloned object to make it sane.

Returns:

a pointer to the new object.

Reimplemented from ThePEG::AnalysisHandler.

virtual void ThePEG::XSecCheck::doinitrun

(

)

[inline, protected, virtual]

Initialize this object.

Called in the run phase just before a run begins.

Reimplemented from ThePEG::InterfacedBase.

Definition at line 122 of file XSecCheck.h.

References ThePEG::InterfacedBase::doinitrun(), and sumw.

virtual void ThePEG::XSecCheck::dofinish

(

)

[protected, virtual]

Finalize this object.

Called in the run phase just after a run has ended. Used eg. to write out statistics.

Reimplemented from ThePEG::InterfacedBase.

XSecCheck& ThePEG::XSecCheck::operator=

(

const XSecCheck &

)

[private]

The assignment operator is private and must never be called.

In fact, it should not even be implemented.

---

Member Data Documentation

ClassDescription<XSecCheck> ThePEG::XSecCheck::initXSecCheck [static, private]

The static object used to initialize the description of this class.

Indicates that this is a concrete class with persistent data.

Definition at line 158 of file XSecCheck.h.

---

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

• XSecCheck.h