EPIC::EventGeneratorModule Class Reference

Definition of module for generation of events from a given distribution. More...

#include <EventGeneratorModule.h>

Inheritance diagram for EPIC::EventGeneratorModule:

Public Member Functions
	EventGeneratorModule (const std::string &className)
	EventGeneratorModule (const EventGeneratorModule &other)
virtual	~EventGeneratorModule ()
virtual void	configure (const ElemUtils::Parameters &parameters)
virtual bool	runTest () const
virtual void	initialise (const std::vector< KinematicRange > &kinematicRanges, const EventGeneratorInterface &service)=0
virtual std::pair< std::vector< double >, double >	generateEvent ()=0
virtual std::pair< double, double >	getIntegral ()=0
const std::string &	getInitStatePath () const
void	setInitStatePath (const std::string &initStatePath)
Public Member Functions inherited from EPIC::EpicModuleObject
virtual	~EpicModuleObject ()
virtual bool	runTest () const =0
size_t	getSeed () const

Static Public Attributes
static const std::string	EVENT_GENERATOR_MODULE_CLASS_NAME
	Class name used in parsing XML.
static const std::string	EVENT_GENERATOR_MODULE_INIT_STATE_PATH
	String used to set path to init state file type via XML scenario.

Protected Member Functions
virtual void	initModule ()
virtual void	isModuleWellConfigured ()
Protected Member Functions inherited from EPIC::EpicModuleObject
	EpicModuleObject (const std::string &className, PARTONS::ChannelType::Type channelType)
	EpicModuleObject (const EpicModuleObject &other)

Protected Attributes
std::string	m_initStatePath
	Path to file to either load (if exist) or save (if not) initial state of generator.
Protected Attributes inherited from EPIC::EpicModuleObject
size_t	m_seed
	Random seed.

Detailed Description

Definition of module for generation of events from a given distribution.

This class provides a definition of modules used to generate events from given distributions.

Constructor & Destructor Documentation

EventGeneratorModule() [1/2]

EPIC::EventGeneratorModule::EventGeneratorModule

(

const std::string &

className

)

Constructor.

EventGeneratorModule() [2/2]

EPIC::EventGeneratorModule::EventGeneratorModule

(

const EventGeneratorModule &

other

)

Copy constructor.

~EventGeneratorModule()

virtual EPIC::EventGeneratorModule::~EventGeneratorModule ( )

virtual

Destructor.

Member Function Documentation

generateEvent()

virtual std::pair< std::vector< double >, double > EPIC::EventGeneratorModule::generateEvent ( )

pure virtual

Generate event.

Implemented in EPIC::EventGeneratorFOAM.

getInitStatePath()

const std::string & EPIC::EventGeneratorModule::getInitStatePath

(

)

const

Get path to state file.

getIntegral()

virtual std::pair< double, double > EPIC::EventGeneratorModule::getIntegral ( )

pure virtual

Get integral over distribution and integrated error.

Implemented in EPIC::EventGeneratorFOAM.

initialise()

virtual void EPIC::EventGeneratorModule::initialise ( const std::vector< KinematicRange > &  kinematicRanges, const EventGeneratorInterface &  service  )

pure virtual

Initialize.

Implemented in EPIC::EventGeneratorFOAM.

runTest()

virtual bool EPIC::EventGeneratorModule::runTest ( ) const

virtual

Definition of test.

Implements EPIC::EpicModuleObject.

setInitStatePath()

void EPIC::EventGeneratorModule::setInitStatePath

(

const std::string &

initStatePath

)

Set path to state file.

---

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

• /Users/pawel/projects/epic/NEW2/epic/include/modules/event_generator/EventGeneratorModule.h