ATLAS Offline Software
|
L1 threshold configuration. More...
#include <L1Item.h>
Public Types | |
using | ptree = boost::property_tree::ptree |
Public Member Functions | |
L1Item () | |
Constructor. More... | |
L1Item (const ptree &data) | |
Constructor initialized with configuration data. More... | |
virtual | ~L1Item () override=default |
Destructor. More... | |
virtual std::string | className () const override |
A string that is the name of the class. More... | |
unsigned int | ctpId () const |
Accessor to the CTP ID. More... | |
const std::string & | definition () const |
Accessor to the item definition. More... | |
const std::vector< std::string > & | bunchgroups () const |
Accessor to the list of bunchgroups. More... | |
unsigned int | complexDeadtime () const |
Accessor to the complex deadtime. More... | |
const std::string & | monitor () const |
Accessor to the item monitoring definition. More... | |
unsigned int | partition () const |
Accessor to the item partition. More... | |
const std::string & | triggerType () const |
Accessor to the item triggerType returned format is a string (e.g. More... | |
unsigned char | triggerTypeAsUChar () const |
Accessor to the item triggerType returned format is an uchar (8 bit L1 trigger type) More... | |
std::optional< bool > | legacy () const |
Accessor to the item legacy flag. More... | |
DataStructure | logic () const |
Accessor to the item logic. 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 | |
virtual void | update () override |
Update the internal data after modification of the data object. More... | |
void | load () |
Private Attributes | |
std::vector< std::string > | m_bunchgroups {} |
L1 threshold configuration.
Provides access to the L1 item name and ID and the deadtime settings, trigger type, logic, and partition.
|
inherited |
Definition at line 40 of file DataStructure.h.
TrigConf::L1Item::L1Item | ( | ) |
Constructor initialized with configuration data.
data | The data containing the L1 item configuration |
Definition at line 10 of file L1Item.cxx.
|
overridevirtualdefault |
Destructor.
const std::vector< std::string > & TrigConf::L1Item::bunchgroups | ( | ) | const |
Accessor to the list of bunchgroups.
Definition at line 46 of file L1Item.cxx.
|
overridevirtual |
A string that is the name of the class.
Reimplemented from TrigConf::DataStructure.
Definition at line 17 of file L1Item.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::L1Item::complexDeadtime | ( | ) | const |
Accessor to the complex deadtime.
This can be 0 or 1, but 1 has never been used so far
Definition at line 51 of file L1Item.cxx.
unsigned int TrigConf::L1Item::ctpId | ( | ) | const |
Accessor to the CTP ID.
Definition at line 34 of file L1Item.cxx.
Access to the underlying data, if needed.
Definition at line 83 of file DataStructure.h.
const std::string & TrigConf::L1Item::definition | ( | ) | const |
Accessor to the item definition.
Definition at line 40 of file L1Item.cxx.
|
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 |
|
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.
std::optional< bool > TrigConf::L1Item::legacy | ( | ) | const |
Accessor to the item legacy flag.
Definition at line 75 of file L1Item.cxx.
|
private |
Definition at line 22 of file L1Item.cxx.
TrigConf::DataStructure TrigConf::L1Item::logic | ( | ) | const |
Accessor to the item logic.
The current description of the logic is rather complex and difficult to parse and should be redesigned.
Definition at line 93 of file L1Item.cxx.
const std::string & TrigConf::L1Item::monitor | ( | ) | const |
Accessor to the item monitoring definition.
Definition at line 57 of file L1Item.cxx.
|
finalvirtualinherited |
Definition at line 109 of file DataStructure.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.
unsigned int TrigConf::L1Item::partition | ( | ) | const |
Accessor to the item partition.
Definition at line 63 of file L1Item.cxx.
|
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.
|
inherited |
Definition at line 50 of file DataStructure.cxx.
|
inherited |
Setting the configuration element name.
Definition at line 59 of file DataStructure.cxx.
const std::string & TrigConf::L1Item::triggerType | ( | ) | const |
Accessor to the item triggerType returned format is a string (e.g.
"10010010")
Definition at line 69 of file L1Item.cxx.
unsigned char TrigConf::L1Item::triggerTypeAsUChar | ( | ) | const |
Accessor to the item triggerType returned format is an uchar (8 bit L1 trigger type)
Definition at line 81 of file L1Item.cxx.
|
inlineoverrideprivatevirtual |
Update the internal data after modification of the data object.
Reimplemented from TrigConf::DataStructure.
Definition at line 79 of file L1Item.h.
|
private |
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.