cepgen is hosted by Hepforge, IPPP Durham
CepGen 1.2.5
Central exclusive processes event generator
Loading...
Searching...
No Matches

Utility object to draw a grid values mapping. More...

#include <CepGen/Utils/GridDrawer.h>

+ Inheritance diagram for GridDrawer:
+ Collaboration diagram for GridDrawer:

Public Member Functions

bool operator== (const SteeredObject &oth) const
 Equality operator.
 
bool operator!= (const SteeredObject &oth) const
 Inequality operator.
 
const ParametersListparameters () 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 ()
 
template<size_t N>
static void draw (const GridHandler< 1, N > &, const Drawer::Mode &mode=Drawer::Mode::none)
 Debugging drawing routing for single-dimensional grids.
 
template<size_t N>
static void draw (const GridHandler< 2, N > &, const Drawer::Mode &mode=Drawer::Mode::none)
 Debugging drawing routing for double-dimensional grids.
 
template<size_t N>
static void draw (const GridHandler< 3, N > &, const Drawer::Mode &mode=Drawer::Mode::none)
 Debugging drawing routing for triple-dimensional grids.
 

Protected Member Functions

template<typename 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

ParametersList params_
 Module parameters.
 

Detailed Description

Definition at line 32 of file GridDrawer.h.

Member Function Documentation

◆ description()

ParametersDescription description ( )
static

Definition at line 94 of file GridDrawer.cpp.

◆ draw() [1/3]

template<size_t N>
void draw ( const GridHandler< 1, N > &  grid,
const Drawer::Mode mode = Drawer::Mode::none 
)
static

Definition at line 31 of file GridDrawer.cpp.

◆ draw() [2/3]

template<size_t N>
void draw ( const GridHandler< 2, N > &  grid,
const Drawer::Mode mode = Drawer::Mode::none 
)
static

Definition at line 48 of file GridDrawer.cpp.

◆ draw() [3/3]

template<size_t N>
void draw ( const GridHandler< 3, N > &  grid,
const Drawer::Mode mode = Drawer::Mode::none 
)
static

Definition at line 66 of file GridDrawer.cpp.

◆ operator!=()

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

Definition at line 51 of file SteeredObject.h.

◆ operator==()

bool operator== ( const SteeredObject< GridDrawer > &  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.

◆ setParameters()

virtual void setParameters ( const ParametersList params)
overridevirtualinherited

Reimplemented from Steerable.

Definition at line 62 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

Definition at line 30 of file Steerable.cpp.

Member Data Documentation

◆ params_

ParametersList params_
mutableprotectedinherited

Definition at line 50 of file Steerable.h.