HistogramDef Class Reference

Common specification for a histogram. More...

#include <HistogramDef.hh>

Inheritance diagram for HistogramDef:

Collaboration diagram for HistogramDef:

Public Member Functions
	HistogramDef ()
	Public constructor only for compatibility with ROOT - not intended for use.
	HistogramDef (const std::string &treeNameIn, const std::string &histNameIn, int nDimensionsIn, const std::string &variable, const std::string &selectionIn="1", bool perEnetry=true)
	Use this constructor.
virtual HistogramDef *	Clone () const =0
	Copy this instance. Virtual to be overridden in derived classes.
virtual std::string	GetBinningString () const =0
	Provide the binning string in the original input format for feedback.
virtual std::string	GetHistogramString () const =0
	Get the first string that defines the histogram in rebdsim for feedback.
void	ReplaceStringInVariable (const std::string &match, const std::string &replacement)
	Little utility function.
	ClassDef (HistogramDef, 1)

Data Fields
std::string	treeName
std::string	histName
int	nDimensions
std::string	variable
std::string	selection
bool	perEntry

Friends
std::ostream &	operator<< (std::ostream &out, const HistogramDef &s)
	Print out the definition in the original syntax.

Detailed Description

Common specification for a histogram.

Author

L. Nevay

Definition at line 33 of file HistogramDef.hh.

Constructor & Destructor Documentation

HistogramDef()

HistogramDef::HistogramDef	(	const std::string &	treeNameIn,
		const std::string &	histNameIn,
		int	nDimensionsIn,
		const std::string &	variable,
		const std::string &	selectionIn = "1",
		bool	perEnetry = true
	)

Use this constructor.

Definition at line 36 of file HistogramDef.cc.

~HistogramDef()

virtual HistogramDef::~HistogramDef ( )

inlinevirtual

Definition at line 46 of file HistogramDef.hh.

Member Function Documentation

Clone()

virtual HistogramDef * HistogramDef::Clone ( ) const

pure virtual

Copy this instance. Virtual to be overridden in derived classes.

Implemented in HistogramDef1D, HistogramDef2D, and HistogramDef3D.

GetBinningString()

virtual std::string HistogramDef::GetBinningString ( ) const

pure virtual

Provide the binning string in the original input format for feedback.

Implemented in HistogramDef1D, HistogramDef2D, HistogramDef3D, and HistogramDef4D.

GetHistogramString()

virtual std::string HistogramDef::GetHistogramString ( ) const

pure virtual

Get the first string that defines the histogram in rebdsim for feedback.

Implemented in HistogramDef1D, HistogramDef2D, HistogramDef3D, and HistogramDef4D.

ReplaceStringInVariable()

void HistogramDef::ReplaceStringInVariable	(	const std::string &	match,
		const std::string &	replacement
	)

Little utility function.

Definition at line 58 of file HistogramDef.cc.

Friends And Related Symbol Documentation

operator<<

std::ostream & operator<< ( std::ostream &  out, const HistogramDef &  s  )

friend

Print out the definition in the original syntax.

Definition at line 50 of file HistogramDef.cc.

Field Documentation

histName

std::string HistogramDef::histName

Definition at line 65 of file HistogramDef.hh.

nDimensions

int HistogramDef::nDimensions

Definition at line 66 of file HistogramDef.hh.

perEntry

bool HistogramDef::perEntry

Definition at line 69 of file HistogramDef.hh.

selection

std::string HistogramDef::selection

Definition at line 68 of file HistogramDef.hh.

treeName

std::string HistogramDef::treeName

Definition at line 64 of file HistogramDef.hh.

variable

std::string HistogramDef::variable

Definition at line 67 of file HistogramDef.hh.

---

The documentation for this class was generated from the following files:

• /__w/bdsim/bdsim/analysis/HistogramDef.hh
• /__w/bdsim/bdsim/analysis/HistogramDef.cc