TrigConf::L1Menu Class Reference

L1 menu configuration. More...

#include <L1Menu.h>

Inheritance diagram for TrigConf::L1Menu:

Collaboration diagram for TrigConf::L1Menu:

Public Types
using	const_iterator = ConstIter< ptree, L1Item >
	Iterator over the L1 items. More...
using	ptree = boost::property_tree::ptree

Public Member Functions
	L1Menu ()
	Constructor. More...
	L1Menu (const ptree &data)
	Constructor initialized with configuration data. More...
virtual	~L1Menu () override=default
	Destructor. More...
virtual std::string	className () const override
	A string that is the name of the class. More...
unsigned int	version () const
	Accessor to the menu version. More...
unsigned int	ctpVersion () const
	Accessor to the version of the CTP format. More...
std::size_t	size () const
	Accessor to the number of L1 items. More...
unsigned int	smk () const
	setter and getter for the supermasterkey More...
void	setSMK (unsigned int psk)
L1Item	item (const std::string &itemName) const
	Get item by name. More...
const_iterator	begin () const
	Begin of the L1 items list. More...
const_iterator	end () const
	End of the L1 items list. More...
std::vector< std::string >	thresholdTypes () const
	List of L1 thresholds types. More...
std::vector< std::string >	thresholdNames () const
	List of L1 thresholds names. More...
std::vector< std::shared_ptr< TrigConf::L1Threshold > >	thresholds () const
	Access to list of all L1Thresholds. More...
const std::vector< std::shared_ptr< TrigConf::L1Threshold > > &	thresholds (const std::string &typeName) const
	Access to list of L1Thresholds by type. More...
const TrigConf::L1Threshold &	threshold (const std::string &thresholdName) const
	Access to L1Threshold by name. More...
const TrigConf::L1Threshold &	threshold (const std::string &typeName, unsigned int mapping) const
	Access to L1Threshold by type and mapping index. More...
const L1ThrExtraInfo &	thrExtraInfo () const
	Access to extra info for threshold types. More...
std::vector< std::string >	topoAlgorithmNames (const std::string &category) const
	Access to topo algorithm names. More...
std::vector< std::string >	topoAlgorithmOutputNames (const std::string &category) const
	Access to topo algoritm output names. More...
const TrigConf::L1TopoAlgorithm &	algorithm (const std::string &algoName, const std::string &category) const
	Access to topo algorithm by name. More...
const TrigConf::L1TopoAlgorithm &	algorithmFromTriggerline (const std::string &triggerlineName) const
	Access to topo algorithm by name of triggerline as given in topo connector specification. More...
const TrigConf::L1TopoAlgorithm &	algorithmFromOutput (const std::string &bareOutputName, const std::string &category) const
	Access to topo algorithm by name of the output as given in the algorithm definition. More...
const TrigConf::L1Board &	board (const std::string &boardName) const
	Access to boards by name. More...
std::vector< std::string >	boardNames () const
	Board names. More...
const TrigConf::L1Connector &	connector (const std::string &connectorName) const
	Access to connector by name. More...
std::vector< std::string >	connectorNames () const
	Connector names. More...
const std::string &	connectorNameFromThreshold (const std::string &thresholdName) const
	Name of connector from name of threshold or triggerline. More...
const TrigConf::L1CTP &	ctp () const
	the CTP configuration More...
void	printMenu (bool full=false) const
	print overview of L1 Menu More...
bool	isRun2 () const
unsigned int	run () const
virtual void	clear () override
	Clearing the configuration data. More...
void	setData (const ptree &data)
	Setting the configuration data. More...
void	setData (ptree &&data)
void	setName (const std::string &n)
	Setting the configuration element name. More...
virtual const std::string &	name () const final
const ptree &	data () const
	Access to the underlying data, if needed. More...
bool	isValue () const
	Check for attribute. More...
std::string	getValue () const
	Access to simple content. More...
template<class T >
T	getValue () const
template<class T >
std::optional< T >	getValue_optional () const
	access to content of the note Will return false if the value could not be converted into T More...
bool	hasAttribute (const std::string &key) const
	Check for attribute. More...
bool	isNull (const std::string &key) const
	Check if an attribute is null. More...
bool	hasChild (const std::string &path) const
	Check if child exists. More...
std::string	operator[] (const std::string &key) const
	Access to simple attribute. More...
template<class T >
T	getAttribute (const std::string &key, bool ignoreIfMissing=false, const T &def=T()) const
	Access to simple attribute. More...
const std::string &	getAttribute (const std::string &key, bool ignoreIfMissing=false, const std::string &def="") const
template<class T >
std::optional< T >	getAttribute_optional (const std::string &key) const
std::vector< DataStructure >	getList (const std::string &pathToChild, bool ignoreIfMissing=false) const
	Access to array structure. More...
std::optional< std::vector< DataStructure > >	getList_optional (const std::string &pathToChild) const
DataStructure	getObject (const std::string &pathToChild, bool ignoreIfMissing=false) const
	Access to configuration object. More...
std::optional< TrigConf::DataStructure >	getObject_optional (const std::string &pathToChild) const
std::vector< std::string >	getKeys () const
	Access to the keys of an DataStructure which presents a dictionary. More...
	operator bool () const
	Access to initialized state. More...
bool	isValid () const
bool	isInitialized () const
bool	empty () const
	Check if children exist. More...
void	printRaw (std::ostream &os=std::cout) const
virtual void	print (std::ostream &os=std::cout) const
bool	ownsData () const

Static Public Member Functions
static void	printElement (const std::string &key, const ptree &data, uint level=0, std::ostream &os=std::cout)
	Static function to print a ptree object. More...

Protected Attributes
bool	m_initialized { false }
	if initialized, the underlying ptree is has been assigned to (can be empty) More...
std::shared_ptr< ptree >	m_dataSPtr { nullptr }
const ptree *	m_dataPtr { nullptr }
std::string	m_name {""}

Private Member Functions
virtual void	update () override
	Update the internal data after modification of the data object. More...
void	load ()

Private Attributes
unsigned int	m_smk {0}
	the supermasterkey More...
unsigned int	m_run {3}
std::map< std::string, TrigConf::L1Connector >	m_connectors {}
	connector by name More...
std::map< std::string, std::string >	m_threshold2ConnectorName {}
	connector name by threshold name More...
std::map< std::string, TrigConf::L1Board >	m_boards {}
	board by name More...
std::map< std::string, std::vector< std::shared_ptr< TrigConf::L1Threshold > > >	m_thresholdsByType {}
	threshold maps More...
std::map< std::string, std::shared_ptr< TrigConf::L1Threshold > >	m_thresholdsByName {}
std::map< std::string, std::map< unsigned int, std::shared_ptr< TrigConf::L1Threshold > > >	m_thresholdsByTypeAndMapping {}
TrigConf::L1ThrExtraInfo	m_thrExtraInfo
std::map< std::string, std::vector< TrigConf::L1TopoAlgorithm > >	m_algorithmsByCategory {}
	algorithm maps More...
std::map< std::string, std::map< std::string, TrigConf::L1TopoAlgorithm * > >	m_algorithmsByName {}
std::map< std::string, std::map< std::string, TrigConf::L1TopoAlgorithm * > >	m_algorithmsByOutput {}
TrigConf::L1CTP	m_ctp

Detailed Description

L1 menu configuration.

Provides access to menu name and ctpVersion and to the L1 items and thresholds

Definition at line 28 of file L1Menu.h.

Member Typedef Documentation

const_iterator

using TrigConf::L1Menu::const_iterator = ConstIter<ptree, L1Item>

Iterator over the L1 items.

Definition at line 64 of file L1Menu.h.

ptree

using TrigConf::DataStructure::ptree = boost::property_tree::ptree

inherited

Definition at line 40 of file DataStructure.h.

Constructor & Destructor Documentation

L1Menu() [1/2]

TrigConf::L1Menu::L1Menu

(

)

Constructor.

Definition at line 10 of file L1Menu.cxx.

{}

L1Menu() [2/2]

TrigConf::L1Menu::L1Menu

(

const ptree &

data

)

Constructor initialized with configuration data.

Parameters

data	The data containing the L1 menu

Definition at line 13 of file L1Menu.cxx.

   : DataStructure(data)
{
   load();
}

~L1Menu()

virtual TrigConf::L1Menu::~L1Menu ( )

overridevirtualdefault

Destructor.

Member Function Documentation

algorithm()

const TrigConf::L1TopoAlgorithm & TrigConf::L1Menu::algorithm	(	const std::string &	algoName,
		const std::string &	category
	)		const

Access to topo algorithm by name.

Definition at line 382 of file L1Menu.cxx.

{
   try {
      return * m_algorithmsByName.at(category).at(algoName);
   }
   catch(std::exception & ex) {
      std::cerr << "No algorithm " << algoName << " of category " << category << " defined in the L1 menu" << std::endl;
      throw;
   }
}

algorithmFromOutput()

const TrigConf::L1TopoAlgorithm & TrigConf::L1Menu::algorithmFromOutput	(	const std::string &	bareOutputName,
		const std::string &	category
	)		const

Access to topo algorithm by name of the output as given in the algorithm definition.

Parameters

fullOutputName

string name of the output prefixed with the category, e.g. ("HT150-J20s5.ETA31","TOPO") or ("0INVM9-EM7ab-EMab","R2TOPO")

Returns

reference to the algorithm that produces this output

Definition at line 417 of file L1Menu.cxx.

{
   try {
      return * m_algorithmsByOutput.at(type).at(bareOutputName);
   }
   catch(std::exception & ex) {
      std::cerr << "No output " << bareOutputName << " defined by any algorithm of type " << type << " in the L1 menu" << std::endl;
      throw;
   }
}

algorithmFromTriggerline()

const TrigConf::L1TopoAlgorithm & TrigConf::L1Menu::algorithmFromTriggerline

(

const std::string &

triggerlineName

)

const

Access to topo algorithm by name of triggerline as given in topo connector specification.

Parameters

triggerlineName

string name of the triggerline

Returns

reference to the algorithm that produces this output

The name of the triggerline starts with "TOPO_", "MUTOPO_", or "R2TOPO_", except in the case of multiplicity output lines which are just the threshold name

Definition at line 394 of file L1Menu.cxx.

{
   std::string category {"MULTTOPO"};
   std::string outputName {triggerlineName};
   if( std::size_t pos = triggerlineName.find('_'); pos != std::string::npos ) {
      category = triggerlineName.substr(0,pos);
      outputName = triggerlineName.substr(pos+1);
   }
   const static std::vector<string> topoTypes {"TOPO", "R2TOPO", "MULTTOPO", "MUTOPO"};
   if( std::none_of(cbegin(topoTypes), cend(topoTypes), [&category](const std::string & str){return str==category;}) ) {
      std::string msg = "L1Menu::algorithmFromTriggerLine(" + triggerlineName + "): triggerline " + triggerlineName + " is not produced by a topo algorithm.";
      throw std::runtime_error(msg);
   }
   try {
      return * m_algorithmsByOutput.at(category).at(outputName);
   }
   catch(std::exception & ex) {
      std::cerr << "L1Menu::algorithmFromTriggerLine(): No output " << outputName << " defined by any algorithm of category " << category << " in the L1 menu. (It was asked for " << triggerlineName << ")" << std::endl;
      throw;
   }
}

begin()

TrigConf::L1Menu::const_iterator TrigConf::L1Menu::begin

(

)

const

Begin of the L1 items list.

Needed for range-based loops

Definition at line 216 of file L1Menu.cxx.

{
   return {data().get_child("items"), 0,  [](auto & x){return L1Item(x.second);}};
}

board()

const TrigConf::L1Board & TrigConf::L1Menu::board

(

const std::string &

boardName

)

const

Access to boards by name.

Definition at line 429 of file L1Menu.cxx.

{
   try {
      return m_boards.at(boardName);
   }
   catch(std::exception & ex) {
      std::cerr << "No board " << boardName << " defined in the L1 menu" << std::endl;
      throw;
   }
}

boardNames()

std::vector< std::string > TrigConf::L1Menu::boardNames

(

)

const

Board names.

Definition at line 441 of file L1Menu.cxx.

{
   std::vector<std::string> boardNames;
   boardNames.reserve(m_boards.size());
   for(auto & board : m_boards) {
      boardNames.emplace_back(board.first);
   }
   return boardNames;
}

className()

virtual std::string TrigConf::L1Menu::className ( ) const

inlineoverridevirtual

A string that is the name of the class.

Reimplemented from TrigConf::DataStructure.

Definition at line 43 of file L1Menu.h.

                                                   {
         return "L1Menu";
      }

clear()

void TrigConf::L1Menu::clear ( )

overridevirtual

Clearing the configuration data.

Reimplemented from TrigConf::DataStructure.

Definition at line 150 of file L1Menu.cxx.

{
   DataStructure::clear();
 
   m_smk = 0;
   m_run = 3;
   m_connectors.clear();
   m_threshold2ConnectorName.clear();
   m_boards.clear();
   m_thresholdsByType.clear();
   m_thresholdsByName.clear();
   m_thresholdsByTypeAndMapping.clear();
 
   m_thrExtraInfo.clear();
 
   m_algorithmsByCategory.clear();
   m_algorithmsByName.clear();
   m_algorithmsByOutput.clear(); 
 
   m_ctp.clear();
}

connector()

const TrigConf::L1Connector & TrigConf::L1Menu::connector

(

const std::string &

connectorName

)

const

Access to connector by name.

Definition at line 335 of file L1Menu.cxx.

                                                               {
   try {
      return m_connectors.at(connectorName);
   }
   catch(std::exception & ex) {
      std::cerr << "No connector " << connectorName << " defined in the L1 menu" << std::endl;
      throw;
   }
}

connectorNameFromThreshold()

const std::string & TrigConf::L1Menu::connectorNameFromThreshold

(

const std::string &

thresholdName

)

const

Name of connector from name of threshold or triggerline.

Definition at line 313 of file L1Menu.cxx.

{
   try {
      return m_threshold2ConnectorName.at(thresholdName);
   }
   catch(...) {
      std::cerr << "Threshold '" << thresholdName << "' not defined as triggerline in the L1 menu" << std::endl;
      throw;      
   }
}

connectorNames()

std::vector< std::string > TrigConf::L1Menu::connectorNames

(

)

const

Connector names.

Definition at line 325 of file L1Menu.cxx.

                                     {
   std::vector<std::string> connNames;
   connNames.reserve(m_connectors.size());
   for( auto & x : m_connectors ) {
      connNames.emplace_back(x.first);
   }
   return connNames;
}

ctp()

const TrigConf::L1CTP& TrigConf::L1Menu::ctp ( ) const

inline

the CTP configuration

Definition at line 145 of file L1Menu.h.

{ return m_ctp; }

ctpVersion()

unsigned int TrigConf::L1Menu::ctpVersion

(

)

const

Accessor to the version of the CTP format.

Definition at line 179 of file L1Menu.cxx.

{
   return getAttribute<unsigned int>("ctpVersion");
}

data()

const ptree& TrigConf::DataStructure::data ( ) const

inlineinherited

Access to the underlying data, if needed.

Definition at line 83 of file DataStructure.h.

                                 {
         if( ! isInitialized() ) {
            throw std::runtime_error("Trying to access data of uninitialized object of type " + className());
         }
         // Don't use ?: operator here: it confuses cppcheck.
         if (ownsData()) {
            return *m_dataSPtr.get();
         }
         return *m_dataPtr;
      }

empty()

bool TrigConf::DataStructure::empty ( ) const

inlineinherited

Check if children exist.

Definition at line 219 of file DataStructure.h.

{ return data().empty(); }

end()

TrigConf::L1Menu::const_iterator TrigConf::L1Menu::end

(

)

const

End of the L1 items list.

Needed for range-based loops

Definition at line 223 of file L1Menu.cxx.

{
   const auto & items = data().get_child("items");
   return {items, items.size(), [](auto & x){return L1Item(x.second);}};
}

getAttribute() [1/2]

const std::string & TrigConf::DataStructure::getAttribute ( const std::string &  key, bool  ignoreIfMissing = false, const std::string &  def = ""  ) const

inherited

Definition at line 136 of file DataStructure.cxx.

{
   const auto & obj = data().get_child_optional(key);
   if( !obj ) {
      if( ignoreIfMissing ) {
         return def;
      } else {
         throw std::runtime_error(className() + "#" + name() + ": structure '" + key + "' does not exist" );
      }
   }
   // check if the key points to a plain string value
   if ( !obj.get().empty() ) {
      if ( obj.get().front().first.empty() ) {
         throw std::runtime_error(className() + "#" + name() + ": structure '" + key + "' is not a simple attribute but a list [], it needs to be accessed via getList(\"" + key + "\") -> vector<DataStructure>");
      } else {
         throw std::runtime_error(className() + "#" + name() + ": structure '" + key + "' is not a simple attribute but an object {}, it needs to be accessed via getObject(\"" + key + "\") -> DataStructure");
      }
   }
   return obj.get().data();
}

getAttribute() [2/2]

template<class T >

T TrigConf::DataStructure::getAttribute ( const std::string &  key, bool  ignoreIfMissing = false, const T &  def = T()  ) const

inlineinherited

Access to simple attribute.

Parameters

key	The path to the attribute name, relative to the current one in form "path.to.child"
ignoreIfMissing	Controls the behavior in case of missing configuration child

Definition at line 152 of file DataStructure.h.

                                                                                                     {
         const auto & obj = data().get_child_optional(key);
         if( !obj ) {
            if( ignoreIfMissing ) {
               return def;
            } else {
               throw std::runtime_error(className() + "#" + name() + ": structure '" + key + "' does not exist" );
            }
         }
         return obj.get().get_value<T>();
      }

getAttribute_optional()

template<class T >

std::optional<T> TrigConf::DataStructure::getAttribute_optional ( const std::string &  key ) const

inlineinherited

Definition at line 165 of file DataStructure.h.

                                                                        {
         const auto & obj = data().get_child_optional(key);
         if( ! obj ) {
            return std::nullopt;
         }
         auto v = obj.get().get_value_optional<T>();
         return v ? std::optional(std::move(*v)) : std::nullopt;
      }

getKeys()

std::vector< std::string > TrigConf::DataStructure::getKeys ( ) const

inherited

Access to the keys of an DataStructure which presents a dictionary.

In case the DataStructure is a list or a simple attribute, an empty vector is returned

Definition at line 250 of file DataStructure.cxx.

{
   std::vector<std::string> keys;
   if ( ! data().empty() &&
        ! data().front().first.empty() )
      {
         keys.reserve(data().size());
         for( auto & entry : data() ) {
            keys.push_back(entry.first);
         }
      }
   return keys;
}

getList()

std::vector< TrigConf::DataStructure > TrigConf::DataStructure::getList ( const std::string &  pathToChild, bool  ignoreIfMissing = false  ) const

inherited

Access to array structure.

Parameters

pathToChild	The path to the configuration child, relative to the current one in form "path.to.child"
ignoreIfMissing	Controls the behavior in case of missing configuration child

In case the child is missing and ignoreIfMissing is set to true, and empty vector will be returned. Otherwise a runtime exception will be thrown.

Definition at line 158 of file DataStructure.cxx.

{
   std::vector<TrigConf::DataStructure> childList;
   const auto & list = data().get_child_optional(pathToChild);
   if( ! list ) {
      if ( ignoreIfMissing ) {
         return childList;
      } else {
         throw std::runtime_error(className() + "#" + name() + ": structure '" + pathToChild + "' does not exist.");
      }
   }
 
   // check if the pathToChild points to a list
 
   // this check is not complete, because boost::ptree can not
   // distinguish between and empty list and an empty string. In both cases
   // the value is empty and there are no children
 
   if ( list.get().empty() ) {
      if ( list.get().get_value<std::string>() != "" ) {
         // if the value is not empty, then it is for sure an attribute ("key" : "value")
         throw std::runtime_error(className() + "#" + name() + ": structure '" + pathToChild + "' is not a list [] but a simple attribute, it needs to be accessed via [\"" + pathToChild + "\"] -> string");
      }
      // else: if the value is empty, we can not say for sure and will not
      // give this debugging hint (an empty list will be returned
   } else if ( ! list.get().front().first.empty() ) {
      throw std::runtime_error(className() + "#" + name() + ": structure '" + pathToChild + "' is not a list [] but an object {}, it needs to be accessed via getObject(\"" + pathToChild + "\") -> DataStructure");
   }
 
   childList.reserve(list.get().size());
 
   for( auto & childData : list.get() )
      childList.emplace_back( childData.second );
 
   return childList;
}

getList_optional()

std::optional< std::vector< TrigConf::DataStructure > > TrigConf::DataStructure::getList_optional ( const std::string &  pathToChild ) const

inherited

Definition at line 197 of file DataStructure.cxx.

{
   if(data().find(pathToChild) == data().not_found()) {
      return std::nullopt;
   }
   return std::optional<std::vector<TrigConf::DataStructure> >(getList(pathToChild));
}

getObject()

TrigConf::DataStructure TrigConf::DataStructure::getObject ( const std::string &  pathToChild, bool  ignoreIfMissing = false  ) const

inherited

Access to configuration object.

Parameters

pathToChild	The path to the configuration child, relative to the current one
ignoreIfMissing	Controls the behavior in case of missing configuration child

In case the child is missing and ignoreIfMissing is set to true, an uninitialized DataStructure will be returned. Otherwise a runtime exception will be thrown.

*bool ignoreIfMissing = true;
*if( const DataStructure & child = ds.getObject("path.to.child", ignoreIfMissing) ) {
    cout << child["key"] << endl;
 }

Definition at line 207 of file DataStructure.cxx.

{
   const auto & obj = data().get_child_optional(pathToChild);
   if( ! obj ) {
      if ( ignoreIfMissing ) {
         return DataStructure();
      } else {
         throw std::runtime_error(className() + "#" + name() + ": structure '" + pathToChild + "' does not exist.");
      }
   }
   // check if the pathToChild is an attribute
   if( obj.get().get_value<std::string>() != "" ) {
      throw std::runtime_error(className() + "#" + name() + ": structure '" + pathToChild + "' is not an object {} but a simple attribute, it needs to be accessed via [\"" + pathToChild + "\"] -> string");
   }
   // check if the pathToChild points to a list
   if ( obj.get().front().first.empty() ) {
      throw std::runtime_error(className() + "#" + name() + ": structure '" + pathToChild + "' is not an object {} but a list [], it needs to be accessed via getList(\"" + pathToChild + "\") -> vector<DataStructure>");
   }
   return { obj.get() };
}

getObject_optional()

std::optional< TrigConf::DataStructure > TrigConf::DataStructure::getObject_optional ( const std::string &  pathToChild ) const

inherited

Definition at line 230 of file DataStructure.cxx.

{
 
   if(const auto & obj = data().get_child_optional(pathToChild)) {
      // check if the pathToChild is an attribute
      if( obj.get().get_value<std::string>() != "" ) {
         throw std::runtime_error(className() + "#" + name() + ": structure '" + pathToChild + "' is not an object {} but a simple attribute, it needs to be accessed via [\"" + pathToChild + "\"] -> string");
      }
      // check if the pathToChild points to a list
      if ( obj.get().front().first.empty() ) {
         throw std::runtime_error(className() + "#" + name() + ": structure '" + pathToChild + "' is not an object {} but a list [], it needs to be accessed via getList(\"" + pathToChild + "\") -> vector<DataStructure>");
      }
      return std::optional<TrigConf::DataStructure>(obj.get());
   }
   return std::nullopt;
}

getValue() [1/2]

std::string TrigConf::DataStructure::getValue ( ) const

inherited

Access to simple content.

Returns

string that is the content of the structure

For instance when the json structure contains an array of values (ptree only works with strings) which one retrieved via getList, then the values in the vector<DataStructure> can be accessed using getValue

Definition at line 80 of file DataStructure.cxx.

                                      {
   const std::string value = data().get_value<std::string>();
   return value;
}

getValue() [2/2]

template<class T >

T TrigConf::DataStructure::getValue ( ) const

inlineinherited

Definition at line 108 of file DataStructure.h.

                         {
         return data().get_value<T>();
      }

getValue_optional()

template<class T >

std::optional<T> TrigConf::DataStructure::getValue_optional ( ) const

inlineinherited

access to content of the note Will return false if the value could not be converted into T

Definition at line 116 of file DataStructure.h.

                                               {
         auto v = data().get_value_optional<T>();
         return v ? std::optional<T>(std::move(*v)) : std::nullopt;
      }

hasAttribute()

bool TrigConf::DataStructure::hasAttribute ( const std::string &  key ) const

inherited

Check for attribute.

Parameters

key	The path to the attribute name, relative to the current one in form "path.to.child"

Returns

true if path key exists and is an attribute

Definition at line 86 of file DataStructure.cxx.

                                                               {
   const auto & child = data().get_child_optional( key );
   if( ! bool(child) ) // key does not exist
      return false;
   return child.get().empty(); // if empty then it is an attribute, otherwise a child note
}

hasChild()

bool TrigConf::DataStructure::hasChild ( const std::string &  path ) const

inherited

Check if child exists.

Parameters

path	The path to the child, relative to the current one in form "path.to.child"

Returns

true if path exists

Definition at line 114 of file DataStructure.cxx.

                                                            {
   const auto & child = data().get_child_optional( path );
   return bool(child);
}

isInitialized()

bool TrigConf::DataStructure::isInitialized ( ) const

inlineinherited

Definition at line 216 of file DataStructure.h.

{ return m_initialized; }

isNull()

bool TrigConf::DataStructure::isNull ( const std::string &  key ) const

inherited

Check if an attribute is null.

Parameters

key	The path to the attribute name, relative to the current one in form "path.to.child"

Returns

true if path key exists and is null

If the attribute doesn't exist, the function returns false. To check if an attribute exists and is null, use it together with hasAttribute.

Definition at line 94 of file DataStructure.cxx.

                                                         {
   auto child = data().get_child_optional( key );
   if( ! child ) {
      return false;
   }
   return child->get_value<std::string>() == "null";
}

isRun2()

bool TrigConf::L1Menu::isRun2 ( ) const

inline

Definition at line 150 of file L1Menu.h.

{ return m_run == 2; }

isValid()

bool TrigConf::DataStructure::isValid ( ) const

inlineinherited

Definition at line 215 of file DataStructure.h.

{ return m_initialized; }

isValue()

bool TrigConf::DataStructure::isValue ( ) const

inherited

Check for attribute.

Returns

true if the structure is just a value

Definition at line 74 of file DataStructure.cxx.

                                     {
   return data().empty();  // just a key->value pair, no children
}

item()

TrigConf::L1Item TrigConf::L1Menu::item

(

const std::string &

itemName

)

const

Get item by name.

Definition at line 201 of file L1Menu.cxx.

{
   if(itemName=="") {
      throw std::runtime_error("L1Menu::item() was called with empty itemName");
   }
   const ptree * pt;
   try {
      pt = & data().get_child(ptree::path_type("items/"+itemName,'/')); // '/' is not used in any item Name, so we can use it as separator in the path 
   } catch(boost::property_tree::ptree_bad_path & ex) {
      throw std::runtime_error("L1Item " + itemName + " does not exist in the menu");
   }
   return L1Item(*pt);
}

load()

void TrigConf::L1Menu::load ( )

private

Definition at line 20 of file L1Menu.cxx.

{
   if(! isInitialized() || empty() ) {
      return;
   }
 
   m_run = getAttribute_optional<int>("run").value_or(3);
   
   // thresholds
   try {
      m_name = getAttribute("name");
      for( const std::string path : {"thresholds", "thresholds.legacyCalo" } ) {
         for( auto & thrByType : data().get_child( path ) ) {
            const std::string & thrType = thrByType.first;
            if (thrType == "legacyCalo")
               continue;
         
            // first create the extraInfo object for this type of thresholds
            auto extraInfo = m_thrExtraInfo.addExtraInfo(thrByType.first,thrByType.second);
 
            auto & v = m_thresholdsByType[thrType] = std::vector<std::shared_ptr<TrigConf::L1Threshold>>();
            if(thrType == "internal") {
               for( auto & thr : data().get_child( path + ".internal.names") ) {
                  const std::string thrName = thr.second.data();
                  v.push_back( L1Threshold::createThreshold( thrName, thrType, extraInfo, thr.second ) );
               }
            } else {
               for( auto & thr : data().get_child( path + "." + thrType + ".thresholds") ) {
                  const std::string thrName = thr.first;
                  v.push_back( L1Threshold::createThreshold( thrName, thrType, extraInfo, thr.second ) );
               }
            }
            for( auto & thr : v ) {
               m_thresholdsByName[ thr->name() ] = thr;
            }
            for (auto &thr : v) {
               m_thresholdsByTypeAndMapping[thrType][thr->mapping()] = thr;
            }
         }
      }
   }
   catch(std::exception & ex) {
      std::cerr << "ERROR: problem when building L1 menu structure (thresholds). " << ex.what() << std::endl;
      throw;
   }
 
   // boards
   try {
      for( auto & board : data().get_child( "boards" ) ) {
         m_boards.emplace( std::piecewise_construct,
                           std::forward_as_tuple(board.first),
                           std::forward_as_tuple(board.first, board.second) );
      }
   }
   catch(std::exception & ex) {
      std::cerr << "ERROR: problem when building L1 menu structure (boards). " << ex.what() << std::endl;
      throw;
   }
 
   // connectors
   try {
      for( auto & conn : data().get_child( "connectors" ) ) {
         auto res = m_connectors.emplace( std::piecewise_construct,
                                          std::forward_as_tuple(conn.first),
                                          std::forward_as_tuple(conn.first, conn.second) );
         for( auto & tl : res.first->second.triggerLineNames() ) {
            m_threshold2ConnectorName.emplace( std::piecewise_construct,
                                               std::forward_as_tuple(tl),
                                               std::forward_as_tuple(conn.first));
         }
      }
   }
   catch(std::exception & ex) {
      std::cerr << "ERROR: problem when building L1 menu structure (connectors). " << ex.what() << std::endl;
      throw;
   }
 
   // algorithms
   if(m_run>1) {
      try {
         auto topoCategories = isRun2() ? std::vector<std::string> {"R2TOPO"} : std::vector<std::string> {"TOPO", "MUTOPO", "MULTTOPO", "R2TOPO"};
         for( const std::string& algoCategory : topoCategories ) {
            auto & v = m_algorithmsByCategory[algoCategory] = std::vector<TrigConf::L1TopoAlgorithm>();
            m_algorithmsByName.emplace(algoCategory, std::map<std::string, TrigConf::L1TopoAlgorithm*>());
            m_algorithmsByOutput.emplace(algoCategory, std::map<std::string, TrigConf::L1TopoAlgorithm*>());
            if(algoCategory == "MULTTOPO") {
               for( auto & alg : data().get_child( "topoAlgorithms." + algoCategory + ".multiplicityAlgorithms" ) ) {
                  v.emplace_back( alg.first, L1TopoAlgorithm::AlgorithmType::MULTIPLICITY, algoCategory, alg.second );
               }
            } else {
               for( L1TopoAlgorithm::AlgorithmType algoType : { L1TopoAlgorithm::AlgorithmType::DECISION, L1TopoAlgorithm::AlgorithmType::SORTING } ) {
                  std::string subpath = "topoAlgorithms." + algoCategory + (algoType==L1TopoAlgorithm::AlgorithmType::DECISION ? ".decisionAlgorithms" : ".sortingAlgorithms" );  
                  for( auto & algorithm : data().get_child( subpath ) ) {
                     v.emplace_back( algorithm.first, algoType, algoCategory, algorithm.second );
                  }
               }
            }
            for( auto & algo : v ) {
               if( m_algorithmsByName[algoCategory].count(algo.name()) > 0 ) {
                  std::cerr << "ERROR : Topo algorithm with name " << algo.name() << " and of type " << algoCategory << " already exists" << std::endl;
                  throw std::runtime_error("Found duplicate topo algorithm name " + algo.name() + " of type " + algoCategory);
               }
               m_algorithmsByName[ algoCategory ][ algo.name() ] = & algo;
               for( const std::string & output : algo.outputs() ) {
                  if( m_algorithmsByOutput[algoCategory].count(output) > 0 ) {
                     std::cerr << "ERROR : Topo algorithm output " << output << " already exists" << std::endl;
                     throw std::runtime_error("Found duplicate topo algorithm output " + output + " of type " + algoCategory);
                  }
                  m_algorithmsByOutput[algoCategory][output] = & algo;
               }
            }
         }
      }
      catch(std::exception & ex) {
         std::cerr << "ERROR: problem when building L1 menu structure (algorithms). " << ex.what() << std::endl;
         throw;
      }
   }
 
   // CTP
   try {
      m_ctp.setData(data().get_child("ctp"));
   }
   catch(std::exception & ex) {
      std::cerr << "ERROR: problem when building L1 menu structure (CTP). " << ex.what() << std::endl;
      throw;
   }
}

name()

const std::string & TrigConf::DataStructure::name ( ) const

finalvirtualinherited

Definition at line 109 of file DataStructure.cxx.

                                  {
   return m_name;
}

operator bool()

TrigConf::DataStructure::operator bool ( ) const

inlineexplicitinherited

Access to initialized state.

Definition at line 214 of file DataStructure.h.

{ return m_initialized; }

operator[]()

std::string TrigConf::DataStructure::operator[] ( const std::string &  key ) const

inherited

Access to simple attribute.

Parameters

key	The path to the attribute name, relative to the current one in form "path.to.child"

Definition at line 121 of file DataStructure.cxx.

{
   const auto & obj = data().get_child(key);
   // check if the key points to a plain string value
   if ( !obj.empty() ) {
      if ( obj.front().first.empty() ) {
         throw std::runtime_error(className() + "#" + name() + ": structure '" + key + "' is not a simple attribute but a list [], it needs to be accessed via getList(\"" + key + "\") -> vector<DataStructure>");
      } else {
         throw std::runtime_error(className() + "#" + name() + ": structure '" + key + "' is not a simple attribute but an object {}, it needs to be accessed via getObject(\"" + key + "\") -> DataStructure");
      }
   }
   return obj.data();
}

ownsData()

bool TrigConf::DataStructure::ownsData ( ) const

inlineinherited

Definition at line 242 of file DataStructure.h.

                            {
         return (bool)m_dataSPtr;
      }

print()

void TrigConf::DataStructure::print ( std::ostream &  os = std::cout ) const

virtualinherited

Reimplemented in TrigConf::L1TopoAlgorithm, and TrigConf::L1Threshold_EM.

Definition at line 272 of file DataStructure.cxx.

{
   printElement("", data(), 0, os);
   os << std::endl;
}

printElement()

void TrigConf::DataStructure::printElement ( const std::string &  key, const ptree &  data, uint  level = 0, std::ostream &  os = std::cout  )

staticinherited

Static function to print a ptree object.

Parameters

key	The key of this data as found in the parent structure
data	The ptree to print
level	The substruture level used to indent the output
os	The output stream

Definition at line 279 of file DataStructure.cxx.

{
   constexpr char del = '"';
 
   const std::string value = data.get_value<std::string>();
 
   if( data.empty() ) { // no children, so just a key->value pair
      uint n(4*level); while(n--) os << " ";
      os << del << key << del << ": " << del << value << del;
      return;
   }
 
 
   bool isArray ( data.begin()->first.empty() ); // dictionaries have keys, arrays don't
   { uint n(4*level); while(n--) os << " "; }
   if ( ! key.empty() )
      os << del << key << del << ": ";
   os << (isArray ? "[" : "{") << std::endl;
 
   size_t childCounter = data.size();
   for( const boost::property_tree::ptree::value_type & x : data ) {
      printElement(x.first, x.second, level + 1, os);
      if( --childCounter ) os << ",";
      os << std::endl;
   }
   { uint n(4*level); while(n--) os << " "; }
   os << (isArray ? "]" : "}");
 
}

printMenu()

void TrigConf::L1Menu::printMenu

(

bool

full = false

)

const

print overview of L1 Menu

Definition at line 455 of file L1Menu.cxx.

{
   cout << "L1 menu '" << name() << "'" << endl;
   cout << "Items: " << size() << endl;
   if(full) {
      int c(0);
      for(const L1Item & item : *this ) {
         cout << "  " << c++ << ": " << item.name() << endl;
      }
   }
   cout << "Thresholds: " << thresholds().size() << "(of " << thresholdTypes().size() << " different types)" << endl;
   if(full) {
      int c(0);
      for(const std::string & thrType : thresholdTypes() ) {
         cout << thrType << " :" << endl;
         for(auto & thr : thresholds(thrType)) {
            cout << "  " << c++ << ": " << thr->name() << "[" << thr->type() << "]" << endl;
         }
      }
   }
   if(m_run>1) {
      cout << "Topo algorithms: " << endl;
      cout << "    new   : " << data().get_child("topoAlgorithms.TOPO.decisionAlgorithms").size() << endl;
      cout << "    muon  : " << data().get_child("topoAlgorithms.MUTOPO.decisionAlgorithms").size() << endl;
      cout << "    mult  : " << data().get_child("topoAlgorithms.MULTTOPO.multiplicityAlgorithms").size() << endl;
      cout << "    legacy: " << data().get_child("topoAlgorithms.R2TOPO.decisionAlgorithms").size() << endl;
   }
   cout << "Boards: " << data().get_child("boards").size() << endl;
   cout << "Connectors: " << data().get_child("connectors").size() << endl;
   unsigned int ctpinputs = data().get_child("ctp.inputs.optical").size();
   ctpinputs += data().get_child("ctp.inputs.electrical").size();
   ctpinputs += data().get_child("ctp.inputs.ctpin.slot7").size();
   ctpinputs += data().get_child("ctp.inputs.ctpin.slot8").size();
   ctpinputs += data().get_child("ctp.inputs.ctpin.slot9").size();
   cout << "CTP connections: " << ctpinputs << endl;
}

printRaw()

void TrigConf::DataStructure::printRaw ( std::ostream &  os = std::cout ) const

inherited

Definition at line 265 of file DataStructure.cxx.

{
   boost::property_tree::json_parser::write_json( os, data() );
}

run()

unsigned int TrigConf::L1Menu::run ( ) const

inline

Definition at line 152 of file L1Menu.h.

{ return m_run; }

setData() [1/2]

void TrigConf::DataStructure::setData ( const ptree &  data )

inherited

Setting the configuration data.

Definition at line 39 of file DataStructure.cxx.

{
   clear();
   m_initialized = true;
   m_dataSPtr.reset();
   m_dataPtr = &data;
   update();
}

setData() [2/2]

void TrigConf::DataStructure::setData ( ptree &&  data )

inherited

Definition at line 50 of file DataStructure.cxx.

{
   clear();
   m_initialized = true;
   m_dataSPtr = std::make_shared<ptree>(std::move(data));
   m_dataPtr = nullptr;
   update();
}

setName()

void TrigConf::DataStructure::setName ( const std::string &  n )

inherited

Setting the configuration element name.

Definition at line 59 of file DataStructure.cxx.

                                                      {
   m_name = n;
}

setSMK()

void TrigConf::L1Menu::setSMK

(

unsigned int

psk

)

Definition at line 196 of file L1Menu.cxx.

                                       {
   m_smk = smk;
}

size()

std::size_t TrigConf::L1Menu::size

(

)

const

Accessor to the number of L1 items.

Definition at line 185 of file L1Menu.cxx.

{
   return data().get_child("items").size();
}

smk()

unsigned int TrigConf::L1Menu::smk

(

)

const

setter and getter for the supermasterkey

Definition at line 191 of file L1Menu.cxx.

                          {
   return m_smk;
}

threshold() [1/2]

const TrigConf::L1Threshold & TrigConf::L1Menu::threshold

(

const std::string &

thresholdName

)

const

Access to L1Threshold by name.

Definition at line 279 of file L1Menu.cxx.

{
   try {
      return * m_thresholdsByName.at(thresholdName);
   }
   catch(std::exception & ex) {
      std::cerr << "No threshold '" << thresholdName << "' defined in the thresholds section of the L1 menu" << std::endl;
      throw;
   }
}

threshold() [2/2]

const TrigConf::L1Threshold & TrigConf::L1Menu::threshold	(	const std::string &	typeName,
		unsigned int	mapping
	)		const

Access to L1Threshold by type and mapping index.

Definition at line 292 of file L1Menu.cxx.

{
   try
   {
      return *m_thresholdsByTypeAndMapping.at(typeName).at(mapping);
   }
   catch (std::exception &ex)
   {
      std::cerr << "No threshold of type '" << typeName << "' with mapping " << mapping
                << " defined in the thresholds section of the L1 menu" << std::endl;
      throw;
   }
}

thresholdNames()

std::vector< std::string > TrigConf::L1Menu::thresholdNames

(

)

const

List of L1 thresholds names.

Definition at line 242 of file L1Menu.cxx.

{
   std::vector<std::string> thrNames;
   thrNames.reserve(m_thresholdsByName.size());
   for( auto x : m_thresholdsByName ) {
      thrNames.emplace_back(x.first);
   }
   return thrNames;
}

thresholds() [1/2]

std::vector< std::shared_ptr< TrigConf::L1Threshold > > TrigConf::L1Menu::thresholds

(

)

const

Access to list of all L1Thresholds.

Definition at line 267 of file L1Menu.cxx.

{
   std::vector<std::shared_ptr<TrigConf::L1Threshold>> thrlist;
   for ( const std::string & type : thresholdTypes() ) {
      const auto & thrOfType = thresholds(type);
      std::copy(thrOfType.begin(), thrOfType.end(), std::back_inserter(thrlist));
   }
   return thrlist;
}

thresholds() [2/2]

const std::vector< std::shared_ptr< TrigConf::L1Threshold > > & TrigConf::L1Menu::thresholds

(

const std::string &

typeName

)

const

Access to list of L1Thresholds by type.

Definition at line 254 of file L1Menu.cxx.

{
   try {
      return m_thresholdsByType.at(typeName);
   }
   catch(std::exception & ex) {
      std::cerr << "No threshold type '" << typeName << "' defined in the thresholds section of the L1 menu" << std::endl;
      throw;
   }
}

thresholdTypes()

std::vector< std::string > TrigConf::L1Menu::thresholdTypes

(

)

const

List of L1 thresholds types.

Definition at line 231 of file L1Menu.cxx.

{
   std::vector<std::string> thrTypeNames;
   thrTypeNames.reserve(m_thresholdsByType.size());
   for( auto x : m_thresholdsByType ) {
      thrTypeNames.emplace_back(x.first);
   }
   return thrTypeNames;
}

thrExtraInfo()

const TrigConf::L1ThrExtraInfo & TrigConf::L1Menu::thrExtraInfo

(

)

const

Access to extra info for threshold types.

Definition at line 307 of file L1Menu.cxx.

{
   return m_thrExtraInfo;
}

topoAlgorithmNames()

std::vector< std::string > TrigConf::L1Menu::topoAlgorithmNames

(

const std::string &

category

)

const

Access to topo algorithm names.

Parameters

category

must be one of "TOPO", "MUTOPO", "MULTTOPO", or "R2TOPO"

TOPO ... new topo algorithms, R2TOPO ... Run-2 topo algorithms MUTOPO ... MUCTPI topo algorithms MULTTOPO ... multiplicity algorithms

Definition at line 347 of file L1Menu.cxx.

{
   std::vector<std::string> algoNames;
   try {
      for(auto & entry : m_algorithmsByName.at(category) ) {
         algoNames.push_back(entry.first);
      }
   }
   catch(std::exception & ex) {
      std::cerr << "No algorithm category '" << category << "' defined in the L1 menu" << std::endl;
      throw;
   }
   return algoNames;
}

topoAlgorithmOutputNames()

std::vector< std::string > TrigConf::L1Menu::topoAlgorithmOutputNames

(

const std::string &

category

)

const

Access to topo algoritm output names.

Definition at line 364 of file L1Menu.cxx.

{
   std::vector<std::string> outputNames;
   try {
      for(auto & entry : m_algorithmsByOutput.at(category) ) {
         outputNames.push_back(entry.first);
      }
   }
   catch(std::exception & ex) {
      std::cerr << "No algorithm category '" << category << "' defined in the L1 menu" << std::endl;
      throw;
   }
   return outputNames;
}

update()

virtual void TrigConf::L1Menu::update ( )

inlineoverrideprivatevirtual

Update the internal data after modification of the data object.

Reimplemented from TrigConf::DataStructure.

Definition at line 160 of file L1Menu.h.

{ load(); };

version()

unsigned int TrigConf::L1Menu::version

(

)

const

Accessor to the menu version.

Definition at line 173 of file L1Menu.cxx.

{
   return getAttribute<unsigned int>("version");
}

Member Data Documentation

m_algorithmsByCategory

std::map<std::string, std::vector<TrigConf::L1TopoAlgorithm> > TrigConf::L1Menu::m_algorithmsByCategory {}

private

algorithm maps

Definition at line 185 of file L1Menu.h.

m_algorithmsByName

std::map<std::string, std::map<std::string, TrigConf::L1TopoAlgorithm*> > TrigConf::L1Menu::m_algorithmsByName {}

private

Definition at line 186 of file L1Menu.h.

m_algorithmsByOutput

std::map<std::string, std::map<std::string, TrigConf::L1TopoAlgorithm*> > TrigConf::L1Menu::m_algorithmsByOutput {}

private

Definition at line 187 of file L1Menu.h.

m_boards

std::map<std::string, TrigConf::L1Board> TrigConf::L1Menu::m_boards {}

private

board by name

Definition at line 175 of file L1Menu.h.

m_connectors

std::map<std::string, TrigConf::L1Connector> TrigConf::L1Menu::m_connectors {}

private

connector by name

Definition at line 169 of file L1Menu.h.

m_ctp

TrigConf::L1CTP TrigConf::L1Menu::m_ctp

private

Definition at line 189 of file L1Menu.h.

m_dataPtr

const ptree* TrigConf::DataStructure::m_dataPtr { nullptr }

protectedinherited

Definition at line 257 of file DataStructure.h.

m_dataSPtr

std::shared_ptr<ptree> TrigConf::DataStructure::m_dataSPtr { nullptr }

protectedinherited

Definition at line 256 of file DataStructure.h.

m_initialized

bool TrigConf::DataStructure::m_initialized { false }

protectedinherited

if initialized, the underlying ptree is has been assigned to (can be empty)

Definition at line 254 of file DataStructure.h.

m_name

std::string TrigConf::DataStructure::m_name {""}

protectedinherited

Definition at line 259 of file DataStructure.h.

m_run

unsigned int TrigConf::L1Menu::m_run {3}

private

Definition at line 166 of file L1Menu.h.

m_smk

unsigned int TrigConf::L1Menu::m_smk {0}

private

the supermasterkey

Definition at line 164 of file L1Menu.h.

m_threshold2ConnectorName

std::map<std::string, std::string> TrigConf::L1Menu::m_threshold2ConnectorName {}

private

connector name by threshold name

Definition at line 172 of file L1Menu.h.

m_thresholdsByName

std::map<std::string, std::shared_ptr<TrigConf::L1Threshold> > TrigConf::L1Menu::m_thresholdsByName {}

private

Definition at line 179 of file L1Menu.h.

m_thresholdsByType

std::map<std::string, std::vector<std::shared_ptr<TrigConf::L1Threshold> > > TrigConf::L1Menu::m_thresholdsByType {}

private

threshold maps

Definition at line 178 of file L1Menu.h.

m_thresholdsByTypeAndMapping

std::map<std::string, std::map<unsigned int, std::shared_ptr<TrigConf::L1Threshold> > > TrigConf::L1Menu::m_thresholdsByTypeAndMapping {}

private

Definition at line 180 of file L1Menu.h.

m_thrExtraInfo

TrigConf::L1ThrExtraInfo TrigConf::L1Menu::m_thrExtraInfo

private

Definition at line 182 of file L1Menu.h.

---

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

• L1Menu.h
• L1Menu.cxx