Drawable Class Reference

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

#include <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
using	axis_t = std::map<coord_t, Value>
	Metadata for an axis (coordinates and bins value)
using	dual_axis_t = std::map<coord_t, axis_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.
AxisInfo &	xAxis ()
const AxisInfo &	xAxis () const
AxisInfo &	yAxis ()
const AxisInfo &	yAxis () const
AxisInfo &	zAxis ()
const AxisInfo &	zAxis () 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	x_axis_
	x-axis metadata
AxisInfo	y_axis_
	y-axis metadata
AxisInfo	z_axis_
	z-axis metadata

Detailed Description

Definition at line 30 of file Drawable.h.

Member Typedef Documentation

axis_t

using axis_t = std::map<coord_t, Value>

Definition at line 88 of file Drawable.h.

dual_axis_t

using dual_axis_t = std::map<coord_t, axis_t>

Definition at line 96 of file Drawable.h.

Constructor & Destructor Documentation

Drawable()

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

explicit

Definition at line 32 of file Drawable.h.

~Drawable()

virtual ~Drawable ( )

virtual

Definition at line 33 of file Drawable.h.

Member Function Documentation

isGraph1D()

virtual bool isGraph1D ( ) const

virtual

Reimplemented in Graph1D.

Definition at line 100 of file Drawable.h.

isGraph2D()

virtual bool isGraph2D ( ) const

virtual

Reimplemented in Graph2D.

Definition at line 101 of file Drawable.h.

isHist1D()

virtual bool isHist1D ( ) const

virtual

Reimplemented in Hist1D.

Definition at line 98 of file Drawable.h.

isHist2D()

virtual bool isHist2D ( ) const

virtual

Reimplemented in Hist2D.

Definition at line 99 of file Drawable.h.

name()

const std::string & name

(

)

const

Definition at line 35 of file Drawable.h.

setName()

void setName

(

const std::string &

name

)

Definition at line 36 of file Drawable.h.

setTitle()

void setTitle

(

const std::string &

title

)

Definition at line 39 of file Drawable.h.

title()

const std::string & title

(

)

const

Definition at line 38 of file Drawable.h.

xAxis() [1/2]

AxisInfo & xAxis

(

)

Definition at line 72 of file Drawable.h.

xAxis() [2/2]

const AxisInfo & xAxis

(

)

const

Definition at line 73 of file Drawable.h.

yAxis() [1/2]

AxisInfo & yAxis

(

)

Definition at line 74 of file Drawable.h.

yAxis() [2/2]

const AxisInfo & yAxis

(

)

const

Definition at line 75 of file Drawable.h.

zAxis() [1/2]

AxisInfo & zAxis

(

)

Definition at line 76 of file Drawable.h.

zAxis() [2/2]

const AxisInfo & zAxis

(

)

const

Definition at line 77 of file Drawable.h.

Member Data Documentation

name_

std::string name_

protected

Definition at line 104 of file Drawable.h.

title_

std::string title_

protected

Definition at line 105 of file Drawable.h.

x_axis_

AxisInfo x_axis_

protected

Definition at line 106 of file Drawable.h.

y_axis_

AxisInfo y_axis_

protected

Definition at line 107 of file Drawable.h.

z_axis_

AxisInfo z_axis_

protected

Definition at line 108 of file Drawable.h.