Drawer Class Reference

A generic drawing utility. More...

#include <CepGen/Utils/Drawer.h>

Inheritance diagram for Drawer:

Collaboration diagram for Drawer:

Classes
class	Mode

Public Member Functions
	Drawer (const ParametersList &params)
	Build a drawing utility.
virtual const Drawer &	draw (const Graph1D &, const Mode &mode=Mode::none) const =0
	Draw a one-dimensional graph.
virtual const Drawer &	draw (const Graph2D &, const Mode &mode=Mode::none) const =0
	Draw a two-dimensional graph.
virtual const Drawer &	draw (const Hist1D &, const Mode &mode=Mode::none) const =0
	Draw a one-dimensional histogram.
virtual const Drawer &	draw (const Hist2D &, const Mode &mode=Mode::none) const =0
	Draw a two-dimensional histogram.
virtual const Drawer &	draw (const DrawableColl &, const std::string &name="", const std::string &title="", const Mode &mode=Mode::none) const =0
	Draw a collection of drawables.
virtual std::ostream &	operator<< (std::ostream &os) const
	Output operator (when necessary)
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.
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 ()
	Describe all steering parameters for this module.

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 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 std::string	name_
	Module unique indexing name.
ParametersList	params_
	Module parameters.

Friends
class	Drawable
class	Graph1D
class	Graph2D
class	Hist1D
class	Hist2D

Detailed Description

Definition at line 36 of file Drawer.h.

Constructor & Destructor Documentation

Drawer()

Drawer ( const ParametersList &  params )

explicit

Definition at line 28 of file Drawer.cpp.

Member Function Documentation

description()

static ParametersDescription description ( )

staticinherited

Definition at line 36 of file NamedModule.h.

draw() [1/5]

virtual const Drawer & draw ( const DrawableColl &  , const std::string &  name = "", const std::string &  title = "", const Mode &  mode = Mode::none  ) const

pure virtual

Implemented in TextDrawer, GnuplotDrawer, MatplotlibDrawer, YODADrawer< T >, TopdrawerDrawer, and Drawer.

draw() [2/5]

virtual const Drawer & draw ( const Graph1D &  , const Mode &  mode = Mode::none  ) const

pure virtual

Implemented in TextDrawer, GnuplotDrawer, MatplotlibDrawer, TopdrawerDrawer, YODADrawer< T >, and Drawer.

draw() [3/5]

virtual const Drawer & draw ( const Graph2D &  , const Mode &  mode = Mode::none  ) const

pure virtual

Implemented in TextDrawer, GnuplotDrawer, MatplotlibDrawer, TopdrawerDrawer, YODADrawer< T >, and Drawer.

draw() [4/5]

virtual const Drawer & draw ( const Hist1D &  , const Mode &  mode = Mode::none  ) const

pure virtual

Implemented in TextDrawer, GnuplotDrawer, MatplotlibDrawer, TopdrawerDrawer, YODADrawer< T >, and Drawer.

draw() [5/5]

virtual const Drawer & draw ( const Hist2D &  , const Mode &  mode = Mode::none  ) const

pure virtual

Implemented in TextDrawer, GnuplotDrawer, MatplotlibDrawer, TopdrawerDrawer, YODADrawer< T >, and Drawer.

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 51 of file SteeredObject.h.

operator<<()

virtual std::ostream & operator<< ( std::ostream &  os ) const

virtual

Definition at line 84 of file Drawer.h.

operator==()

template<typename T >

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

inherited

Definition at line 49 of file SteeredObject.h.

parameters()

template<typename T >

const ParametersList & parameters ( ) const

overridevirtualinherited

Reimplemented from Steerable.

Definition at line 54 of file SteeredObject.h.

setDescribedParameters()

template<typename T >

void setDescribedParameters ( const ParametersList &  params_orig )

inherited

Definition at line 73 of file SteeredObject.h.

setParameters()

template<typename T >

virtual void setParameters ( const ParametersList &  params )

overridevirtualinherited

Reimplemented from Steerable.

Reimplemented in Initial, Remnants, CutsList, IncomingBeams, and Kinematics.

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.

Friends And Related Symbol Documentation

Drawable

friend class Drawable

friend

Definition at line 87 of file Drawer.h.

Graph1D

friend class Graph1D

friend

Definition at line 88 of file Drawer.h.

Graph2D

friend class Graph2D

friend

Definition at line 89 of file Drawer.h.

Hist1D

friend class Hist1D

friend

Definition at line 90 of file Drawer.h.

Hist2D

friend class Hist2D

friend

Definition at line 91 of file Drawer.h.

Member Data Documentation

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.