D3PDReader::VariableStats Class Reference

Class describing the access statistics of one variable. More...

#include <D3PDReadStats.h>

List of all members.

Public Member Functions
	VariableStats (const char *name="d3pd_variable", const char *type="Int_t",::Int_t nTreesAccessed=0,::Long64_t nReadEntries=0,::Long64_t nUnzippedBytes=0,::Long64_t nZippedBytes=0)
	Constructor specifying all parameters.
	VariableStats (const VariableStats &parent)
	Copy constructor.
VariableStats &	operator= (const VariableStats &parent)
	Assignment operator.
::Int_t	GetTreesAccessed () const
	Get how many trees were accessed to read this variable.
void	SetTreesAccessed (::Int_t nTreesAccessed)
	Set how many trees were accessed to read this variable.
::Long64_t	GetReadEntries () const
	Get how many entries were read from this branch.
void	SetReadEntries (::Long64_t nReadEntries)
	Set how many entries were read from this branch.
::Long64_t	GetUnzippedBytesRead () const
	Get how many unzipped bytes were read from this branch in total.
void	SetUnzippedBytesRead (::Long64_t nUnzippedBytes)
	Set how many unzipped bytes were read from this branch in total.
::Long64_t	GetZippedBytesRead () const
	Get how many zipped bytes were read from this branch in total.
void	SetZippedBytesRead (::Long64_t nZippedBytes)
	Set how many zipped bytes were read from this branch in total.
VariableStats &	Add (const VariableStats &rh)
	Function merging two objects.
VariableStats &	operator+= (const VariableStats &rh)
	Operator merging two objects.
::Int_t	Merge (::TCollection *coll)
	Function merging the information from multiple objects.
void	Print (::Option_t *option="") const
	Print information about the collected statistics.

---

Detailed Description

Class describing the access statistics of one variable.

Objects of this class are used to describe a single D3PD variable's access pattern.

Author:

Attila Krasznahorkay <Attila.Krasznahorkay@cern.ch>

$Revision$ $Date$

---

Constructor & Destructor Documentation

D3PDReader::VariableStats::VariableStats	(	const char *	name = "d3pd_variable",
		const char *	type = "Int_t",
		::Int_t	nTreesAccessed = 0,
		::Long64_t	nReadEntries = 0,
		::Long64_t	nUnzippedBytes = 0,
		::Long64_t	nZippedBytes = 0
	)

Constructor specifying all parameters.

The constructor can specify all properties of the object in one go. All the parameters take a default value, to make it possible to create the object without giving the constructor any parameters. (Needed by CINT.)

Parameters:

name	Name of the variable being described
type	Full type name of the variable being described
nTreesAccessed	Number of TTrees accessed to read this variable
nReadEntries	Number of GetEntry(...) operations performed on this variable
nUnzippedBytes	Number of bytes read after decompression
nZippedBytes	Number of bytes physically read from disk

D3PDReader::VariableStats::VariableStats

(

const VariableStats &

parent

)

Copy constructor.

It's probably not needed actually, but I wanted to be explicit about how the copy constructor should behave.

Parameters:

parent

The object that's being copied

---

Member Function Documentation

Int_t D3PDReader::VariableStats::Merge

(

::TCollection *

coll

)

Function merging the information from multiple objects.

This function makes it possible to properly merge objects coming from PROOF workers.

Parameters:

coll	A collection of D3PDReader::VariableStats objects

Returns:

0 in case of failure, a positive number in case of success

VariableStats & D3PDReader::VariableStats::operator=

(

const VariableStats &

parent

)

Assignment operator.

The assignment operator is quite an important piece of code, as it's used all the time when using such objects in STL containers.

Parameters:

parent

The object that's being copied

Returns:

A reference to the copied object

void D3PDReader::VariableStats::Print

(

::Option_t *

option = ""

)

const

Print information about the collected statistics.

Standard ROOT printing function. It prints all information about the statistics gathered about a single D3PD variable.

The option parameter understands the following value(s):

• "All": Prints the most verbose information available

Parameters:

option

Possible options for the printing verbosity

---

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

• SusyNtuple/D3PDReadStats.h
• Root/D3PDReadStats.cxx