BDSIM
BDSIM is a Geant4 extension toolkit for simulation of particle transport in accelerator beamlines.
Loading...
Searching...
No Matches
Public Member Functions | Data Fields | Friends
HistogramDef Class Referenceabstract

Common specification for a histogram. More...

#include <HistogramDef.hh>

Inheritance diagram for HistogramDef:
Inheritance graph
Collaboration diagram for HistogramDef:
Collaboration graph

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 HistogramDefClone () 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.
 
 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 35 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.

Friends And Related Function Documentation

◆ operator<<

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

Print out the definition in the original syntax.

Definition at line 49 of file HistogramDef.cc.

Field Documentation

◆ histName

std::string HistogramDef::histName

Definition at line 61 of file HistogramDef.hh.

◆ nDimensions

int HistogramDef::nDimensions

Definition at line 62 of file HistogramDef.hh.

◆ perEntry

bool HistogramDef::perEntry

Definition at line 65 of file HistogramDef.hh.

◆ selection

std::string HistogramDef::selection

Definition at line 64 of file HistogramDef.hh.

◆ treeName

std::string HistogramDef::treeName

Definition at line 60 of file HistogramDef.hh.

◆ variable

std::string HistogramDef::variable

Definition at line 63 of file HistogramDef.hh.


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