TrigConf::JsonFileLoader Class Reference

Loader of trigger configurations from Json files. More...

#include <JsonFileLoader.h>

Inheritance diagram for TrigConf::JsonFileLoader:

Collaboration diagram for TrigConf::JsonFileLoader:

Public Member Functions
	JsonFileLoader ()
	Constructor.
virtual	~JsonFileLoader () override=default
	Destructor.
bool	loadFile (const std::string &filename, boost::property_tree::ptree &data, const std::string &pathToChild="") const
	Load content of json file into a ptree.
bool	loadFile (const std::string &filename, DataStructure &data, const std::string &pathToChild="") const
	Load content of json file into a ptree.
bool	saveFile (const std::string &filename, const DataStructure &data) const
	Save content of DataStructure (underlying ptree) to a file.
std::string	getFileType (const std::string &filename) const
	Checks the trigger level of a given json file.
bool	checkTriggerLevel (const std::string &filename, std::string &level) const
	Checks the trigger level of a given json file.
void	setLevel (MSGTC::Level lvl)
MSGTC::Level	outputLevel () const
bool	msgLvl (const MSGTC::Level lvl) const
	Test the output level.
MsgStreamTC &	msg () const
	The standard message stream.
MsgStreamTC &	msg (const MSGTC::Level lvl) const
	The standard message stream.
const std::string &	getName () const
	name accessor

Private Member Functions
std::string	findFile (const std::string &filename) const

Private Attributes
boost::thread_specific_ptr< MsgStreamTC >	m_msg_tls
	MsgStreamTC instance (a std::cout like with print-out levels)
std::string	m_name

Detailed Description

Loader of trigger configurations from Json files.

Definition at line 25 of file JsonFileLoader.h.

Constructor & Destructor Documentation

JsonFileLoader()

TrigConf::JsonFileLoader::JsonFileLoader

(

)

Constructor.

Definition at line 19 of file JsonFileLoader.cxx.

                                       :
   TrigConfMessaging( "JsonFileLoader")
{}

~JsonFileLoader()

virtual TrigConf::JsonFileLoader::~JsonFileLoader ( )

overridevirtualdefault

Destructor.

Member Function Documentation

checkTriggerLevel()

bool TrigConf::JsonFileLoader::checkTriggerLevel	(	const std::string &	filename,
		std::string &	level ) const

Checks the trigger level of a given json file.

Parameters

filename	[in] Name of the json file
level	[out] either "L1", "HLT" or "UNKNOWN"

Definition at line 128 of file JsonFileLoader.cxx.

{
   level = "UNKNOWN";
 
   DataStructure data;
 
   bool succeeded = this -> loadFile ( filename, data );
 
   if ( succeeded ) {
      if (data.hasChild("chains")) {
         level = "HLT";
      } else if (data.hasChild("items")) {
         level = "L1";
      }
   }
 
   return succeeded;
}

findFile()

std::string TrigConf::JsonFileLoader::findFile ( const std::string & filename ) const

private

Definition at line 28 of file JsonFileLoader.cxx.

                                                                 {
 
   // check for the file as specified
   if( std::filesystem::exists( filename ) ) {
      return filename;
   }
 
   // check if absolute location has been specified
   if (!filename.empty() && filename[0] == '/') {
      TRG_MSG_WARNING("Can not find file with absolute location " << filename);
      return {};
   }
 
   return {};
}

getFileType()

std::string TrigConf::JsonFileLoader::getFileType

(

const std::string &

filename

)

const

Checks the trigger level of a given json file.

Parameters

filename

[in] Name of the json file

Definition at line 114 of file JsonFileLoader.cxx.

{
   std::string ft = "UNKNOWN";
 
   DataStructure data;
   if ( loadFile ( filename, data ) ) {
      ft = data.getAttribute("filetype", /*ignoreIfMissing*/ true, ft);
   }
 
   return ft;
}

getName()

const std::string & TrigConf::TrigConfMessaging::getName ( ) const

inlineinherited

name accessor

Returns

the name

Definition at line 101 of file TrigConfMessaging.h.

                                                           {
    return m_name;
  }

loadFile() [1/2]

bool TrigConf::JsonFileLoader::loadFile	(	const std::string &	filename,
		boost::property_tree::ptree &	data,
		const std::string &	pathToChild = "" ) const

Load content of json file into a ptree.

Parameters

filename	[in] Name of the json file
data	[out]
pathToChild	[in] Path to a sub structure for partial loading of data

If the optional parameter pathToChild is specified, one can load parts if the configuration from the file.

TrigConf::JsonFileLoader fileLoader;
const std::string l1_filename = "TriggerMenuXML/LVL1config_Physics_pp_v7.json";
TrigConf::DataStructure metSignificance;
fileLoader.loadFile( l1_filename, metSignificance, "CaloInfo.METSignificance");

Definition at line 45 of file JsonFileLoader.cxx.

{
 
   std::string file = findFile(filename); // resolved file name
   if ( file.empty() ) {
      return false;
   }
   TRG_MSG_INFO("Reading information from " << file);
 
   // Load the json file
   try {
      boost::property_tree::read_json(file, data);
   }
   catch (const boost::property_tree::json_parser_error& e) {
      TRG_MSG_WARNING("Could either not locate or parse the file " << file);
      return false;
   }
 
   if( ! pathToChild.empty() ) {
      // the user has specified that s/he wants to access a certain part of the file
      // the pathToChild is specified like this "a.b.c"
      boost::optional<ptree&> subtree = data.get_child_optional(pathToChild);
      if(subtree) {
         data = *subtree;
      } else {
         TRG_MSG_WARNING("Did not find element '" << pathToChild << "' in the file " << file);
         data.clear();
      }
   }
 
   return true;
}

loadFile() [2/2]

bool TrigConf::JsonFileLoader::loadFile	(	const std::string &	filename,
		DataStructure &	data,
		const std::string &	pathToChild = "" ) const

Load content of json file into a ptree.

Parameters

filename	[in] Name of the json file
data	[out]
pathToChild	[in] Path to a sub structure for partial loading of data

Definition at line 82 of file JsonFileLoader.cxx.

{
   boost::property_tree::ptree pt;
 
   if( ! loadFile( filename, pt, pathToChild) )
      return false;
 
   data.setData(std::move(pt));
 
   return true;
}

msg() [1/2]

MsgStreamTC & TrigConf::TrigConfMessaging::msg ( ) const

inlineinherited

The standard message stream.

Returns a reference to the message stream May not be invoked before sysInitialize() has been invoked.

Definition at line 86 of file TrigConfMessaging.h.

  {
    MsgStreamTC* ms = m_msg_tls.get();
    if (!ms) {
      ms = new MsgStreamTC(m_name);
      m_msg_tls.reset(ms);
    }
    return *ms;
  }

msg() [2/2]

MsgStreamTC & TrigConf::TrigConfMessaging::msg ( const MSGTC::Level lvl ) const

inlineinherited

The standard message stream.

Returns a reference to the default message stream May not be invoked before sysInitialize() has been invoked.

Definition at line 96 of file TrigConfMessaging.h.

  {
    return msg() << lvl;
  }

msgLvl()

bool TrigConf::TrigConfMessaging::msgLvl ( const MSGTC::Level lvl ) const

inlineinherited

Test the output level.

Parameters

lvl	The message level to test against

Returns

boolean Indicting if messages at given level will be printed

Return values

true	Messages at level "lvl" will be printed

Definition at line 75 of file TrigConfMessaging.h.

  {
    if (msg().level() <= lvl) {
      msg() << lvl;
      return true;
    }
    else {
      return false;
    }
  }

outputLevel()

MSGTC::Level TrigConf::JsonFileLoader::outputLevel ( ) const

inline

Definition at line 88 of file JsonFileLoader.h.

{ return msg().level(); }

saveFile()

bool TrigConf::JsonFileLoader::saveFile	(	const std::string &	filename,
		const DataStructure &	data ) const

Save content of DataStructure (underlying ptree) to a file.

Parameters

filename	[in] Name of the json file
data	[in]

Definition at line 99 of file JsonFileLoader.cxx.

{
   if ( filename == "" ) {
      TRG_MSG_ERROR("Could not save to file, as specified filename is empty");
      return false;
   }
   boost::property_tree::write_json(filename, data.data());
   TRG_MSG_INFO("Saved file " << filename);
 
   return true;
}

setLevel()

void TrigConf::JsonFileLoader::setLevel ( MSGTC::Level lvl )

inline

Definition at line 86 of file JsonFileLoader.h.

{ msg().setLevel(lvl); }

Member Data Documentation

m_msg_tls

boost::thread_specific_ptr<MsgStreamTC> TrigConf::TrigConfMessaging::m_msg_tls

mutableprivateinherited

MsgStreamTC instance (a std::cout like with print-out levels)

Definition at line 71 of file TrigConfMessaging.h.

m_name

std::string TrigConf::TrigConfMessaging::m_name

privateinherited

Definition at line 72 of file TrigConfMessaging.h.

---

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

• JsonFileLoader.h
• JsonFileLoader.cxx