TrigConf::L1TopoOutput Class Reference

L1Topo output line configuration. More...

#include <L1TopoOutput.h>

Inheritance diagram for TrigConf::L1TopoOutput:

Collaboration diagram for TrigConf::L1TopoOutput:

Public Types
using	ptree = boost::property_tree::ptree

Public Member Functions
	L1TopoOutput ()
	Constructor. More...
	L1TopoOutput (const boost::property_tree::ptree &data)
	Constructor initialized with configuration data. More...
virtual	~L1TopoOutput () override=default
	Destructor. More...
virtual std::string	className () const override
	A string that is the name of the class. More...
const std::string &	algName () const
	Accessor to the algorithm name. More...
unsigned int	clock () const
	Accessor to the clock the signals are sent on. More...
unsigned int	firstBit () const
	Accessor to the cable bit of the first signal. More...
unsigned int	fpga () const
	Accessor to the FPGA number. More...
unsigned int	board () const
	Accessor to the board number. More...
const std::string &	triggerLines () const
	Accessor to the algorithm trigger lines. 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
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 Member Functions
virtual void	update ()
	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 {""}

Detailed Description

L1Topo output line configuration.

Provides access to the name of the trigger line, to the connected algorithm and the lines the signals are being sent on.

Definition at line 18 of file L1TopoOutput.h.

Member Typedef Documentation

ptree

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

inherited

Definition at line 40 of file DataStructure.h.

Constructor & Destructor Documentation

L1TopoOutput() [1/2]

TrigConf::L1TopoOutput::L1TopoOutput

(

)

Constructor.

Definition at line 7 of file L1TopoOutput.cxx.

{}

L1TopoOutput() [2/2]

TrigConf::L1TopoOutput::L1TopoOutput

(

const boost::property_tree::ptree &

data

)

Constructor initialized with configuration data.

Parameters

data	The data containing the L1Topo output line

Definition at line 10 of file L1TopoOutput.cxx.

   : DataStructure(data)
{}

~L1TopoOutput()

virtual TrigConf::L1TopoOutput::~L1TopoOutput ( )

overridevirtualdefault

Destructor.

Member Function Documentation

algName()

const std::string & TrigConf::L1TopoOutput::algName

(

)

const

Accessor to the algorithm name.

Definition at line 15 of file L1TopoOutput.cxx.

{
   return getAttribute("algName");
}

board()

unsigned int TrigConf::L1TopoOutput::board

(

)

const

Accessor to the board number.

The board number can be 0 or 1

Definition at line 39 of file L1TopoOutput.cxx.

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

className()

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

inlineoverridevirtual

A string that is the name of the class.

Reimplemented from TrigConf::DataStructure.

Definition at line 32 of file L1TopoOutput.h.

                                                   {
         return "L1TopoOutput";
      }

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

clock()

unsigned int TrigConf::L1TopoOutput::clock

(

)

const

Accessor to the clock the signals are sent on.

The clock is 0 or 1. In case of multiple output signals from the same algorithm, they are all on the same clock

Definition at line 21 of file L1TopoOutput.cxx.

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

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

firstBit()

unsigned int TrigConf::L1TopoOutput::firstBit

(

)

const

Accessor to the cable bit of the first signal.

In case of multiple signals, they are consecutive, starting at this bit.

Definition at line 27 of file L1TopoOutput.cxx.

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

fpga()

unsigned int TrigConf::L1TopoOutput::fpga

(

)

const

Accessor to the FPGA number.

The FPGA number can be 0 or 1

Definition at line 33 of file L1TopoOutput.cxx.

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

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

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
}

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 ? "]" : "}");
 
}

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

triggerLines()

const std::string & TrigConf::L1TopoOutput::triggerLines

(

)

const

Accessor to the algorithm trigger lines.

Comma-separated list of line names

Definition at line 45 of file L1TopoOutput.cxx.

{
   return getAttribute("triggerLines");
}

update()

virtual void TrigConf::DataStructure::update ( )

inlineprotectedvirtualinherited

Update the internal data after modification of the data object.

to be implemented by the derived class

Reimplemented in TrigConf::L1Threshold_MU, TrigConf::L1Threshold_gTE, TrigConf::L1Threshold_gXE, TrigConf::L1Threshold_jTE, TrigConf::L1Threshold_jXE, TrigConf::L1Threshold_gLJ, TrigConf::L1Threshold_gJ, TrigConf::L1Threshold_jLJ, TrigConf::L1Threshold_jJ, TrigConf::L1Threshold_cTAU, TrigConf::L1Threshold_jTAU, TrigConf::L1Threshold_Calo, TrigConf::L1Threshold_eTAU, TrigConf::L1Threshold_jEM, TrigConf::L1Threshold_eEM, TrigConf::L1Threshold, TrigConf::L1Menu, TrigConf::L1Threshold_ZBTopo, TrigConf::L1BunchGroupSet, TrigConf::L1Threshold_ZB, TrigConf::L1ThrExtraInfoBase, TrigConf::L1Connector, TrigConf::L1TopoAlgorithm, TrigConf::HLTMenu, TrigConf::L1Item, TrigConf::HLTMonitoring, TrigConf::HLTPrescalesSet, TrigConf::Chain, TrigConf::L1CTP, TrigConf::L1PrescalesSet, TrigConf::L1Threshold_JET, TrigConf::L1Board, TrigConf::L1BunchGroup, TrigConf::L1Threshold_TAU, and TrigConf::L1Threshold_EM.

Definition at line 252 of file DataStructure.h.

{};

Member Data Documentation

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.

---

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

• L1TopoOutput.h
• L1TopoOutput.cxx