ATLAS Offline Software
|
L1 connectors configuration. More...
#include <L1Connector.h>
Public Types | |
enum | ConnectorType { ConnectorType::ELECTRICAL, ConnectorType::OPTICAL, ConnectorType::CTPIN } |
using | ptree = boost::property_tree::ptree |
Public Member Functions | |
L1Connector () | |
Constructor. More... | |
L1Connector (const L1Connector &)=delete | |
L1Connector & | operator= (const L1Connector &)=delete |
L1Connector (L1Connector &&)=delete | |
L1Connector (const std::string &connName, const ptree &data) | |
Constructor initialized with configuration data. More... | |
virtual | ~L1Connector () override=default |
Destructor. More... | |
virtual std::string | className () const override |
A string that is the name of the class. More... | |
std::size_t | size () const |
Accessor to the number of trigger lines. More... | |
std::string | type () const |
ConnectorType | connectorType () const |
Accessor to the connector type. More... | |
std::vector< std::string > | triggerLineNames () const |
names of all trigger lines More... | |
const std::vector< TrigConf::TriggerLine > & | triggerLines (unsigned int fpga=0, unsigned int clock=0) const |
Accessor to the triggerlines on the connector. More... | |
bool | hasLine (const std::string &lineName) const |
const TrigConf::TriggerLine & | triggerLine (const std::string &lineName) const |
bool | legacy () const |
bool | isLegacy () const |
std::size_t | maxFpga () const |
std::size_t | maxClock () const |
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 members. More... | |
Private Attributes | |
ConnectorType | m_type |
std::vector< TrigConf::TriggerLine > | m_triggerLines [2][2] |
std::map< std::string, TrigConf::TriggerLine * > | m_lineByName |
std::size_t | m_maxFpga {1} |
std::size_t | m_maxClock {1} |
bool | m_isLegacy |
L1 connectors configuration.
Definition at line 45 of file L1Connector.h.
|
inherited |
Definition at line 40 of file DataStructure.h.
|
strong |
Enumerator | |
---|---|
ELECTRICAL | |
OPTICAL | |
CTPIN |
Definition at line 48 of file L1Connector.h.
TrigConf::L1Connector::L1Connector | ( | ) |
|
delete |
|
delete |
Constructor initialized with configuration data.
data | The data containing the L1 menu |
Definition at line 13 of file L1Connector.cxx.
|
overridevirtualdefault |
Destructor.
|
overridevirtual |
A string that is the name of the class.
Reimplemented from TrigConf::DataStructure.
Definition at line 21 of file L1Connector.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.
TrigConf::L1Connector::ConnectorType TrigConf::L1Connector::connectorType | ( | ) | const |
Accessor to the connector type.
Definition at line 137 of file L1Connector.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 |
|
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.
bool TrigConf::L1Connector::hasLine | ( | const std::string & | lineName | ) | const |
Definition at line 175 of file L1Connector.cxx.
|
inlineinherited |
Definition at line 216 of file DataStructure.h.
|
inline |
Definition at line 96 of file L1Connector.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.
|
inline |
Definition at line 93 of file L1Connector.h.
|
inline |
Definition at line 100 of file L1Connector.h.
|
inline |
Definition at line 98 of file L1Connector.h.
|
finalvirtualinherited |
Definition at line 109 of file DataStructure.cxx.
|
inlineexplicitinherited |
|
delete |
|
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.
|
inherited |
Definition at line 50 of file DataStructure.cxx.
|
inherited |
Setting the configuration element name.
Definition at line 59 of file DataStructure.cxx.
std::size_t TrigConf::L1Connector::size | ( | ) | const |
const TrigConf::TriggerLine & TrigConf::L1Connector::triggerLine | ( | const std::string & | lineName | ) | const |
Definition at line 181 of file L1Connector.cxx.
std::vector< std::string > TrigConf::L1Connector::triggerLineNames | ( | ) | const |
const std::vector< TrigConf::TriggerLine > & TrigConf::L1Connector::triggerLines | ( | unsigned int | fpga = 0 , |
unsigned int | clock = 0 |
||
) | const |
Accessor to the triggerlines on the connector.
For electrical connectors from the L1Topo boards a triggerline vector holds up to 16 signals, which come from the same fpga and are transmitted at the same clock flank. So in this case the fpga and clock have to be specified. For all other connectors the default value 0 has to be used for fpga and clock
fpga | - the L1Topo fpga (0 or 1) |
clock | - the clock of the signal group (0 or 1) |
Definition at line 169 of file L1Connector.cxx.
std::string TrigConf::L1Connector::type | ( | ) | const |
Definition at line 123 of file L1Connector.cxx.
|
overrideprivatevirtual |
Update the internal members.
Reimplemented from TrigConf::DataStructure.
Definition at line 26 of file L1Connector.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.
|
private |
Definition at line 113 of file L1Connector.h.
|
private |
Definition at line 109 of file L1Connector.h.
|
private |
Definition at line 111 of file L1Connector.h.
|
private |
Definition at line 110 of file L1Connector.h.
|
protectedinherited |
Definition at line 259 of file DataStructure.h.
|
private |
Definition at line 108 of file L1Connector.h.
|
private |
Definition at line 107 of file L1Connector.h.