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

A generic object which can be drawn in the standard output. More...

#include <CepGen/Utils/Drawable.h>

+ Inheritance diagram for Drawable:
+ Collaboration diagram for Drawable:

Classes

class  AxisInfo
 Metadata for an axis. More...
 
struct  CompareAxisByValue
 Comparator of an axis by the values it holds. More...
 
struct  coord_t
 Generic bin coordinate and its human-readable label. More...
 

Public Types

typedef std::map< coord_t, Valueaxis_t
 Metadata for an axis (coordinates and bins value)
 
typedef std::map< coord_t, axis_tdualaxis_t
 Metadata for a two-dimensional axis definition (coordinates and bins values)
 

Public Member Functions

 Drawable (const std::string &name="", const std::string &title="")
 
virtual ~Drawable ()
 
const std::string & name () const
 Drawable name.
 
void setName (const std::string &name)
 Set the drawable name.
 
const std::string & title () const
 Drawable name.
 
void setTitle (const std::string &title)
 Set the drawable title.
 
AxisInfoxAxis ()
 
const AxisInfoxAxis () const
 
AxisInfoyAxis ()
 
const AxisInfoyAxis () const
 
AxisInfozAxis ()
 
const AxisInfozAxis () const
 
virtual bool isHist1D () const
 Is this drawable a one-dimensional histogram?
 
virtual bool isHist2D () const
 Is this drawable a two-dimensional histogram?
 
virtual bool isGraph1D () const
 Is this drawable a one-dimensional graph?
 
virtual bool isGraph2D () const
 Is this drawable a two-dimensional graph?
 

Protected Attributes

std::string name_
 Computer-readable name.
 
std::string title_
 Human-readable title.
 
AxisInfo xaxis_
 x-axis metadata
 
AxisInfo yaxis_
 y-axis metadata
 
AxisInfo zaxis_
 z-axis metadata
 

Detailed Description

Definition at line 31 of file Drawable.h.

Member Typedef Documentation

◆ axis_t

typedef std::map<coord_t, Value> axis_t

Definition at line 95 of file Drawable.h.

◆ dualaxis_t

typedef std::map<coord_t, axis_t> dualaxis_t

Definition at line 103 of file Drawable.h.

Constructor & Destructor Documentation

◆ Drawable()

Drawable ( const std::string &  name = "",
const std::string &  title = "" 
)
explicit

Definition at line 33 of file Drawable.h.

◆ ~Drawable()

virtual ~Drawable ( )
virtual

Definition at line 34 of file Drawable.h.

Member Function Documentation

◆ isGraph1D()

virtual bool isGraph1D ( ) const
virtual

Reimplemented in Graph1D.

Definition at line 107 of file Drawable.h.

◆ isGraph2D()

virtual bool isGraph2D ( ) const
virtual

Reimplemented in Graph2D.

Definition at line 108 of file Drawable.h.

◆ isHist1D()

virtual bool isHist1D ( ) const
virtual

Reimplemented in Hist1D.

Definition at line 105 of file Drawable.h.

◆ isHist2D()

virtual bool isHist2D ( ) const
virtual

Reimplemented in Hist2D.

Definition at line 106 of file Drawable.h.

◆ name()

const std::string & name ( ) const

Definition at line 37 of file Drawable.h.

◆ setName()

void setName ( const std::string &  name)

Definition at line 39 of file Drawable.h.

◆ setTitle()

void setTitle ( const std::string &  title)

Definition at line 44 of file Drawable.h.

◆ title()

const std::string & title ( ) const

Definition at line 42 of file Drawable.h.

◆ xAxis() [1/2]

AxisInfo & xAxis ( )

Definition at line 79 of file Drawable.h.

◆ xAxis() [2/2]

const AxisInfo & xAxis ( ) const

Definition at line 80 of file Drawable.h.

◆ yAxis() [1/2]

AxisInfo & yAxis ( )

Definition at line 81 of file Drawable.h.

◆ yAxis() [2/2]

const AxisInfo & yAxis ( ) const

Definition at line 82 of file Drawable.h.

◆ zAxis() [1/2]

AxisInfo & zAxis ( )

Definition at line 83 of file Drawable.h.

◆ zAxis() [2/2]

const AxisInfo & zAxis ( ) const

Definition at line 84 of file Drawable.h.

Member Data Documentation

◆ name_

std::string name_
protected

Definition at line 111 of file Drawable.h.

◆ title_

std::string title_
protected

Definition at line 112 of file Drawable.h.

◆ xaxis_

AxisInfo xaxis_
protected

Definition at line 113 of file Drawable.h.

◆ yaxis_

AxisInfo yaxis_
protected

Definition at line 114 of file Drawable.h.

◆ zaxis_

AxisInfo zaxis_
protected

Definition at line 115 of file Drawable.h.