L1Topo algorithm configuration. More...

#include <L1TopoAlgorithm.h>

Inheritance diagram for TrigConf::L1TopoAlgorithm:

Collaboration diagram for TrigConf::L1TopoAlgorithm:

Classes
struct	VariableParameter

Public Types
enum	AlgorithmType { AlgorithmType::SORTING, AlgorithmType::DECISION, AlgorithmType::MULTIPLICITY, AlgorithmType::UNKNOWN }

using	ptree = boost::property_tree::ptree

Public Member Functions
	L1TopoAlgorithm ()=default
	Constructor. More...

	L1TopoAlgorithm (const L1TopoAlgorithm &)=delete

L1TopoAlgorithm &	operator= (const L1TopoAlgorithm &)=delete

	L1TopoAlgorithm (L1TopoAlgorithm &&)=default

	L1TopoAlgorithm (const std::string &algoName, AlgorithmType algoType, const std::string &algoCategory, const ptree &data)
	Constructor initialized with configuration data. More...

virtual	~L1TopoAlgorithm () override=default
	Destructor. More...

virtual std::string	className () const override
	A string that is the name of the class. More...

AlgorithmType	type () const

const std::string &	category () const

const std::string &	klass () const
	Accessor to algorithm class type. More...

const std::vector< std::string > &	inputs () const
	Accessor to input collections Sorting and Multiplicity algorithms have only one input. More...

const std::vector< std::string > &	outputs () const
	Accessor to output collections Sorting and Multiplicity algorithms have only one output. More...

std::vector< std::string >	fullOutputs () const

DataStructure	generics () const
	Accessors to generic parameters. More...

std::string	genericParameter (const std::string &parName) const

template<class T >
T	genericParameter (const std::string &parName) const

const std::vector< VariableParameter > &	parameters () const
	Accessor to register parameters which can change for each algorithm instance. More...

void	print (std::ostream &os=std::cout) const override
	print main info 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

virtual void	clear ()
	Clearing the configuration data. More...

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

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 Member Functions
virtual void	update () override
	Update the internal data after modification of the data 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
void	load ()
	Update the internal data after modification of the data object. More...

Private Attributes
AlgorithmType	m_type { AlgorithmType::UNKNOWN }

std::string	m_category {}

std::vector< std::string >	m_inputs {}

std::vector< std::string >	m_outputs {}

std::vector< VariableParameter >	m_parameters

Detailed Description

L1Topo algorithm configuration.

Provides access to the L1Topo algorithm name and type and the selection parameters, input and output collections. Can hold sorting and decision algorithms

Definition at line 20 of file L1TopoAlgorithm.h.

Member Typedef Documentation

◆ ptree

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

inherited

Definition at line 40 of file DataStructure.h.

Member Enumeration Documentation

◆ AlgorithmType

enum TrigConf::L1TopoAlgorithm::AlgorithmType

strong

Enumerator
SORTING
DECISION
MULTIPLICITY
UNKNOWN

Definition at line 23 of file L1TopoAlgorithm.h.

23 { SORTING, DECISION, MULTIPLICITY, UNKNOWN };

Constructor & Destructor Documentation

◆ L1TopoAlgorithm() [1/4]

TrigConf::L1TopoAlgorithm::L1TopoAlgorithm ( )

default

Constructor.

◆ L1TopoAlgorithm() [2/4]

TrigConf::L1TopoAlgorithm::L1TopoAlgorithm ( const L1TopoAlgorithm & )

delete

◆ L1TopoAlgorithm() [3/4]

TrigConf::L1TopoAlgorithm::L1TopoAlgorithm ( L1TopoAlgorithm && )

default

◆ L1TopoAlgorithm() [4/4]

TrigConf::L1TopoAlgorithm::L1TopoAlgorithm	(	const std::string &	algoName,
		AlgorithmType	algoType,
		const std::string &	algoCategory,
		const ptree &	data
	)

Constructor initialized with configuration data.

Parameters

data	The data containing the L1Topo menu

Definition at line 8 of file L1TopoAlgorithm.cxx.

    : DataStructure(data),
      m_type(algoType),
      m_category(algoCategory)
 {
    if( m_category != "TOPO" && m_category != "MUTOPO" && m_category != "R2TOPO" && m_category != "MULTTOPO") {
       throw std::runtime_error("Algorithm category must be TOPO, R2TOPO, MUTOPO or MULTTOPO, but is '" + algoCategory + "'");
    }
    m_name = algoName;
    load();
 }

◆ ~L1TopoAlgorithm()

virtual TrigConf::L1TopoAlgorithm::~L1TopoAlgorithm ( )

overridevirtualdefault

Destructor.

Member Function Documentation

◆ category()

const std::string & TrigConf::L1TopoAlgorithm::category ( ) const

Definition at line 92 of file L1TopoAlgorithm.cxx.

 {
    return m_category;
 }

◆ className()

std::string TrigConf::L1TopoAlgorithm::className ( ) const

overridevirtual

A string that is the name of the class.

Reimplemented from TrigConf::DataStructure.

Definition at line 21 of file L1TopoAlgorithm.cxx.

                                          {
    return "L1TopoAlgorithm";
 }

◆ clear()

void TrigConf::DataStructure::clear ( )

virtualinherited

Clearing the configuration data.

should be overloaded by derived object that have to clear data

leads to an uninitialized object

Reimplemented in TrigConf::L1Menu, TrigConf::L1BunchGroupSet, TrigConf::HLTMenu, TrigConf::HLTMonitoring, TrigConf::HLTPrescalesSet, TrigConf::L1CTP, and TrigConf::L1PrescalesSet.

Definition at line 65 of file DataStructure.cxx.

 {
    m_initialized = false;
    m_dataSPtr = nullptr;
    m_dataPtr = nullptr;
 }

◆ 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.

219 { return data().empty(); }

◆ fullOutputs()

std::vector< std::string > TrigConf::L1TopoAlgorithm::fullOutputs ( ) const

Definition at line 119 of file L1TopoAlgorithm.cxx.

 {
    std::vector<std::string> out;
    for( auto & s : m_outputs ) {
       out.push_back(m_category + "_" + s);
    }
    return out;
 }

◆ genericParameter() [1/2]

std::string TrigConf::L1TopoAlgorithm::genericParameter ( const std::string & parName ) const

Definition at line 129 of file L1TopoAlgorithm.cxx.

 {
    return operator[]("fixedParameters.generics." + parName + ".value");
 }

◆ genericParameter() [2/2]

template<class T >

T TrigConf::L1TopoAlgorithm::genericParameter ( const std::string & parName ) const

inline

Definition at line 80 of file L1TopoAlgorithm.h.

                                                           {
          return getAttribute<T>("fixedParameters.generics." + parName + ".value");
       }

◆ generics()

TrigConf::DataStructure TrigConf::L1TopoAlgorithm::generics ( ) const

Accessors to generic parameters.

Definition at line 135 of file L1TopoAlgorithm.cxx.

 {
    return getObject("fixedParameters.generics");
 }

◆ 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);
 }

◆ inputs()

const std::vector< std::string > & TrigConf::L1TopoAlgorithm::inputs ( ) const

Accessor to input collections Sorting and Multiplicity algorithms have only one input.

Definition at line 107 of file L1TopoAlgorithm.cxx.

 {
    return m_inputs;
 }

◆ isInitialized()

bool TrigConf::DataStructure::isInitialized ( ) const

inlineinherited

Definition at line 216 of file DataStructure.h.

216 { 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";
 }

◆ isValid()

bool TrigConf::DataStructure::isValid ( ) const

inlineinherited

Definition at line 215 of file DataStructure.h.

215 { 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
 }

◆ klass()

const std::string & TrigConf::L1TopoAlgorithm::klass ( ) const

Accessor to algorithm class type.

Definition at line 98 of file L1TopoAlgorithm.cxx.

 {
    if(hasAttribute("klass")) {
       return getAttribute("klass");
    }
    return getAttribute("type");
 }

◆ load()

void TrigConf::L1TopoAlgorithm::load ( )

private

Update the internal data after modification of the data object.

Definition at line 26 of file L1TopoAlgorithm.cxx.

 {
    if(! isInitialized() || empty() ) {
       return;
    }
    if( m_type == AlgorithmType::DECISION ) { // DECISION algo
       if( hasChild("input") ) {
          for( auto & inp : getList("input")) {
             m_inputs.push_back(inp.getValue());
          }
       } else if( hasChild("fixedParameters.inputs") ) { // backwards compatibility, to be removed when we stop using DEV db
          for( auto & inp : getList("fixedParameters.inputs")) {
             m_inputs.push_back(inp["value"]);
          }
       }
       for( auto & o : getList("output")) {
          m_outputs.push_back(o.getValue());
       }
    } else if( m_type == AlgorithmType::MULTIPLICITY ) { // MULTIPLICITY algo
  
       if(auto & input = getAttribute("input"); input!="null") {
          m_inputs.push_back(input);
       }
       if(hasAttribute("flavour")){ // EnergyThreshold
          m_parameters.emplace_back("flavour", TrigConf::XEFlavour::flavourStrToInt(getAttribute("flavour")));     
       }
       m_outputs.push_back(getAttribute("output"));
    } else { // SORTING algo
       if( hasAttribute("input") ) {
          m_inputs.push_back( getAttribute("input") );
       } else if( hasChild("fixedParameters.input") ) { // backwards compatibility, to be removed when we stop using DEV db
          auto inp = getObject("fixedParameters.input");
          for( auto & k : inp.getKeys() ) {
             m_inputs.push_back(inp[k]);
             break;
          }
       }
       m_outputs.push_back(getAttribute("output"));
    }
  
    if( m_type == AlgorithmType::DECISION || m_type == AlgorithmType::SORTING ) {
       for( auto & p : getList("variableParameters") ) {
          if (p["name"] == "MaxMSqr") {
            unsigned int val = p.getAttribute<unsigned int>("value");
            // Work around overflow in the database...
            if (val >= 1u<<31) {
          // Expected maximum value of Inv M^2 in 100 MeV unit
              val = 1024*1024*10*10*10;
            }
            m_parameters.emplace_back(p["name"], val, p.getAttribute_optional<unsigned int>("selection"));
          }
          else {
            m_parameters.emplace_back(p["name"], p.getAttribute<int>("value"), p.getAttribute_optional<unsigned int>("selection"));
          }
       }
    }
  
 }

◆ 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.

214 { return m_initialized; }

◆ operator=()

L1TopoAlgorithm& TrigConf::L1TopoAlgorithm::operator= ( const L1TopoAlgorithm & )

delete

◆ 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();
 }

◆ outputs()

const std::vector< std::string > & TrigConf::L1TopoAlgorithm::outputs ( ) const

Accessor to output collections Sorting and Multiplicity algorithms have only one output.

Definition at line 113 of file L1TopoAlgorithm.cxx.

 {
    return m_outputs;
 }

◆ ownsData()

bool TrigConf::DataStructure::ownsData ( ) const

inlineinherited

Definition at line 242 of file DataStructure.h.

                             {
          return (bool)m_dataSPtr;
       }

◆ parameters()

const std::vector< TrigConf::L1TopoAlgorithm::VariableParameter > & TrigConf::L1TopoAlgorithm::parameters ( ) const

Accessor to register parameters which can change for each algorithm instance.

Definition at line 141 of file L1TopoAlgorithm.cxx.

 {
    return m_parameters;
 }

◆ print()

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

overridevirtual

print main info

Reimplemented from TrigConf::DataStructure.

Definition at line 148 of file L1TopoAlgorithm.cxx.

 {
    os << "Algorithm " << name() << " (class " << klass() << ", category " << m_category << ")" << std::endl;
    os << "  input:" << std::endl;
    for( auto & input : inputs() ) {
       os << "    " << input << std::endl;
    }
    os << "  output:" << std::endl;
    for( auto & output : outputs() ) {
       os << "    " << output << std::endl;
    }
    os << "  full output:" << std::endl;
    for( auto & output : fullOutputs() ) {
       os << "    " << output << std::endl;
    }
    if(type() == AlgorithmType::MULTIPLICITY) {
       os << "  threshold definition: " << getAttribute("threshold") << std::endl;
       os << "  number of output bits: " << getAttribute<unsigned int>("nbits") << std::endl;
    } else {
       os << "  generic parameters:" << std::endl;
       auto genPars = generics();
       for( auto & k : genPars.getKeys() ) {
          os << "    " << k << "  ==>  " <<  genericParameter(k) << std::endl;
       }
       os << "  parameters:" << std::endl;
       auto pars = parameters();
       unsigned int idx{0};
       for( auto & p : pars ) {
          os << "    " << idx++ << "  " << p.name() << "[" << p.selection() << "]  ==>  " <<  p.value() << std::endl;
       }
    }
    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 ? "]" : "}");
  
 }

◆ 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() );
 }

◆ 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;
 }

◆ type()

TrigConf::L1TopoAlgorithm::AlgorithmType TrigConf::L1TopoAlgorithm::type ( ) const

Definition at line 86 of file L1TopoAlgorithm.cxx.

 {
    return m_type;
 }

◆ update()

virtual void TrigConf::L1TopoAlgorithm::update ( )

inlineoverrideprotectedvirtual

Update the internal data after modification of the data object.

to be implemented by the derived class

Reimplemented from TrigConf::DataStructure.

Definition at line 92 of file L1TopoAlgorithm.h.

92 { load(); }

Member Data Documentation

◆ m_category

std::string TrigConf::L1TopoAlgorithm::m_category {}

private

Definition at line 101 of file L1TopoAlgorithm.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_inputs

std::vector<std::string> TrigConf::L1TopoAlgorithm::m_inputs {}

private

Definition at line 103 of file L1TopoAlgorithm.h.

◆ m_name

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

protectedinherited

Definition at line 259 of file DataStructure.h.

◆ m_outputs

std::vector<std::string> TrigConf::L1TopoAlgorithm::m_outputs {}

private

Definition at line 104 of file L1TopoAlgorithm.h.

◆ m_parameters

std::vector<VariableParameter> TrigConf::L1TopoAlgorithm::m_parameters

private

Definition at line 106 of file L1TopoAlgorithm.h.

◆ m_type

AlgorithmType TrigConf::L1TopoAlgorithm::m_type { AlgorithmType::UNKNOWN }

private

Definition at line 99 of file L1TopoAlgorithm.h.

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

Classes

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ ptree

Member Enumeration Documentation

◆ AlgorithmType

Constructor & Destructor Documentation

◆ L1TopoAlgorithm() [1/4]

◆ L1TopoAlgorithm() [2/4]

◆ L1TopoAlgorithm() [3/4]

◆ L1TopoAlgorithm() [4/4]

◆ ~L1TopoAlgorithm()

Member Function Documentation

◆ category()

◆ className()

◆ clear()

◆ data()

◆ empty()

◆ fullOutputs()

◆ genericParameter() [1/2]

◆ genericParameter() [2/2]

◆ generics()

◆ getAttribute() [1/2]

◆ getAttribute() [2/2]

◆ getAttribute_optional()

◆ getKeys()

◆ getList()

◆ getList_optional()

◆ getObject()

◆ getObject_optional()

◆ getValue() [1/2]

◆ getValue() [2/2]

◆ getValue_optional()

◆ hasAttribute()

◆ hasChild()

◆ inputs()

◆ isInitialized()

◆ isNull()

◆ isValid()

◆ isValue()

◆ klass()

◆ load()

◆ name()

◆ operator bool()

◆ operator=()

◆ operator[]()

◆ outputs()

◆ ownsData()

◆ parameters()

◆ print()

◆ printElement()

◆ printRaw()

◆ setData() [1/2]

◆ setData() [2/2]

◆ setName()

◆ type()

◆ update()

Member Data Documentation

◆ m_category

◆ m_dataPtr

◆ m_dataSPtr

◆ m_initialized

◆ m_inputs

◆ m_name

◆ m_outputs

◆ m_parameters

◆ m_type