Auxiliary classes and methods for ROOT I/O. More...

Classes
class	JAbstractStreamer
	Forward declaration of writer object. More...

struct	JAbstractTreeReader
	Interface for TTree reading. More...

class	JActionAtFileOpen
	Auxiliary class to handle version management of given class at opening of a ROOT file. More...

class	JActionAtFileRead
	Auxiliary class to handle version management of given class at reading from a ROOT file. More...

struct	JAddress
	Simple address wrapper. More...

class	JChainReader
	Auxiliary class for template TChain reading. More...

class	JClassDef
	Test ROOT ClassDef. More...

struct	JClassStreamer
	Auxiliary class to add the I/O capabilities of the given template class to the general JRootDictionary class. More...

struct	JFitParameter_t
	Auxiliary data structure for a parameter index and its value. More...

class	JObjectStreamer
	JObjectStreamer class. More...

struct	JRootAddress
	Auxiliary classd for address handling within TTree or TChain. More...

struct	JRootAddressableClass
	Auxiliary class to manage access to base classes and data members of ROOT class objects. More...

struct	JRootClass
	Auxiliary class to manage access to base classes and data members of ROOT class. More...

struct	JROOTClassSelection
	Auxiliary class for ROOT class selection. More...

struct	JROOTClassSelector
	Auxiliary class to select ROOT class based on class name. More...

class	JRootDictionary
	Default implementation of ROOT based dictionary for ASCII I/O. More...

struct	JRootDictionary_t
	Type definition of ROOT based dictionary for ASCII O. More...

class	JRootFile
	ROOT file. More...

class	JRootFileObjectOutput
	Implementation of object output to ROOT file for single data type. More...

class	JRootFileObjectOutput< JTypeList< JHead_t, JNullType > >
	Terminator class of recursive JRootObjectOutput class. More...

class	JRootFileObjectOutput< JTypeList< JHead_t, JTail_t > >
	Implementation of object output to ROOT file for multiple data types. More...

class	JRootFileReader
	ROOT file reader. More...

class	JRootFileReader< T, false >
	Tempate specialisation of JRootFileReader for TTree incompatible iteration. More...

class	JRootFileReader< T, true >
	Tempate specialisation of JRootFileReader for TTree compatible iteration. More...

class	JRootFileWriter
	ROOT file object output. More...

class	JRootInputFile
	ROOT input file. More...

struct	JRootLabel
	Replica of structure JLANG::JLabel for data types with ROOT I/O. More...

class	JRootObjectOutput
	Template definition of ROOT object output. More...

class	JRootObjectOutput< T, false >
	Implementation of object output using TDirectory::WriteTObject method. More...

class	JRootObjectOutput< T, true >
	Implementation of object output using TTree. More...

class	JRootOutputFile
	ROOT output file. More...

struct	JRootPrinter
	Auxiliary class for printing objects in ASCII format using JRootWriter. More...

struct	JRootReadableClass
	ROOT class for reading object. More...

class	JRootReader
	Implementation for ASCII input of objects with ROOT dictionary. More...

class	JRootStreamObjectOutput
	Template implementation of stream output for single data type based on ROOT dictionary. More...

class	JRootStreamObjectOutput< JTypeList< JHead_t, JNullType > >
	Terminator class of recursive JRootStreamObjectOutput class. More...

class	JRootStreamObjectOutput< JTypeList< JHead_t, JTail_t > >
	Template specialisationimplementation of stream object output for multiple data types. More...

struct	JRootWritableClass
	ROOT class for writing object. More...

class	JRootWriter
	Implementation for ASCII output of objects with ROOT dictionary. More...

class	JTreeCopyWriter
	Implementation for template TTree writing and copying. More...

struct	JTreeCopyWriterInterface
	Interface for template TTree writing and copying. More...

class	JTreeParameters
	Data structure for TTree parameters. More...

class	JTreeParametersAvailable
	Test availability of TTree parameters for given class. More...

class	JTreeReader
	Auxiliary class for template TTree reading. More...

class	JTreeReaderAccessibleObjectIterator
	JTemplateTreeReader object iterator. More...

class	JTreeReaderObjectIterator
	JTreeReader object iterator. More...

class	JTreeWriter
	Auxiliary class for template TTree writing. More...

class	JTreeWriterObjectOutput
	JTreeWriter object output. More...

class	JTreeWriterObjectOutput< JTypeList< JHead_t, JNullType > >
	Terminator class of recursive JTreeWriterObjectOutput class. More...

class	JTreeWriterObjectOutput< JTypeList< JHead_t, JTail_t > >
	Implementation of JTreeWriterObjectOutput for multiple data types. More...

Typedefs
typedef Long64_t	counter_type
	Type definition for counter. More...

Functions
counter_type	advance (counter_type &counter, const counter_type value, const counter_type limit=std::numeric_limits< counter_type >::max())
	Advance counter. More...

const TDataMember *	getDataMember (const JRootClass &parent, const JRootClass &member)
	Get ROOT data member for given parent and member class. More...

template<class JType_t , class JClass_t >
const TDataMember *	getDataMember (JType_t JClass_t::*pd)
	Get ROOT data member for given C++ data member. More...

template<class T >
std::set< JROOTClassSelector >	getROOTClassSelection ()
	Get ROOT class selection. More...

template<class T >
void	getObject (TFile file, const char key, T *&ps)
	Read object from ROOT file. More...

template<class T >
bool	putObject (TDirectory *dir, const T &object)
	Write object to ROOT directory. More...

template<class T >
void	actionAtFileOpen (TFile *file)
	General action method at file open. More...

template<class T >
void	actionAtFileRead (T *object)
	General action method at file read. More...

template<class T >
const char *	getName ()
	Get ROOT name of given data type. More...

template<class T >
const char *	getName (const JType< T > &type)
	Get ROOT name of given data type. More...

TFile &	operator<< (TFile &file, const TObject &object)
	Write object to ROOT file. More...

const TStreamerInfo *	getStreamerInfo (TFile file, const char name)
	Get ROOT streamer information of class with given name. More...

const TStreamerInfo *	getStreamerInfo (const char file_name, const char name)
	Get ROOT streamer information of class with given name. More...

int	getStreamerVersion (TFile file, const char name)
	Get ROOT streamer version of class with given name. More...

int	getStreamerVersion (const char file_name, const char name)
	Get ROOT streamer version of class with given name. More...

TString	parse (TPRegexp &regexp, const TString &string, int i=1)
	Match a TString to a TPRegexp, and return the chosen match. More...

bool	setParameter (TF1 &f1, const JFitParameter_t &parameter)
	Set fit parameter. More...

bool	fixParameter (TF1 &f1, const JFitParameter_t &parameter)
	Fix fit parameter. More...

bool	releaseParameter (TF1 &f1, const Int_t index)
	Release fit parameter. More...

bool	setParLimits (TF1 &f1, const Int_t index, Double_t xmin, Double_t xmax)
	Set fit parameter limits. More...

bool	isParameterFixed (TF1 &f1, const Int_t index)
	Check if fit parameter is fixed. More...

template<class T >
Double_t	getResult (const TString &text, const T &object, const JRootDictionary_t &dictionary=JRootDictionary::getInstance())
	Get result of given textual formula. More...

template<class T >
JTreeParameters	getTreeParameters ()
	Template definition for method returning TTree parameters. More...

template<class T >
JNullType	getTreeParameters (const JType< T > &type)
	Method with argument definition for obtaining TTree parameters. More...

template<class T >
JTreeCopyWriter< T > &	getTreeCopyWriter ()
	Get the TTree writer and copy for this type of object. More...

Detailed Description

Auxiliary classes and methods for ROOT I/O.

Author: mdejong

Typedef Documentation

◆ counter_type

typedef Long64_t JROOT::counter_type

Type definition for counter.

Definition at line 24 of file JCounter.hh.

Function Documentation

◆ advance()

counter_type JROOT::advance	(	counter_type &	counter,
		const counter_type	value,
		const counter_type	limit = `std::numeric_limits<counter_type>::max()`
	)

inline

Advance counter.

Parameters

counter	counter (I/O)
value	offset
limit	limit

Returns: increment

Definition at line 35 of file JCounter.hh.

   {
     const counter_type previous = counter;
         
     if (counter + value < limit)
       counter += value;
     else 
       counter  = limit;
     
     return counter - previous;
   }

◆ getDataMember() [1/2]

const TDataMember* JROOT::getDataMember	(	const JRootClass &	parent,
		const JRootClass &	member
	)

inline

Get ROOT data member for given parent and member class.

Parameters

parent	ROOT class
member	ROOT class

Returns: pointer to ROOT data member

Definition at line 634 of file JRootClass.hh.

   {
     if (parent.getClass() != NULL) {
  
       TIterator* i = NULL;
  
       i = parent.getClass()->GetListOfDataMembers()->MakeIterator();
     
       for (const TDataMember* p; (p = (const TDataMember*) i->Next()) != NULL; ) {
       
         const JRootClass abc = parent.get(*p);
       
         if (abc == member && abc.getOffset() == member.getOffset()) {
           return p;
         }
       }
  
       i = parent.getClass()->GetListOfBases()->MakeIterator();
           
       for (const TBaseClass* p; (p = (const TBaseClass*) i->Next()) != NULL; ) {
             
         if (JRootClass::is_class(*p) && !JRootClass::is_STLcontainer(*p)) {
               
           const TDataMember* q = getDataMember(parent.get(*p), member);
  
           if (q != NULL) {
             return q;
           } 
         }
       }
     }
  
     return NULL;
   }

◆ getDataMember() [2/2]

template<class JType_t , class JClass_t >

const TDataMember* JROOT::getDataMember ( JType_t JClass_t::* pd )

inline

Get ROOT data member for given C++ data member.

Parameters

pd	pointer to C++ data member

Returns: pointer to ROOT data member

Definition at line 678 of file JRootClass.hh.

   {
     return getDataMember(JRootClass(getType<JClass_t>()), JRootClass(pd));
   }

◆ getROOTClassSelection()

template<class T >

std::set<JROOTClassSelector> JROOT::getROOTClassSelection ( )

inline

Get ROOT class selection.

Returns: ROOT class selection

Definition at line 220 of file JROOTClassSelector.hh.

   {
     return JROOTClassSelection(JType<T>());
   }

◆ getObject()

template<class T >

void JROOT::getObject	(	TFile *	file,
		const char *	key,
		T *&	ps
	)

inline

Read object from ROOT file.

Parameters

file	pointer to file
key	key of object to be read
ps	pointer to object

Definition at line 42 of file JRootFileReader.hh.

   {
     if (file != NULL) {
       file->GetObject(key, ps);
     }
   }

◆ putObject()

template<class T >

bool JROOT::putObject	(	TDirectory *	dir,
		const T &	object
	)

inline

Write object to ROOT directory.

Parameters

dir	pointer to directory
object	object

Returns: true if OK; else false

Definition at line 38 of file JRootFileWriter.hh.

   {
     return (dir != NULL && dir->WriteTObject(&object) > 0);
   }

◆ actionAtFileOpen()

template<class T >

void JROOT::actionAtFileOpen ( TFile * file )

inline

General action method at file open.

The class T should provide the policy method:

   static void actionAtFileOpen(int version);

whenever an action specific to this data type has to be executed after opening a file.
This method will then be called following each file open operation.

Parameters

file	pointer to file

Definition at line 148 of file JRootSupportkit.hh.

   {
     if (file != NULL) {
       JActionAtFileOpen<T>::execute(file);
     }
   }

◆ actionAtFileRead()

template<class T >

void JROOT::actionAtFileRead ( T * object )

inline

General action method at file read.

The class T should provide the policy method:

   void actionAtFileRead();

whenever an action specific to this data type has to be executed after reading from a file.
This method will then be called following each file read operation.

Parameters

object pointer to object (I/O)

Definition at line 169 of file JRootSupportkit.hh.

   {
     if (object != NULL) {
       JActionAtFileRead<T>::execute(object);
     }
   }

◆ getName() [1/2]

template<class T >

const char* JROOT::getName ( )

inline

Get ROOT name of given data type.

Returns: name of object to be read

Definition at line 45 of file JRootToolkit.hh.

   {
     return getName(JType<T>());
   }

◆ getName() [2/2]

template<class T >

const char* JROOT::getName ( const JType< T > & type )

inline

Get ROOT name of given data type.

Parameters

type data type

Returns: name of object to be read

Definition at line 58 of file JRootToolkit.hh.

   {
     return T::Class_Name();
   }

◆ operator<<()

TFile& JROOT::operator<<	(	TFile &	file,
		const TObject &	object
	)

Write object to ROOT file.

Parameters

file	ROOT file
object	ROOT object

Returns: ROOT file

Definition at line 71 of file JRootToolkit.hh.

   {
     file.WriteTObject(&object);
  
     return file;
   }

◆ getStreamerInfo() [1/2]

const TStreamerInfo* JROOT::getStreamerInfo	(	TFile *	file,
		const char *	name
	)

inline

Get ROOT streamer information of class with given name.

Note that the class name should include the name space, if any.

Parameters

file	pointer to ROOT file
name	class name

Returns: pointer to TStreamerInfo (NULL in case of error)

Definition at line 87 of file JRootToolkit.hh.

   {
     if (file != NULL && file->IsOpen()) {
  
       const TString buffer(name);
         
       TIter iter(file->GetStreamerInfoList());
  
       for (const TStreamerInfo* pStreamerInfo; (pStreamerInfo = (TStreamerInfo*) iter.Next()) != NULL; ) {
         if (buffer == TString(pStreamerInfo->GetName())) {
           return pStreamerInfo;
         }
       }
     }
  
     return NULL;
   }

◆ getStreamerInfo() [2/2]

const TStreamerInfo* JROOT::getStreamerInfo	(	const char *	file_name,
		const char *	name
	)

inline

Get ROOT streamer information of class with given name.

Note that the class name should include the name space, if any.

Parameters

file_name	file name
name	class name

Returns: pointer to TStreamerInfo (NULL in case of error)

Definition at line 114 of file JRootToolkit.hh.

   {
     JRootInputFile file(file_name);
  
     return getStreamerInfo(file.getFile(), name);
   }

◆ getStreamerVersion() [1/2]

int JROOT::getStreamerVersion	(	TFile *	file,
		const char *	name
	)

inline

Get ROOT streamer version of class with given name.

Note that the class name should include the name space, if any.

Parameters

file	pointer to ROOT file
name	class name

Returns: streamer version; (-1 in case of error)

Definition at line 130 of file JRootToolkit.hh.

   {
     const TStreamerInfo* pStreamerInfo = getStreamerInfo(file, name);
     
     if (pStreamerInfo != NULL)
       return pStreamerInfo->GetClassVersion();
     else
       return -1;
   }

◆ getStreamerVersion() [2/2]

int JROOT::getStreamerVersion	(	const char *	file_name,
		const char *	name
	)

inline

Get ROOT streamer version of class with given name.

Note that the class name should include the name space, if any.

Parameters

file_name	file name
name	class name

Returns: streamer version; (-1 in case of error)

Definition at line 149 of file JRootToolkit.hh.

   {
     JRootInputFile file(file_name);
     
     return getStreamerVersion(file.getFile(), name);
   }

◆ parse()

TString JROOT::parse	(	TPRegexp &	regexp,
		const TString &	string,
		int	i = `1`
	)

inline

Match a TString to a TPRegexp, and return the chosen match.

If no matches are found corresponding to the indicated index, the original TString is returned.

Parameters

string	string to parse
regexp	regular expression
i	index of match to return

Returns: match; (original string in case that matches are not found)

Definition at line 167 of file JRootToolkit.hh.

   {
     TObjArray* a = regexp.MatchS(string);
     TString    s = string;
     if (a->GetLast() > i-1){
       s = ((TObjString*)a->At(i))->GetName();
     }
  
     return s;
   }

◆ setParameter()

bool JROOT::setParameter	(	TF1 &	f1,
		const JFitParameter_t &	parameter
	)

inline

Set fit parameter.

Parameters

f1	fit function
parameter	parameter index and value

Definition at line 228 of file JRootToolkit.hh.

   {
     if (parameter.index >= 0 && parameter.index < f1.GetNpar()) {
  
       f1.SetParameter(parameter.index, parameter.value);
  
       return true;
  
     } else {
  
       return false;
     }
   }

◆ fixParameter()

bool JROOT::fixParameter	(	TF1 &	f1,
		const JFitParameter_t &	parameter
	)

inline

Fix fit parameter.

Parameters

f1	fit function
parameter	parameter index and value

Definition at line 249 of file JRootToolkit.hh.

   {
     if (parameter.index >= 0 && parameter.index < f1.GetNpar()) {
  
       f1.FixParameter(parameter.index, parameter.value);
  
       return true;
  
     } else {
  
       return false;
     }
   }

◆ releaseParameter()

bool JROOT::releaseParameter	(	TF1 &	f1,
		const Int_t	index
	)

inline

Release fit parameter.

Parameters

f1	fit function
index	parameter index

Definition at line 270 of file JRootToolkit.hh.

   {
     if (index >= 0 && index < f1.GetNpar()) {
  
       f1.ReleaseParameter(index);
  
       return true;
  
     } else {
  
       return false;
     }
   }

◆ setParLimits()

bool JROOT::setParLimits	(	TF1 &	f1,
		const Int_t	index,
		Double_t	xmin,
		Double_t	xmax
	)

inline

Set fit parameter limits.

Parameters

f1	fit function
index	parameter index
xmin	lower limit
xmax	upper limit

Definition at line 293 of file JRootToolkit.hh.

   {
     using namespace std;
  
     if (index >= 0 && index < f1.GetNpar()) {
  
       if (xmin == 0.0) { xmin = -numeric_limits<Double_t>::min(); }
       if (xmax == 0.0) { xmax = +numeric_limits<Double_t>::min(); }
  
       f1.SetParLimits(index, xmin, xmax);
  
       return true;
  
     } else {
  
       return false;
     }
   }

◆ isParameterFixed()

bool JROOT::isParameterFixed	(	TF1 &	f1,
		const Int_t	index
	)

inline

Check if fit parameter is fixed.

Parameters

f1	fit function
index	parameter index

Definition at line 319 of file JRootToolkit.hh.

   {
     if (index >= 0 && index < f1.GetNpar()) {
  
       Double_t xmin;
       Double_t xmax;
     
       f1.GetParLimits(index, xmin, xmax);
     
       return (xmin != 0.0 && xmax != 0.0 && xmin >= xmax);
  
     } else {
       
       return false;
     }
   }

◆ getResult()

template<class T >

Double_t JROOT::getResult	(	const TString &	text,
		const T &	object,
		const JRootDictionary_t &	dictionary = `JRootDictionary::getInstance()`
	)

inline

Get result of given textual formula.

The formula may contain names of data members of the given object. Example:

        getResult("a/b", object, ..);

In this, the corresponding data type should have (at least) data members a and b.

Parameters

text	text
object	object
dictionary	dictionary

Returns: value

Definition at line 352 of file JRootToolkit.hh.

   {
     using namespace std;
     using namespace JPP;
  
     string buffer = (const char*) text;
  
     for (string::size_type pos = 0; pos != buffer.size(); ) {
  
       if (isalpha(buffer[pos]) || buffer[pos] == '_') {
  
         string::size_type len = 1;
  
         while (pos + len != buffer.size() && (isalnum(buffer[pos+len]) || buffer[pos+len] == '_' || buffer[pos+len] == '.')) {
           ++len;
         }
  
         ostringstream os;
  
         os.precision(10);
  
         JRootPrinter::print(os, object, buffer.substr(pos,len), dictionary);
  
         buffer.replace(pos, len, os.str());
  
         pos += os.str().size();
  
       } else {
  
         pos += 1;
       }
     }
  
     return TFormula("/tmp", buffer.c_str()).Eval(0.0);
   }

◆ getTreeParameters() [1/2]

template<class T >

JTreeParameters JROOT::getTreeParameters ( )

inline

Template definition for method returning TTree parameters.

The template argument refers to the class for which ROOT TTree I/O is desired.

Returns: TTree parameters

Definition at line 149 of file JTreeParameters.hh.

   {
     return getTreeParameters(JType<T>());
   }

◆ getTreeParameters() [2/2]

template<class T >

JNullType JROOT::getTreeParameters ( const JType< T > & type )

inline

Method with argument definition for obtaining TTree parameters.

The method argument refers to the class for which ROOT TTree I/O is desired. This method should then be overloaded and the overloaded method should return a JTreeParameters object with the corresponding TTree parameters.

Parameters

type data type

Returns: TTree parameters

◆ getTreeCopyWriter()

template<class T >

JTreeCopyWriter<T>& JROOT::getTreeCopyWriter ( )

inline

Get the TTree writer and copy for this type of object.

Returns: TTree writer and copy for this type of object

Definition at line 168 of file JTreeWriter.hh.

   {
     return JTreeCopyWriter<T>::getInstance();
   }

Classes

Typedefs

Functions

Detailed Description

Typedef Documentation

◆ counter_type

Function Documentation

◆ advance()

◆ getDataMember() [1/2]

◆ getDataMember() [2/2]

◆ getROOTClassSelection()

◆ getObject()

◆ putObject()

◆ actionAtFileOpen()

◆ actionAtFileRead()

◆ getName() [1/2]

◆ getName() [2/2]

◆ operator<<()

◆ getStreamerInfo() [1/2]

◆ getStreamerInfo() [2/2]

◆ getStreamerVersion() [1/2]

◆ getStreamerVersion() [2/2]

◆ parse()

◆ setParameter()

◆ fixParameter()

◆ releaseParameter()

◆ setParLimits()

◆ isParameterFixed()

◆ getResult()

◆ getTreeParameters() [1/2]

◆ getTreeParameters() [2/2]

◆ getTreeCopyWriter()