Description

Generic meta-information for n-tuple (can be used out of Darwin).

Generic class to read the meta-information contained in a list. The original goal is to read and write information to store in the list TTree::GetUserInfo(), but it can be used in general.

The elements of the list may simply be reached with UserInfo::Get() and written with UserInfo::Set(). The list may contain simple types such as arithmetic types or literals as well as other lists. To reach a list, the Get and Set function simply need the list of keys to navigate through the tree structure, provided with additional arguments. Examples:

UserInfo ui;
ui.Set<bool>("one", "two", "myBool", true);
cout << ui.Get<bool>("one", "two", "myBool") << endl; // will print true
cout << ui.Get<string>("this", "will", "fail") << endl;

The whole information may be extracted in JSON, INFO, or XML format with Darwin::Tools::UserInfo::Write().

This class is as generic as can be. In certain cases, one may want to use inherit from this class to enforce a more rigid structure. One example is Darwin::Tools::MetaInfo.

#include <UserInfo.h>

Inheritance diagram for UserInfo:

Public Types
enum	Format { INFO, JSON, XML, INFO, JSON, XML }

enum	Format { INFO, JSON, XML, INFO, JSON, XML }

Public Member Functions
template<typename... Args>
TList *	List (const char *key, Args... args) const

TList *	List () const

template<class T , typename... Args>
T	Get (const char *key, Args... args) const

template<typename... Args>
bool	Find (const char *key, Args... args) const

template<class T , typename... Args>
void	Set (const char *key, Args... args) const

	UserInfo (const char *="UserInfo")

	UserInfo (const boost::property_tree::ptree &)

	UserInfo (TList *)

	UserInfo (TTree *)

	UserInfo (TTree *, const boost::property_tree::ptree &)

	~UserInfo ()

void	Write () const

bool	Empty () const

boost::property_tree::ptree	Write (std::ostream &, Format=INFO) const

boost::property_tree::ptree	Write (const std::filesystem::path &) const

boost::property_tree::ptree	MkPtree (Format format=INFO) const

void	ls () const

template<typename... Args>
TList *	List (const char *key, Args... args) const

TList *	List () const

template<class T , typename... Args>
T	Get (const char *key, Args... args) const

template<typename... Args>
bool	Find (const char *key, Args... args) const

template<class T , typename... Args>
void	Set (const char *key, Args... args) const

	UserInfo (const char *="UserInfo")

	UserInfo (const boost::property_tree::ptree &)

	UserInfo (TList *)

	UserInfo (TTree *)

	UserInfo (TTree *, const boost::property_tree::ptree &)

	~UserInfo ()

void	Write () const

bool	Empty () const

boost::property_tree::ptree	Write (std::ostream &, Format=INFO) const

boost::property_tree::ptree	Write (const std::filesystem::path &) const

boost::property_tree::ptree	MkPtree (Format format=INFO) const

void	ls () const

Protected Member Functions
void	ConvertPtree (const boost::property_tree::ptree &, const std::string &, TList *)

boost::property_tree::ptree	MkPtree (TList *, Format=INFO) const

boost::property_tree::ptree	Write (const boost::property_tree::ptree &, std::ostream &, Format=INFO) const

void	ConvertPtree (const boost::property_tree::ptree &, const std::string &, TList *)

boost::property_tree::ptree	MkPtree (TList *, Format=INFO) const

boost::property_tree::ptree	Write (const boost::property_tree::ptree &, std::ostream &, Format=INFO) const

Private Member Functions
TList *	List (TList mother, const char key) const

template<class T >
T	Get (TList mother, const char key) const

template<class T , typename... Args>
T	Get (TList mother, const char key, Args... args) const

bool	Find (TList mother, const char key) const

template<typename... Args>
bool	Find (TList mother, const char key, Args... args) const

void	CheckKey (const char *key) const

template<class T >
void	Set (TList mother, const char key, T value) const

template<class T , typename... Args>
void	Set (TList mother, const char key, Args... args) const

template<typename... Args>
TList *	List (TList mother, const char key, Args... args) const

template<class T >
T	Get (TList *mother, std::string key) const

bool	Find (TList *mother, std::string key) const

TList *	List (TList *mother, std::string key) const

TList *	List (TList mother, const char key) const

template<class T >
T	Get (TList mother, const char key) const

template<class T , typename... Args>
T	Get (TList mother, const char key, Args... args) const

bool	Find (TList mother, const char key) const

template<typename... Args>
bool	Find (TList mother, const char key, Args... args) const

void	CheckKey (const char *key) const

template<class T >
void	Set (TList mother, const char key, T value) const

template<class T , typename... Args>
void	Set (TList mother, const char key, Args... args) const

template<typename... Args>
TList *	List (TList mother, const char key, Args... args) const

template<class T >
T	Get (TList *mother, std::string key) const

bool	Find (TList *mother, std::string key) const

TList *	List (TList *mother, std::string key) const

Private Attributes
bool	own

TList *	l

Member Enumeration Documentation

◆ Format [1/2]

enum Format

Supported serialization formats.

Enumerator
INFO	INFO format, proper to Boost Property Trees (default)
JSON	JSON format, rather common and nearly as powerful.
XML	XML format, another universal format.
INFO	INFO format, proper to Boost Property Trees (default)
JSON	JSON format, rather common and nearly as powerful.
XML	XML format, another universal format.

                 {
         INFO, 
         JSON, 
         XML 
     };

◆ Format [2/2]

enum Format

Supported serialization formats.

Enumerator
INFO	INFO format, proper to Boost Property Trees (default)
JSON	JSON format, rather common and nearly as powerful.
XML	XML format, another universal format.
INFO	INFO format, proper to Boost Property Trees (default)
JSON	JSON format, rather common and nearly as powerful.
XML	XML format, another universal format.

                 {
         INFO, 
         JSON, 
         XML 
     };

Constructor & Destructor Documentation

◆ UserInfo() [1/10]

UserInfo ( const char * name = "UserInfo" )

Constructor (starting from scratch)

     : own(true), l(new TList)
 {
     l->SetName(name);
 }

◆ UserInfo() [2/10]

UserInfo ( const boost::property_tree::ptree & ptree )

Constructor (starting from existing ptree)

     : own(true), l(new TList)
 {
     for (const auto& [name, pt]: ptree)
         ConvertPtree(pt, name, l);
 }

◆ UserInfo() [3/10]

UserInfo ( TList * L )

Constructor (starting from existing list)

     : own(false), l(L)
 {
     if (L == nullptr)
         BOOST_THROW_EXCEPTION(invalid_argument("Invalid list given in argument."));
 }

◆ UserInfo() [4/10]

UserInfo ( TTree * t )

Constructor (starting from TTree)

     : own(false), l(t->GetUserInfo())
 {
 }

◆ UserInfo() [5/10]

UserInfo	(	TTree *	tree,
		const boost::property_tree::ptree &	ptree
	)

constructor (inserting existing ptree direcrly in a ttree)

     : own(false), l(tree->GetUserInfo())
 {
     for (const auto& [name, pt]: ptree)
         ConvertPtree(pt, name, l);
 }

◆ ~UserInfo() [1/2]

~UserInfo ( )

Destructor.

 {
     if (!own) return;
     delete l;
 }

◆ UserInfo() [6/10]

UserInfo ( const char * = "UserInfo" )

Constructor (starting from scratch)

◆ UserInfo() [7/10]

UserInfo ( const boost::property_tree::ptree & )

Constructor (starting from existing ptree)

◆ UserInfo() [8/10]

UserInfo ( TList * )

Constructor (starting from existing list)

◆ UserInfo() [9/10]

UserInfo ( TTree * )

Constructor (starting from TTree)

◆ UserInfo() [10/10]

UserInfo	(	TTree *	,
		const boost::property_tree::ptree &
	)

constructor (inserting existing ptree direcrly in a ttree)

◆ ~UserInfo() [2/2]

~UserInfo ( )

Destructor.

Member Function Documentation

◆ CheckKey() [1/2]

void CheckKey ( const char * key ) const

inlineprivate

Check that the key is not empty.

     {
         if (TString(key).Length() == 0)
             BOOST_THROW_EXCEPTION( std::invalid_argument("Empty keys are invalid") );
     }

◆ CheckKey() [2/2]

void CheckKey ( const char * key ) const

inlineprivate

Check that the key is not empty.

     {
         if (TString(key).Length() == 0)
             BOOST_THROW_EXCEPTION( std::invalid_argument("Empty keys are invalid") );
     }

◆ ConvertPtree() [1/2]

void ConvertPtree	(	const boost::property_tree::ptree &	,
		const std::string &	,
		TList *
	)

protected

Helper function to convert a ptree to a TList. Supports making strings, bools, ints, and floats.

◆ ConvertPtree() [2/2]

void ConvertPtree	(	const boost::property_tree::ptree &	pt,
		const std::string &	name,
		TList *	mother
	)

protected

Helper function to convert a ptree to a TList. Supports making strings, bools, ints, and floats.

 {
     if (pt.empty()) {
         // Value - we need to figure out the type
         auto str = pt.get_value<string>();
  
         char * end;
  
         // empty value too --> just the element of a list
         if (str.empty()) {
             if (mother->Contains(name.c_str()))
                 return;
  
             TString s(name);
             auto objs = new TObjString(s);
             mother->Add(objs);
         }
  
         // Bools
         else if (str == "true")
             Set<bool>(mother, name.data(), true);
         else if (str == "false")
             Set<bool>(mother, name.data(), false);
  
         // Integers
         else if (int i = 0; from_chars(str.data(), &*str.end(), i).ptr == &*str.end())
             Set<int>(mother, name.data(), i);
  
         // Floats
         else if (float f = strtof(str.data(), &end); end == &*str.end())
             Set<float>(mother, name.data(), f);
  
         // Everything else is a string
         else Set<string>(mother, name.data(), str);
  
     } else if (pt.count("") == pt.size() ||
                pt.count("item") == pt.size()) {
         // List
         for (const auto& [_, subtree]: pt)
             ConvertPtree(subtree, name.data(), mother);
     } else {
         // Subtree
         auto child = List(mother, name);
         for (const auto& [subname, subtree]: pt)
             ConvertPtree(subtree, subname.c_str(), child);
     }
 }

◆ Empty() [1/2]

bool Empty ( ) const

Check if list is empty.

 {
     return l->GetSize() == 0;
 }

◆ Empty() [2/2]

bool Empty ( ) const

Check if list is empty.

◆ Find() [1/8]

bool Find	(	const char *	key,
		Args...	args
	)		const

inline

Generic finder.

     {
         return Find(l, key, args...);
     }

◆ Find() [2/8]

bool Find	(	const char *	key,
		Args...	args
	)		const

inline

Generic finder.

     {
         return Find(l, key, args...);
     }

◆ Find() [3/8]

bool Find	(	TList *	mother,
		const char *	key
	)		const

inlineprivate

Check if an element exists in a TList.

     {
         CheckKey(key);
         TObject * obj = mother->FindObject(key);
         return (obj != nullptr);
     }

◆ Find() [4/8]

bool Find	(	TList *	mother,
		const char *	key
	)		const

inlineprivate

Check if an element exists in a TList.

     {
         CheckKey(key);
         TObject * obj = mother->FindObject(key);
         return (obj != nullptr);
     }

◆ Find() [5/8]

bool Find	(	TList *	mother,
		const char *	key,
		Args...	args
	)		const

inlineprivate

Recursive finder.

     {
         if (!Find(mother, key)) return false;
         TList * daughter = List(mother, key);
         if (daughter->GetSize() > 0)
             return Find(daughter, args...);
         else return false;
     }

◆ Find() [6/8]

bool Find	(	TList *	mother,
		const char *	key,
		Args...	args
	)		const

inlineprivate

Recursive finder.

     {
         if (!Find(mother, key)) return false;
         TList * daughter = List(mother, key);
         if (daughter->GetSize() > 0)
             return Find(daughter, args...);
         else return false;
     }

◆ Find() [7/8]

bool Find	(	TList *	mother,
		std::string	key
	)		const

inlineprivate

finder with string

◆ Find() [8/8]

bool Find	(	TList *	mother,
		std::string	key
	)		const

inlineprivate

finder with string

◆ Get() [1/8]

T Get	(	const char *	key,
		Args...	args
	)		const

inline

Generic getter.

     {
         return Get<T>(l, key, args...);
     }

◆ Get() [2/8]

T Get	(	const char *	key,
		Args...	args
	)		const

inline

Generic getter.

     {
         return Get<T>(l, key, args...);
     }

◆ Get() [3/8]

T Get	(	TList *	mother,
		const char *	key
	)		const

inlineprivate

Final getter. The behaviour for arithmetic types and for literal (default) is slightly different, since literals don't really have a key. Literals are always contained in a list, and the last element of the list is returned.

     {
         if constexpr (std::is_arithmetic_v<T>) {
             TObject * obj = mother->FindObject(key);
             auto parameter = dynamic_cast<TParameter<T>*>(obj);
             if (parameter == nullptr)
                 BOOST_THROW_EXCEPTION(std::invalid_argument(
                         Form("No `TParameter` with name '%s' could be found in the `TList` '%s'.", key, mother->GetName())));
             return parameter->GetVal();
         }
         else {
             TList * daughter = List(mother, key);
             TIter next(daughter->begin());
             auto objs = dynamic_cast<TObjString*>(daughter->Last());
             if (daughter->GetSize() == 0 || objs == nullptr)
                 BOOST_THROW_EXCEPTION(std::invalid_argument(
                         Form("No literal with name '%s' was found in the `TList` '%s'.", key, mother->GetName())));
             T literal = objs->GetString().Data();
             return literal;
         }
     }

◆ Get() [4/8]

T Get	(	TList *	mother,
		const char *	key
	)		const

inlineprivate

Final getter. The behaviour for arithmetic types and for literal (default) is slightly different, since literals don't really have a key. Literals are always contained in a list, and the last element of the list is returned.

     {
         if constexpr (std::is_arithmetic_v<T>) {
             TObject * obj = mother->FindObject(key);
             auto parameter = dynamic_cast<TParameter<T>*>(obj);
             if (parameter == nullptr)
                 BOOST_THROW_EXCEPTION(std::invalid_argument(
                         Form("No `TParameter` with name '%s' could be found in the `TList` '%s'.", key, mother->GetName())));
             return parameter->GetVal();
         }
         else {
             TList * daughter = List(mother, key);
             TIter next(daughter->begin());
             auto objs = dynamic_cast<TObjString*>(daughter->Last());
             if (daughter->GetSize() == 0 || objs == nullptr)
                 BOOST_THROW_EXCEPTION(std::invalid_argument(
                         Form("No literal with name '%s' was found in the `TList` '%s'.", key, mother->GetName())));
             T literal = objs->GetString().Data();
             return literal;
         }
     }

◆ Get() [5/8]

T Get	(	TList *	mother,
		const char *	key,
		Args...	args
	)		const

inlineprivate

Recursive getter.

     {
         TList * daughter = List(mother, key);
         return Get<T>(daughter, args...);
     }

◆ Get() [6/8]

T Get	(	TList *	mother,
		const char *	key,
		Args...	args
	)		const

inlineprivate

Recursive getter.

     {
         TList * daughter = List(mother, key);
         return Get<T>(daughter, args...);
     }

◆ Get() [7/8]

T Get	(	TList *	mother,
		std::string	key
	)		const

inlineprivate

value getter with string

◆ Get() [8/8]

T Get	(	TList *	mother,
		std::string	key
	)		const

inlineprivate

value getter with string

◆ List() [1/10]

TList* List ( ) const

inline

Access directly to main list.

     {
         return l;
     }

◆ List() [2/10]

TList* List ( ) const

inline

Access directly to main list.

     {
         return l;
     }

◆ List() [3/10]

TList* List	(	const char *	key,
		Args...	args
	)		const

inline

Access directly a sublist.

     {
         return List(l, key, args...);
     }

◆ List() [4/10]

TList* List	(	const char *	key,
		Args...	args
	)		const

inline

Access directly a sublist.

     {
         return List(l, key, args...);
     }

◆ List() [5/10]

TList * List	(	TList *	mother,
		const char *	key
	)		const

private

Accest do daughter list from a mother list.

 {
     TObject * obj = mother->FindObject(key);
     if (obj == nullptr) {
         auto daughter = static_cast<TList *>(obj);
         daughter = new TList;
         daughter->SetName(key);
         mother->Add(daughter);
         return daughter;
     }
     else {
         TString classname = obj->ClassName();
         if (classname != "TList")
             BOOST_THROW_EXCEPTION(invalid_argument(key));
         auto daughter = dynamic_cast<TList *>(obj);
         return daughter;
     }
 }

◆ List() [6/10]

TList* List	(	TList *	mother,
		const char *	key
	)		const

private

Accest do daughter list from a mother list.

◆ List() [7/10]

TList* List	(	TList *	mother,
		const char *	key,
		Args...	args
	)		const

inlineprivate

Access a sublist.

     {
         TList * daughter = List(mother, key);
         return List(daughter, args...);
     }

◆ List() [8/10]

TList* List	(	TList *	mother,
		const char *	key,
		Args...	args
	)		const

inlineprivate

Access a sublist.

     {
         TList * daughter = List(mother, key);
         return List(daughter, args...);
     }

◆ List() [9/10]

TList* List	(	TList *	mother,
		std::string	key
	)		const

inlineprivate

list getter with string

◆ List() [10/10]

TList* List	(	TList *	mother,
		std::string	key
	)		const

inlineprivate

list getter with string

◆ ls() [1/2]

void ls ( ) const

inline

Prints the content of the TList

290 { if (l != nullptr) l->ls(); }

◆ ls() [2/2]

void ls ( ) const

inline

Prints the content of the TList

290 { if (l != nullptr) l->ls(); }

◆ MkPtree() [1/4]

boost::property_tree::ptree MkPtree ( Format format = INFO ) const

inline

Write main TList to Boost Property Tree.

Returns: content of full TList in Property Tree format

Parameters

format format of output file

286 { return MkPtree(l, format); }

◆ MkPtree() [2/4]

boost::property_tree::ptree MkPtree ( Format format = INFO ) const

inline

Write main TList to Boost Property Tree.

Returns: content of full TList in Property Tree format

Parameters

format format of output file

286 { return MkPtree(l, format); }

◆ MkPtree() [3/4]

boost::property_tree::ptree MkPtree	(	TList *	,
		Format	= `INFO`
	)		const

protected

Write TList to Boost Property Tree. Calls itself recursively. Internally, it uses Boost Preprocessor macros to loop over types.

Returns: content of TList given in argument in Property Tree format

◆ MkPtree() [4/4]

pt::ptree MkPtree	(	TList *	list,
		Format	format = `INFO`
	)		const

protected

Write TList to Boost Property Tree. Calls itself recursively. Internally, it uses Boost Preprocessor macros to loop over types.

Returns: content of TList given in argument in Property Tree format

Parameters

list	list to write to `ptree`
format	format of output file (e.g. XML cannot handle empty keys)

 {
     pt::ptree tree; // this tree will contain the list
     for (const auto& obj: *list) {
         const char * key = obj->GetName();
         const TString classname = obj->ClassName();
         if (classname == "TList") {
             auto sublist = dynamic_cast<TList *>(obj);
             pt::ptree child = MkPtree(sublist, format);
             tree.add_child(key, child);
         }
         else if (classname == "TObjString") {
             auto objs = dynamic_cast<TObjString *>(obj);
             const TString value = objs->GetString();
             if (value.Length() > 0) {
                 if (list->GetSize() == 1)
                     tree.put<const char *>("", value);
                 else {
                     pt::ptree node;
                     node.put<const char *>("", value);
                     tree.push_back(make_pair("", node));
                 }
             }
         }
 #define ARITHMETIC_TYPES (bool)(char)(signed char)(short)(short int)(int)(long int)(long long int)(unsigned char)(unsigned short)(unsigned short int)(unsigned)(unsigned int)(unsigned long)(unsigned long int)(unsigned long long)(unsigned long long int)(float)(double)(long double)
 #define ELSE_IF_TPARAM(r, data, TYPE) \
         else if (classname == "TParameter<" BOOST_PP_STRINGIZE(TYPE) ">") { \
             auto param = dynamic_cast<TParameter<TYPE>*>(obj); \
             tree.add<TYPE>(key, param->GetVal()); \
         }
         BOOST_PP_SEQ_FOR_EACH(ELSE_IF_TPARAM, _, ARITHMETIC_TYPES)
 #undef ARITHMETIC_TYPES
 #undef ELSE_IF_TPARAM
         else 
             cerr << orange << "Warning: " << classname << " is not handled by " << __func__ << ", therefore `" << key << "` will ignored.\n" << def;
     }
     return tree;
 }

◆ Set() [1/6]

void Set	(	const char *	key,
		Args...	args
	)		const

inline

Generic setter. The key is the name of the first sublist (if any), or to the element directly. An extra argument (implicitly in the variadic argument) contains the value.

     {
         Set<T>(l, key, args...);
     }

◆ Set() [2/6]

void Set	(	const char *	key,
		Args...	args
	)		const

inline

Generic setter. The key is the name of the first sublist (if any), or to the element directly. An extra argument (implicitly in the variadic argument) contains the value.

     {
         Set<T>(l, key, args...);
     }

◆ Set() [3/6]

void Set	(	TList *	mother,
		const char *	key,
		Args...	args
	)		const

inlineprivate

Recursive setter.

     {
         CheckKey(key);
         TList * daughter = List(mother, key);
         Set<T>(daughter, args...);
     }

◆ Set() [4/6]

void Set	(	TList *	mother,
		const char *	key,
		Args...	args
	)		const

inlineprivate

Recursive setter.

     {
         CheckKey(key);
         TList * daughter = List(mother, key);
         Set<T>(daughter, args...);
     }

◆ Set() [5/6]

void Set	(	TList *	mother,
		const char *	key,
		T	value
	)		const

inlineprivate

(Re)sets elements of a given list.

Only arithmetic types have a key and a value. Literals only have identical key and value.

     {
         CheckKey(key);
  
         if constexpr (std::is_arithmetic_v<T>) {
             TObject * obj = mother->FindObject(key);
             if (obj) {
                 auto parameter = dynamic_cast<TParameter<T>*>(obj);
                 if (parameter == nullptr)
                     BOOST_THROW_EXCEPTION(std::invalid_argument(
                                 Form("No `TParameter` with name '%s' and typeid '%s' was found in the `TList` '%s'.",
                                                 key, typeid(T).name(), mother->GetName())));
                 parameter->SetVal(value);
             }
             else {
                 auto parameter = new TParameter<T>(key, value, 'l');
                 mother->Add(parameter);
             }
         }
         else {
             TString str(value);
             TList * daughter = List(mother, key);
             if (str.Length() >= 0) {
                 auto objs = new TObjString(str);
                 daughter->Add(objs);
             }
         }
     }

◆ Set() [6/6]

void Set	(	TList *	mother,
		const char *	key,
		T	value
	)		const

inlineprivate

(Re)sets elements of a given list.

Only arithmetic types have a key and a value. Literals only have identical key and value.

     {
         CheckKey(key);
  
         if constexpr (std::is_arithmetic_v<T>) {
             TObject * obj = mother->FindObject(key);
             if (obj) {
                 auto parameter = dynamic_cast<TParameter<T>*>(obj);
                 if (parameter == nullptr)
                     BOOST_THROW_EXCEPTION(std::invalid_argument(
                                 Form("No `TParameter` with name '%s' and typeid '%s' was found in the `TList` '%s'.",
                                                 key, typeid(T).name(), mother->GetName())));
                 parameter->SetVal(value);
             }
             else {
                 auto parameter = new TParameter<T>(key, value, 'l');
                 mother->Add(parameter);
             }
         }
         else {
             TString str(value);
             TList * daughter = List(mother, key);
             if (str.Length() >= 0) {
                 auto objs = new TObjString(str);
                 daughter->Add(objs);
             }
         }
     }

◆ Write() [1/8]

void Write ( ) const

Write TList to TFile in ROOT format.

 {
     TString name = l->GetName();
     if (name.IsNull()) name = "UserInfo";
     l->Write(name, TList::kSingleKey);
 }

◆ Write() [2/8]

void Write ( ) const

Write TList to TFile in ROOT format.

◆ Write() [3/8]

boost::property_tree::ptree Write	(	const boost::property_tree::ptree &	,
		std::ostream &	,
		Format	= `INFO`
	)		const

protected

Write a Boost Property Tree to text file format.

It essentially calls pt::write_info, pt::write_json, or pt::write_xml. Minor edits such as the removal of empty strings in INFO format or the the addition of a global tag in XML format are applied.

◆ Write() [4/8]

pt::ptree Write	(	const boost::property_tree::ptree &	tree,
		std::ostream &	out,
		Format	format = `INFO`
	)		const

protected

Write a Boost Property Tree to text file format.

It essentially calls pt::write_info, pt::write_json, or pt::write_xml. Minor edits such as the removal of empty strings in INFO format or the the addition of a global tag in XML format are applied.

Parameters

out	output stream
format	format of output

 {
     switch (format) {
         case JSON:
         {
             stringstream ss;
             write_json(ss, tree);
             string str = ss.str();
             // by default, everything is a string
             // -> we remove quotation marks for numerics and booleans
             regex numbers("\\\"([0-9]+\\.{0,1}[0-9]*)\\\""), // note: no support for hex
                   booleans("\\\"(true|false)\\\"");
             str = regex_replace(str, numbers, "$1");
             str = regex_replace(str, booleans, "$1");
             al::replace_all(str, "\\/", "/");
             out << str;
             break;
         }
         case XML :
         {
             pt::ptree userinfo;
             userinfo.put_child("userinfo", tree); // there must be exactly one global key
             pt::xml_writer_settings<string> settings(' ', 2); // indentation with 2 spaces
             stringstream ss;
             write_xml(ss, userinfo, settings);
             string str = ss.str();
             al::replace_all(str, "<>", "<item>");
             al::replace_all(str, "</>", "</item>");
             out << str;
             break;
         }
         case INFO:
         {
             stringstream ss;
             write_info(ss, tree);
             string str = ss.str();
             al::erase_all(str, " \"\"");
             al::erase_all(str, "\"\" ");
             out << str;
         }
     }
  
     return tree;
 }

◆ Write() [5/8]

boost::property_tree::ptree Write ( const std::filesystem::path & ) const

Write to file with Boost. Calls MkPtree to write sublists.

Returns: content of full TList in Property Tree format

◆ Write() [6/8]

pt::ptree Write ( const std::filesystem::path & p ) const

Write to file with Boost. Calls MkPtree to write sublists.

Returns: content of full TList in Property Tree format

Parameters

p	path to output

 {
     auto type = INFO;
     if (p.extension() == ".json")
         type = JSON;
     else if (p.extension() == ".xml")
         type = XML;
  
     ofstream stream(p);
     return Write(stream, type);
 }

◆ Write() [7/8]

pt::ptree Write	(	std::ostream &	out,
		Format	format = `INFO`
	)		const

Write to stream with Boost. Calls MkPtree to write sublists.

Returns: content of full TList in Property Tree format

Parameters

out	output stream
format	format of output

 {
     pt::ptree tree = MkPtree(format);
     return Write(tree, out, format);
 }

◆ Write() [8/8]

boost::property_tree::ptree Write	(	std::ostream &	,
		Format	= `INFO`
	)		const

Write to stream with Boost. Calls MkPtree to write sublists.

Returns: content of full TList in Property Tree format

Member Data Documentation

◆ l

TList * l

private

main list (typically from TTree::GetUserInfo())

◆ own

bool own

private

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

/builds/cms-analysis/general/DasAnalysisSystem/Core/Installer/Darwin/interface/UserInfo.h
/builds/cms-analysis/general/DasAnalysisSystem/Core/Installer/Darwin/src/UserInfo.cc

Description

Public Types

Public Member Functions

Protected Member Functions

Private Member Functions

Private Attributes

Member Enumeration Documentation

◆ Format [1/2]

◆ Format [2/2]

Constructor & Destructor Documentation

◆ UserInfo() [1/10]

◆ UserInfo() [2/10]

◆ UserInfo() [3/10]

◆ UserInfo() [4/10]

◆ UserInfo() [5/10]

◆ ~UserInfo() [1/2]

◆ UserInfo() [6/10]

◆ UserInfo() [7/10]

◆ UserInfo() [8/10]

◆ UserInfo() [9/10]

◆ UserInfo() [10/10]

◆ ~UserInfo() [2/2]

Member Function Documentation

◆ CheckKey() [1/2]

◆ CheckKey() [2/2]

◆ ConvertPtree() [1/2]

◆ ConvertPtree() [2/2]

◆ Empty() [1/2]

◆ Empty() [2/2]

◆ Find() [1/8]

◆ Find() [2/8]

◆ Find() [3/8]

◆ Find() [4/8]

◆ Find() [5/8]

◆ Find() [6/8]

◆ Find() [7/8]

◆ Find() [8/8]

◆ Get() [1/8]

◆ Get() [2/8]

◆ Get() [3/8]

◆ Get() [4/8]

◆ Get() [5/8]

◆ Get() [6/8]

◆ Get() [7/8]

◆ Get() [8/8]

◆ List() [1/10]

◆ List() [2/10]

◆ List() [3/10]

◆ List() [4/10]

◆ List() [5/10]

◆ List() [6/10]

◆ List() [7/10]

◆ List() [8/10]

◆ List() [9/10]

◆ List() [10/10]

◆ ls() [1/2]

◆ ls() [2/2]

◆ MkPtree() [1/4]

◆ MkPtree() [2/4]

◆ MkPtree() [3/4]

◆ MkPtree() [4/4]

◆ Set() [1/6]

◆ Set() [2/6]

◆ Set() [3/6]

◆ Set() [4/6]

◆ Set() [5/6]

◆ Set() [6/6]

◆ Write() [1/8]

◆ Write() [2/8]

◆ Write() [3/8]

◆ Write() [4/8]

◆ Write() [5/8]

◆ Write() [6/8]

◆ Write() [7/8]

◆ Write() [8/8]

Member Data Documentation

◆ l

◆ own