ATLAS Offline Software
|
HLT chain configuration. More...
#include <HLTChain.h>
Public Types | |
using | ptree = boost::property_tree::ptree |
Public Member Functions | |
Chain () | |
Constructor. More... | |
Chain (const boost::property_tree::ptree &data) | |
Constructor initialized with configuration data. More... | |
Chain (const std::string &name, const boost::property_tree::ptree &data) | |
virtual | ~Chain () override=default |
Destructor. More... | |
virtual std::string | className () const override |
A string that is the name of the class. More... | |
unsigned int | counter () const |
Accessor to the chain counter. More... | |
unsigned int | namehash () const |
Accessor to the chain name hash. More... | |
const std::string & | l1item () const |
Accessor to the seeding L1 item. More... | |
std::vector< std::string > | l1thresholds () const |
Accessor to the l1 thresholds. More... | |
std::vector< size_t > | legMultiplicities () const |
Accessor to the chains multiplicitiy requirements for each of its legs. More... | |
std::vector< std::string > | streams () const |
Accessor to the connected output streams. More... | |
std::vector< std::string > | groups () const |
Accessor to the groups this chain belongs to. More... | |
std::vector< std::string > | sequencers () const |
Accessor to the sequencers this chain belongs to. 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 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 | update () override |
Update the internal data after modification of the data object. More... | |
void | load () |
HLT chain configuration.
Provides access to the name and counter of the HLT chain, to the seeding L1 item and to the connected output streams and chain groups.
Definition at line 18 of file TrigConfData/TrigConfData/HLTChain.h.
|
inherited |
Definition at line 40 of file DataStructure.h.
TrigConf::Chain::Chain | ( | ) |
TrigConf::Chain::Chain | ( | const boost::property_tree::ptree & | data | ) |
Constructor initialized with configuration data.
data | The data containing the HLT chain configuration |
Definition at line 10 of file TrigConfData/src/HLTChain.cxx.
TrigConf::Chain::Chain | ( | const std::string & | name, |
const boost::property_tree::ptree & | data | ||
) |
Definition at line 16 of file TrigConfData/src/HLTChain.cxx.
|
overridevirtualdefault |
Destructor.
|
overridevirtual |
A string that is the name of the class.
Reimplemented from TrigConf::DataStructure.
Definition at line 38 of file TrigConfData/src/HLTChain.cxx.
|
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.
unsigned int TrigConf::Chain::counter | ( | ) | const |
Accessor to the chain counter.
The chain counter is unique with the menu
Definition at line 44 of file TrigConfData/src/HLTChain.cxx.
Access to the underlying data, if needed.
Definition at line 83 of file DataStructure.h.
|
inlineinherited |
|
inherited |
Definition at line 136 of file DataStructure.cxx.
|
inlineinherited |
Access to simple attribute.
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.
|
inlineinherited |
|
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.
|
inherited |
Access to array structure.
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.
|
inherited |
|
inherited |
Access to configuration object.
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.
Definition at line 207 of file DataStructure.cxx.
|
inherited |
Definition at line 230 of file DataStructure.cxx.
|
inherited |
Access to simple content.
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.
|
inlineinherited |
Definition at line 108 of file DataStructure.h.
|
inlineinherited |
std::vector< std::string > TrigConf::Chain::groups | ( | ) | const |
Accessor to the groups this chain belongs to.
Definition at line 106 of file TrigConfData/src/HLTChain.cxx.
|
inherited |
Check for attribute.
key | The path to the attribute name, relative to the current one in form "path.to.child" |
key
exists and is an attribute Definition at line 86 of file DataStructure.cxx.
|
inherited |
Check if child exists.
path | The path to the child, relative to the current one in form "path.to.child" |
Definition at line 114 of file DataStructure.cxx.
|
inlineinherited |
Definition at line 216 of file DataStructure.h.
|
inherited |
Check if an attribute is null.
key | The path to the attribute name, relative to the current one in form "path.to.child" |
key
exists and is nullIf 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.
|
inlineinherited |
Definition at line 215 of file DataStructure.h.
|
inherited |
Check for attribute.
Definition at line 74 of file DataStructure.cxx.
const std::string & TrigConf::Chain::l1item | ( | ) | const |
Accessor to the seeding L1 item.
Definition at line 56 of file TrigConfData/src/HLTChain.cxx.
std::vector< std::string > TrigConf::Chain::l1thresholds | ( | ) | const |
std::vector< size_t > TrigConf::Chain::legMultiplicities | ( | ) | const |
Accessor to the chains multiplicitiy requirements for each of its legs.
Definition at line 61 of file TrigConfData/src/HLTChain.cxx.
|
private |
Definition at line 29 of file TrigConfData/src/HLTChain.cxx.
|
finalvirtualinherited |
Definition at line 109 of file DataStructure.cxx.
unsigned int TrigConf::Chain::namehash | ( | ) | const |
Accessor to the chain name hash.
The hash is unique within the menu and identifies the chain online
Definition at line 50 of file TrigConfData/src/HLTChain.cxx.
|
inlineexplicitinherited |
|
inherited |
Access to simple attribute.
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.
|
inlineinherited |
Definition at line 242 of file DataStructure.h.
|
virtualinherited |
Reimplemented in TrigConf::L1TopoAlgorithm, and TrigConf::L1Threshold_EM.
Definition at line 272 of file DataStructure.cxx.
|
staticinherited |
Static function to print a ptree
object.
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.
|
inherited |
Definition at line 265 of file DataStructure.cxx.
std::vector< std::string > TrigConf::Chain::sequencers | ( | ) | const |
Accessor to the sequencers this chain belongs to.
Definition at line 126 of file TrigConfData/src/HLTChain.cxx.
|
inherited |
Definition at line 50 of file DataStructure.cxx.
|
inherited |
Setting the configuration element name.
Definition at line 59 of file DataStructure.cxx.
std::vector< std::string > TrigConf::Chain::streams | ( | ) | const |
Accessor to the connected output streams.
Definition at line 90 of file TrigConfData/src/HLTChain.cxx.
|
overrideprivatevirtual |
Update the internal data after modification of the data object.
to be implemented by the derived class
Reimplemented from TrigConf::DataStructure.
Definition at line 23 of file TrigConfData/src/HLTChain.cxx.
Definition at line 257 of file DataStructure.h.
|
protectedinherited |
Definition at line 256 of file DataStructure.h.
|
protectedinherited |
if initialized, the underlying ptree is has been assigned to (can be empty)
Definition at line 254 of file DataStructure.h.
|
protectedinherited |
Definition at line 259 of file DataStructure.h.