DocStringManager Class Reference

#include <DocStringManager.hxx>

Inheritance diagram for DocStringManager:

Public Member Functions
void	DocumentVar (const std::string &tree, const std::string &name, const std::string &doc, const std::string &type, int size1, const std::string &counter1, int size2, const std::string &counter2, int size3, const std::string &counter3)
void	ReadDocStrings (const std::string &file)
void	ExplainVar (const std::string &name, const std::string &tree_name)
	Print the details of the specified variable in the given tree.
void	ListVars (const std::string &tree_name)
	List all the variables that were stored in this tree.
Public Member Functions inherited from HLClonesArray
	HLClonesArray (const std::string &tree_name, const std::string &tcarray_name, const std::string &class_name, const UInt_t size)
void	ReadClonesArray (const std::string &file)
void	WriteClonesArray (TTree &tree)
Int_t &	GetNObjects ()
	Return the number of steps that have been added.
TClonesArray *	GetClonesArray ()
const std::string &	GetClonesArrayName () const
	Return the name of the TClonesArray.
const std::string &	GetTreeName () const
	Return the name of the tree.

Protected Attributes
std::vector< DocString * >	_docStrings
Protected Attributes inherited from HLClonesArray
TChain *	_chain
	TChain used to read the "config" tree from the output file.
Int_t	_NObjects
	The number of steps that were added.
TClonesArray *	_objects
std::string	_tcArrayName
	Name of the TClonesArray in the tree.
std::string	_treeName
	Name of the Tree.
std::string	_fileName
	Name of the last file read.

Detailed Description

This class is used to store and access documentation for the variables stored in the micro-trees.

This singleton class will store a TClonesArray of DocString objects into the "config" tree. When using the DrawingTools, the array will be read in, and the use can then use the DrawingTools functions to interrogate the information.

When adding a variable to the micro-tree, the DocumentVar function is called automatically. The user does not need to call this function themselves.

Definition at line 18 of file DocStringManager.hxx.

Member Function Documentation

DocumentVar()

void DocStringManager::DocumentVar ( const std::string &  tree, const std::string &  name, const std::string &  doc, const std::string &  type, int  size1, const std::string &  counter1, int  size2, const std::string &  counter2, int  size3, const std::string &  counter3  )

inline

Create the DocString object for this variable, and add it to the array that will be saved. See the DocString class documentation for the meaning of the parameters passed in here.

Definition at line 29 of file DocStringManager.hxx.

                                                                                                                                                                                                                                {
    DocString* newdoc = new((*_objects)[_NObjects++]) DocString(tree, name, doc, type, size1, counter1, size2, counter2, size3, counter3);
    _docStrings.push_back(newdoc);
  }

ReadDocStrings()

void DocStringManager::ReadDocStrings

(

const std::string &

file

)

Read the "config" tree from the given file, to read the docstrings that were used when running the analysis. This is used so we can access the info in the DrawingTools.

Definition at line 11 of file DocStringManager.cxx.

                                                          {
//********************************************************************

  ReadClonesArray(file);
}

---

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

• /hep/T2K/nd280rep/ANALYSIS/HIGHLAND2/ANAPARTICLE/highland2/highlandCore/v2r10/src/DocStringManager.hxx
• /hep/T2K/nd280rep/ANALYSIS/HIGHLAND2/ANAPARTICLE/highland2/highlandCore/v2r10/src/DocStringManager.cxx