cepgen is hosted by Hepforge, IPPP Durham
CepGen 1.2.3
A generic central exclusive processes event generator
Loading...
Searching...
No Matches
Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
SpringGeneratorWorker Class Referencefinal
+ Inheritance diagram for SpringGeneratorWorker:
+ Collaboration diagram for SpringGeneratorWorker:

Public Member Functions

 SpringGeneratorWorker (const ParametersList &params)
 
virtual ~SpringGeneratorWorker ()
 
void initialise () override
 Initialise the generation parameters.
 
bool next () override
 Generate a single event.
 
void setRunParameters (const RunParameters *)
 Specify the runtime parameters.
 
void setIntegrator (const Integrator *integ)
 Specify the integrator instance handled by the mother generator.
 
void generate (size_t num_events, const std::function< void(const proc::Process &)> &)
 Launch the event generation.
 
ProcessIntegrand & integrand ()
 Function evaluator.
 
bool operator== (const SteeredObject &oth) const
 Equality operator.
 
bool operator!= (const SteeredObject &oth) const
 Inequality operator.
 
const ParametersList & parameters () const override
 Module user-defined parameters.
 
virtual void setParameters (const ParametersList &params) override
 Set module parameters.
 
void setDescribedParameters (const ParametersList &params_orig)
 Set (documented) module parameters.
 

Static Public Member Functions

static ParametersDescription description ()
 

Protected Member Functions

bool storeEvent ()
 Store the event in the output file.
 
template<typename T >
T steer (const std::string &key) const
 Retrieve a parameters as previously steered.
 
template<typename T , typename U >
U steerAs (const std::string &key) const
 Retrieve a recasted parameters as previously steered.
 
std::string steerName () const
 Retrieve module name from parameters.
 
std::string steerPath (const std::string &key) const
 Retrieve a path from common search paths.
 

Protected Attributes

const Integrator * integrator_ {nullptr}
 Pointer to the mother-handled integrator instance.
 
const RunParameters * params_ {nullptr}
 Steering parameters for the event generation.
 
std::unique_ptr< ProcessIntegrand > integrand_
 Local event weight evaluator.
 
std::function< void(const proc::Process &)> callback_proc_ {nullptr}
 Callback function for each new event.
 

Detailed Description

Definition at line 31 of file SpringGeneratorWorker.cpp.

Constructor & Destructor Documentation

◆ SpringGeneratorWorker()

SpringGeneratorWorker ( const ParametersList &  params)
explicit

Definition at line 33 of file SpringGeneratorWorker.cpp.

◆ ~SpringGeneratorWorker()

virtual ~SpringGeneratorWorker ( )
virtual

Definition at line 37 of file SpringGeneratorWorker.cpp.

Member Function Documentation

◆ description()

static ParametersDescription description ( )
static

Definition at line 66 of file SpringGeneratorWorker.cpp.

◆ generate()

void generate ( size_t  num_events,
const std::function< void(const proc::Process &)> &  callback 
)
inherited
Parameters
[in]num_eventsNumber of events to generate
[in]callbackThe callback function applied on every event generated

Definition at line 50 of file GeneratorWorker.cpp.

◆ initialise()

void initialise ( )
overridevirtual

Implements GeneratorWorker.

Definition at line 42 of file SpringGeneratorWorker.cpp.

◆ integrand()

ProcessIntegrand & integrand ( )
inherited

Definition at line 47 of file GeneratorWorker.h.

◆ next()

bool next ( )
overridevirtual

Implements GeneratorWorker.

Definition at line 47 of file SpringGeneratorWorker.cpp.

◆ operator!=()

bool operator!= ( const SteeredObject< GeneratorWorker > &  oth) const
inherited

Definition at line 51 of file SteeredObject.h.

◆ operator==()

bool operator== ( const SteeredObject< GeneratorWorker > &  oth) const
inherited

Definition at line 49 of file SteeredObject.h.

◆ parameters()

const ParametersList & parameters ( ) const
overridevirtualinherited

Reimplemented from Steerable.

Definition at line 54 of file SteeredObject.h.

◆ setDescribedParameters()

void setDescribedParameters ( const ParametersList &  params_orig)
inherited

Definition at line 73 of file SteeredObject.h.

◆ setIntegrator()

void setIntegrator ( const Integrator *  integ)
inherited

Definition at line 44 of file GeneratorWorker.cpp.

◆ setParameters()

virtual void setParameters ( const ParametersList &  params)
overridevirtualinherited

Reimplemented from Steerable.

Definition at line 62 of file SteeredObject.h.

◆ setRunParameters()

void setRunParameters ( const RunParameters *  params)
inherited

Definition at line 33 of file GeneratorWorker.cpp.

◆ steer()

template<typename T >
T steer ( const std::string &  key) const
protectedinherited

Definition at line 39 of file Steerable.h.

◆ steerAs()

template<typename T , typename U >
U steerAs ( const std::string &  key) const
protectedinherited

Definition at line 44 of file Steerable.h.

◆ steerName()

std::string steerName ( ) const
protectedinherited

Definition at line 48 of file Steerable.h.

◆ steerPath()

std::string steerPath ( const std::string &  key) const
protectedinherited

Definition at line 30 of file Steerable.cpp.

◆ storeEvent()

bool storeEvent ( )
protectedinherited
Returns
A boolean stating whether or not the event was successfully saved

Definition at line 58 of file GeneratorWorker.cpp.

Member Data Documentation

◆ callback_proc_

std::function<void(const proc::Process&)> callback_proc_ {nullptr}
protectedinherited

Definition at line 62 of file GeneratorWorker.h.

◆ integrand_

std::unique_ptr<ProcessIntegrand> integrand_
protectedinherited

Definition at line 61 of file GeneratorWorker.h.

◆ integrator_

const Integrator* integrator_ {nullptr}
protectedinherited

Definition at line 58 of file GeneratorWorker.h.

◆ params_

const RunParameters* params_ {nullptr}
protectedinherited

Definition at line 59 of file GeneratorWorker.h.