cepgen is hosted by Hepforge, IPPP Durham
CepGen N/A
Central exclusive processes event generator
Classes | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
DocumentationGenerator Class Referenceabstract

Documentation generator object. More...

#include <include/CepGen/Utils/DocumentationGenerator.h>

+ Inheritance diagram for DocumentationGenerator:
+ Collaboration diagram for DocumentationGenerator:

Classes

struct  category_t
 

Public Member Functions

 DocumentationGenerator (const ParametersList &)
 
 ~DocumentationGenerator () override=default
 
virtual std::string describe ()=0
 
const std::string & name () const
 Module unique indexing name.
 
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.
 
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

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 recast 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

std::vector< std::pair< std::string, category_t > > categories_
 
const std::string name_
 Module unique indexing name.
 
ParametersList params_
 Module parameters.
 

Detailed Description

Author
Laurent Forthomme laure.nosp@m.nt.f.nosp@m.ortho.nosp@m.mme@.nosp@m.cern..nosp@m.ch
Date
Mar 2024

Definition at line 28 of file DocumentationGenerator.h.

Class Documentation

◆ cepgen::utils::DocumentationGenerator::category_t

struct cepgen::utils::DocumentationGenerator::category_t

Definition at line 38 of file DocumentationGenerator.h.

Class Members
string description
map< string, ParametersDescription > modules {}
map< string, int > modules_indices {}
string name
string title

Constructor & Destructor Documentation

◆ DocumentationGenerator()

DocumentationGenerator ( const ParametersList & )
explicit

◆ ~DocumentationGenerator()

~DocumentationGenerator ( )
overridedefault

Member Function Documentation

◆ describe()

virtual std::string describe ( )
pure virtual

◆ description()

static ParametersDescription description ( )
static

◆ name()

const std::string & name ( ) const
inherited

Definition at line 42 of file NamedModule.h.

◆ operator!=()

template<typename T >
bool operator!= ( const SteeredObject< T > & oth) const
inherited

Definition at line 50 of file SteeredObject.h.

◆ operator==()

template<typename T >
bool operator== ( const SteeredObject< T > & oth) const
inherited

Definition at line 48 of file SteeredObject.h.

◆ parameters()

template<typename T >
const ParametersList & parameters ( ) const
overridevirtualinherited

Reimplemented from Steerable.

Definition at line 53 of file SteeredObject.h.

◆ setDescribedParameters()

template<typename T >
void setDescribedParameters ( const ParametersList & params_orig)
inherited

Definition at line 72 of file SteeredObject.h.

◆ setParameters()

template<typename T >
void setParameters ( const ParametersList & )
overridevirtualinherited

Reimplemented from Steerable.

Definition at line 61 of file SteeredObject.h.

◆ 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

Member Data Documentation

◆ categories_

std::vector<std::pair<std::string, category_t> > categories_
protected

Definition at line 43 of file DocumentationGenerator.h.

◆ name_

const std::string name_
protectedinherited

Definition at line 45 of file NamedModule.h.

◆ params_

ParametersList params_
mutableprotectedinherited

Definition at line 50 of file Steerable.h.