ATLAS Offline Software
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
TrigConf::DataStructure Class Reference

Base class for Trigger configuration data and wrapper around underlying representation. More...

#include <DataStructure.h>

Inherited by TrigConf::Chain, TrigConf::HLTMenu, TrigConf::HLTMonitoring, TrigConf::HLTPrescalesSet, TrigConf::L1Board, TrigConf::L1BunchGroup, TrigConf::L1BunchGroupSet, TrigConf::L1Connector, TrigConf::L1CTP, TrigConf::L1Item, TrigConf::L1Menu, TrigConf::L1PrescalesSet, TrigConf::L1Threshold, TrigConf::L1ThrExtraInfoBase, TrigConf::L1TopoAlgorithm, and TrigConf::L1TopoOutput.

Collaboration diagram for TrigConf::DataStructure:

Public Types

using ptree = boost::property_tree::ptree
 

Public Member Functions

 DataStructure ()
 Default constructor, leading to an uninitialized configuration object. More...
 
 DataStructure (const DataStructure &)=default
 
 DataStructure (DataStructure &&)=default
 
DataStructureoperator= (const DataStructure &)=default
 
DataStructureoperator= (DataStructure &&)=default
 
 DataStructure (const ptree &data)
 Constructor initialized with configuration data. More...
 
 DataStructure (const std::string &name, const ptree &data)
 
 DataStructure (ptree &&data)
 
 DataStructure (const std::string &name, ptree &&data)
 
virtual ~DataStructure ()=default
 Destructor. 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 std::string className () const
 A string that is the name of the class. More...
 
virtual const std::string & name () const final
 
virtual void clear ()
 Clearing the configuration data. More...
 
const ptreedata () 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 >
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 >
getAttribute (const std::string &key, bool ignoreIfMissing=false, const T &def=T()) const
 Access to simple attribute. More...
 
template<class T >
std::optional< T > getAttribute_optional (const std::string &key) const
 
const std::string & getAttribute (const std::string &key, bool ignoreIfMissing=false, const std::string &def="") const
 
std::vector< DataStructuregetList (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::DataStructuregetObject_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< ptreem_dataSPtr { nullptr }
 
const ptreem_dataPtr { nullptr }
 
std::string m_name {""}
 

Detailed Description

Base class for Trigger configuration data and wrapper around underlying representation.

Triggger configuration description data uses json format which can be represented as boost::ptree (or other formats if ATLAS decides to support those)

The class acts as layer to shield the clients of the trigger configuration from the concrete representation of the transient configuration data

Configuration data is typically recursive, meaning that sub-configurations can also be expressed as DataStructure objects. Therefore this class also is base class to all other classes describing parts of the trigger configuration in this package

Detailed information can be found under https://twiki.cern.ch/twiki/bin/view/Atlas/TriggerConfigurationAccess

Definition at line 37 of file DataStructure.h.

Member Typedef Documentation

◆ ptree

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

Definition at line 40 of file DataStructure.h.

Constructor & Destructor Documentation

◆ DataStructure() [1/7]

TrigConf::DataStructure::DataStructure ( )

Default constructor, leading to an uninitialized configuration object.

Definition at line 11 of file DataStructure.cxx.

12 {}

◆ DataStructure() [2/7]

TrigConf::DataStructure::DataStructure ( const DataStructure )
default

◆ DataStructure() [3/7]

TrigConf::DataStructure::DataStructure ( DataStructure &&  )
default

◆ DataStructure() [4/7]

TrigConf::DataStructure::DataStructure ( const ptree data)

Constructor initialized with configuration data.

Parameters
dataReference to the data container

Definition at line 15 of file DataStructure.cxx.

15  :
17 {}

◆ DataStructure() [5/7]

TrigConf::DataStructure::DataStructure ( const std::string &  name,
const ptree data 
)

Definition at line 19 of file DataStructure.cxx.

19  :
20  m_initialized(true),
21  m_dataPtr(&data),
22  m_name(name)
23 {}

◆ DataStructure() [6/7]

TrigConf::DataStructure::DataStructure ( ptree &&  data)

Definition at line 26 of file DataStructure.cxx.

26  :
27  m_initialized(true),
28  m_dataSPtr(std::make_shared<ptree>(std::move(data)))
29 {}

◆ DataStructure() [7/7]

TrigConf::DataStructure::DataStructure ( const std::string &  name,
ptree &&  data 
)

Definition at line 31 of file DataStructure.cxx.

31  :
32  m_initialized(true),
33  m_dataSPtr(std::make_shared<ptree>(std::move(data))),
34  m_name(name)
35 {}

◆ ~DataStructure()

virtual TrigConf::DataStructure::~DataStructure ( )
virtualdefault

Destructor.

Member Function Documentation

◆ className()

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

A string that is the name of the class.

Reimplemented in TrigConf::L1ThrExtraInfo_MU, TrigConf::L1ThrExtraInfo_gTE, TrigConf::L1ThrExtraInfo_gXE, TrigConf::L1ThrExtraInfo_jTE, TrigConf::L1ThrExtraInfo_jXE, TrigConf::L1ThrExtraInfo_gLJ, TrigConf::L1ThrExtraInfo_gJ, TrigConf::L1ThrExtraInfo_jLJ, TrigConf::L1Threshold_MU, TrigConf::L1ThrExtraInfo_jJ, TrigConf::L1Threshold_gTE, TrigConf::L1ThrExtraInfo_cTAU, TrigConf::L1Threshold_gXE, TrigConf::L1Threshold_jTE, TrigConf::L1Threshold_jXE, TrigConf::L1Threshold_gLJ, TrigConf::L1ThrExtraInfo_jTAU, TrigConf::L1Threshold_gJ, TrigConf::L1Threshold_jLJ, TrigConf::L1Threshold_jJ, TrigConf::L1ThrExtraInfo_eTAU, TrigConf::L1Threshold_cTAU, TrigConf::L1Threshold_jTAU, TrigConf::L1Threshold_eTAU, TrigConf::L1ThrExtraInfo_jEM, TrigConf::L1Threshold_jEM, TrigConf::L1Threshold_eEM, TrigConf::L1ThrExtraInfo_eEM, TrigConf::L1Threshold_internal, TrigConf::L1Threshold, TrigConf::L1Threshold_NIM, TrigConf::L1Threshold_ZBTopo, TrigConf::L1ThrExtraInfo_XSLegacy, TrigConf::L1Threshold_ZB, TrigConf::L1ThrExtraInfo_JETLegacy, TrigConf::L1Threshold_TE, TrigConf::L1BunchGroupSet, TrigConf::L1ThrExtraInfoBase, TrigConf::L1Threshold_XS, TrigConf::L1ThrExtraInfo_EMTAULegacy, TrigConf::L1Threshold_XE, TrigConf::L1Connector, TrigConf::L1Threshold_JET, TrigConf::L1TopoAlgorithm, TrigConf::HLTMonitoring, TrigConf::L1PrescalesSet, TrigConf::L1Board, TrigConf::L1Menu, TrigConf::L1Threshold_TAU, TrigConf::HLTPrescalesSet, TrigConf::HLTMenu, TrigConf::L1BunchGroup, TrigConf::Chain, TrigConf::L1Item, TrigConf::L1TopoOutput, and TrigConf::L1Threshold_EM.

Definition at line 104 of file DataStructure.cxx.

104  {
105  return "DataStructure";
106 }

◆ clear()

void TrigConf::DataStructure::clear ( )
virtual

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.

66 {
67  m_initialized = false;
68  m_dataSPtr = nullptr;
69  m_dataPtr = nullptr;
70 }

◆ data()

const ptree& TrigConf::DataStructure::data ( ) const
inline

Access to the underlying data, if needed.

Definition at line 83 of file DataStructure.h.

83  {
84  if( ! isInitialized() ) {
85  throw std::runtime_error("Trying to access data of uninitialized object of type " + className());
86  }
87  // Don't use ?: operator here: it confuses cppcheck.
88  if (ownsData()) {
89  return *m_dataSPtr.get();
90  }
91  return *m_dataPtr;
92  }

◆ empty()

bool TrigConf::DataStructure::empty ( ) const
inline

Check if children exist.

Definition at line 219 of file DataStructure.h.

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

◆ getAttribute() [1/2]

const std::string & TrigConf::DataStructure::getAttribute ( const std::string &  key,
bool  ignoreIfMissing = false,
const std::string &  def = "" 
) const

Definition at line 136 of file DataStructure.cxx.

137 {
138  const auto & obj = data().get_child_optional(key);
139  if( !obj ) {
140  if( ignoreIfMissing ) {
141  return def;
142  } else {
143  throw std::runtime_error(className() + "#" + name() + ": structure '" + key + "' does not exist" );
144  }
145  }
146  // check if the key points to a plain string value
147  if ( !obj.get().empty() ) {
148  if ( obj.get().front().first.empty() ) {
149  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>");
150  } else {
151  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");
152  }
153  }
154  return obj.get().data();
155 }

◆ getAttribute() [2/2]

template<class T >
T TrigConf::DataStructure::getAttribute ( const std::string &  key,
bool  ignoreIfMissing = false,
const T &  def = T() 
) const
inline

Access to simple attribute.

Parameters
keyThe path to the attribute name, relative to the current one in form "path.to.child"
ignoreIfMissingControls the behavior in case of missing configuration child

Definition at line 152 of file DataStructure.h.

152  {
153  const auto & obj = data().get_child_optional(key);
154  if( !obj ) {
155  if( ignoreIfMissing ) {
156  return def;
157  } else {
158  throw std::runtime_error(className() + "#" + name() + ": structure '" + key + "' does not exist" );
159  }
160  }
161  return obj.get().get_value<T>();
162  }

◆ getAttribute_optional()

template<class T >
std::optional<T> TrigConf::DataStructure::getAttribute_optional ( const std::string &  key) const
inline

Definition at line 165 of file DataStructure.h.

165  {
166  const auto & obj = data().get_child_optional(key);
167  if( ! obj ) {
168  return std::nullopt;
169  }
170  auto v = obj.get().get_value_optional<T>();
171  return v ? std::optional(std::move(*v)) : std::nullopt;
172  }

◆ getKeys()

std::vector< std::string > TrigConf::DataStructure::getKeys ( ) const

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.

251 {
252  std::vector<std::string> keys;
253  if ( ! data().empty() &&
254  ! data().front().first.empty() )
255  {
256  keys.reserve(data().size());
257  for( auto & entry : data() ) {
258  keys.push_back(entry.first);
259  }
260  }
261  return keys;
262 }

◆ getList()

std::vector< TrigConf::DataStructure > TrigConf::DataStructure::getList ( const std::string &  pathToChild,
bool  ignoreIfMissing = false 
) const

Access to array structure.

Parameters
pathToChildThe path to the configuration child, relative to the current one in form "path.to.child"
ignoreIfMissingControls 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.

159 {
160  std::vector<TrigConf::DataStructure> childList;
161  const auto & list = data().get_child_optional(pathToChild);
162  if( ! list ) {
163  if ( ignoreIfMissing ) {
164  return childList;
165  } else {
166  throw std::runtime_error(className() + "#" + name() + ": structure '" + pathToChild + "' does not exist.");
167  }
168  }
169 
170  // check if the pathToChild points to a list
171 
172  // this check is not complete, because boost::ptree can not
173  // distinguish between and empty list and an empty string. In both cases
174  // the value is empty and there are no children
175 
176  if ( list.get().empty() ) {
177  if ( list.get().get_value<std::string>() != "" ) {
178  // if the value is not empty, then it is for sure an attribute ("key" : "value")
179  throw std::runtime_error(className() + "#" + name() + ": structure '" + pathToChild + "' is not a list [] but a simple attribute, it needs to be accessed via [\"" + pathToChild + "\"] -> string");
180  }
181  // else: if the value is empty, we can not say for sure and will not
182  // give this debugging hint (an empty list will be returned
183  } else if ( ! list.get().front().first.empty() ) {
184  throw std::runtime_error(className() + "#" + name() + ": structure '" + pathToChild + "' is not a list [] but an object {}, it needs to be accessed via getObject(\"" + pathToChild + "\") -> DataStructure");
185  }
186 
187  childList.reserve(list.get().size());
188 
189  for( auto & childData : list.get() )
190  childList.emplace_back( childData.second );
191 
192  return childList;
193 }

◆ getList_optional()

std::optional< std::vector< TrigConf::DataStructure > > TrigConf::DataStructure::getList_optional ( const std::string &  pathToChild) const

Definition at line 197 of file DataStructure.cxx.

198 {
199  if(data().find(pathToChild) == data().not_found()) {
200  return std::nullopt;
201  }
202  return std::optional<std::vector<TrigConf::DataStructure> >(getList(pathToChild));
203 }

◆ getObject()

TrigConf::DataStructure TrigConf::DataStructure::getObject ( const std::string &  pathToChild,
bool  ignoreIfMissing = false 
) const

Access to configuration object.

Parameters
pathToChildThe path to the configuration child, relative to the current one
ignoreIfMissingControls 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.

208 {
209  const auto & obj = data().get_child_optional(pathToChild);
210  if( ! obj ) {
211  if ( ignoreIfMissing ) {
212  return DataStructure();
213  } else {
214  throw std::runtime_error(className() + "#" + name() + ": structure '" + pathToChild + "' does not exist.");
215  }
216  }
217  // check if the pathToChild is an attribute
218  if( obj.get().get_value<std::string>() != "" ) {
219  throw std::runtime_error(className() + "#" + name() + ": structure '" + pathToChild + "' is not an object {} but a simple attribute, it needs to be accessed via [\"" + pathToChild + "\"] -> string");
220  }
221  // check if the pathToChild points to a list
222  if ( obj.get().front().first.empty() ) {
223  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>");
224  }
225  return { obj.get() };
226 }

◆ getObject_optional()

std::optional< TrigConf::DataStructure > TrigConf::DataStructure::getObject_optional ( const std::string &  pathToChild) const

Definition at line 230 of file DataStructure.cxx.

231 {
232 
233  if(const auto & obj = data().get_child_optional(pathToChild)) {
234  // check if the pathToChild is an attribute
235  if( obj.get().get_value<std::string>() != "" ) {
236  throw std::runtime_error(className() + "#" + name() + ": structure '" + pathToChild + "' is not an object {} but a simple attribute, it needs to be accessed via [\"" + pathToChild + "\"] -> string");
237  }
238  // check if the pathToChild points to a list
239  if ( obj.get().front().first.empty() ) {
240  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>");
241  }
242  return std::optional<TrigConf::DataStructure>(obj.get());
243  }
244  return std::nullopt;
245 }

◆ getValue() [1/2]

std::string TrigConf::DataStructure::getValue ( ) const

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.

80  {
81  const std::string value = data().get_value<std::string>();
82  return value;
83 }

◆ getValue() [2/2]

template<class T >
T TrigConf::DataStructure::getValue ( ) const
inline

Definition at line 108 of file DataStructure.h.

108  {
109  return data().get_value<T>();
110  }

◆ getValue_optional()

template<class T >
std::optional<T> TrigConf::DataStructure::getValue_optional ( ) const
inline

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.

116  {
117  auto v = data().get_value_optional<T>();
118  return v ? std::optional<T>(std::move(*v)) : std::nullopt;
119  }

◆ hasAttribute()

bool TrigConf::DataStructure::hasAttribute ( const std::string &  key) const

Check for attribute.

Parameters
keyThe 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.

86  {
87  const auto & child = data().get_child_optional( key );
88  if( ! bool(child) ) // key does not exist
89  return false;
90  return child.get().empty(); // if empty then it is an attribute, otherwise a child note
91 }

◆ hasChild()

bool TrigConf::DataStructure::hasChild ( const std::string &  path) const

Check if child exists.

Parameters
pathThe 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.

114  {
115  const auto & child = data().get_child_optional( path );
116  return bool(child);
117 }

◆ isInitialized()

bool TrigConf::DataStructure::isInitialized ( ) const
inline

Definition at line 216 of file DataStructure.h.

216 { return m_initialized; }

◆ isNull()

bool TrigConf::DataStructure::isNull ( const std::string &  key) const

Check if an attribute is null.

Parameters
keyThe 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.

94  {
95  auto child = data().get_child_optional( key );
96  if( ! child ) {
97  return false;
98  }
99  return child->get_value<std::string>() == "null";
100 }

◆ isValid()

bool TrigConf::DataStructure::isValid ( ) const
inline

Definition at line 215 of file DataStructure.h.

215 { return m_initialized; }

◆ isValue()

bool TrigConf::DataStructure::isValue ( ) const

Check for attribute.

Returns
true if the structure is just a value

Definition at line 74 of file DataStructure.cxx.

74  {
75  return data().empty(); // just a key->value pair, no children
76 }

◆ name()

const std::string & TrigConf::DataStructure::name ( ) const
finalvirtual

Definition at line 109 of file DataStructure.cxx.

109  {
110  return m_name;
111 }

◆ operator bool()

TrigConf::DataStructure::operator bool ( ) const
inlineexplicit

Access to initialized state.

Definition at line 214 of file DataStructure.h.

214 { return m_initialized; }

◆ operator=() [1/2]

DataStructure& TrigConf::DataStructure::operator= ( const DataStructure )
default

◆ operator=() [2/2]

DataStructure& TrigConf::DataStructure::operator= ( DataStructure &&  )
default

◆ operator[]()

std::string TrigConf::DataStructure::operator[] ( const std::string &  key) const

Access to simple attribute.

Parameters
keyThe path to the attribute name, relative to the current one in form "path.to.child"

Definition at line 121 of file DataStructure.cxx.

122 {
123  const auto & obj = data().get_child(key);
124  // check if the key points to a plain string value
125  if ( !obj.empty() ) {
126  if ( obj.front().first.empty() ) {
127  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>");
128  } else {
129  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");
130  }
131  }
132  return obj.data();
133 }

◆ ownsData()

bool TrigConf::DataStructure::ownsData ( ) const
inline

Definition at line 242 of file DataStructure.h.

242  {
243  return (bool)m_dataSPtr;
244  }

◆ print()

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

Reimplemented in TrigConf::L1TopoAlgorithm, and TrigConf::L1Threshold_EM.

Definition at line 272 of file DataStructure.cxx.

273 {
274  printElement("", data(), 0, os);
275  os << std::endl;
276 }

◆ printElement()

void TrigConf::DataStructure::printElement ( const std::string &  key,
const ptree data,
uint  level = 0,
std::ostream &  os = std::cout 
)
static

Static function to print a ptree object.

Parameters
keyThe key of this data as found in the parent structure
dataThe ptree to print
levelThe substruture level used to indent the output
osThe output stream

Definition at line 279 of file DataStructure.cxx.

280 {
281  constexpr char del = '"';
282 
283  const std::string value = data.get_value<std::string>();
284 
285  if( data.empty() ) { // no children, so just a key->value pair
286  uint n(4*level); while(n--) os << " ";
287  os << del << key << del << ": " << del << value << del;
288  return;
289  }
290 
291 
292  bool isArray ( data.begin()->first.empty() ); // dictionaries have keys, arrays don't
293  { uint n(4*level); while(n--) os << " "; }
294  if ( ! key.empty() )
295  os << del << key << del << ": ";
296  os << (isArray ? "[" : "{") << std::endl;
297 
298  size_t childCounter = data.size();
299  for( const boost::property_tree::ptree::value_type & x : data ) {
300  printElement(x.first, x.second, level + 1, os);
301  if( --childCounter ) os << ",";
302  os << std::endl;
303  }
304  { uint n(4*level); while(n--) os << " "; }
305  os << (isArray ? "]" : "}");
306 
307 }

◆ printRaw()

void TrigConf::DataStructure::printRaw ( std::ostream &  os = std::cout) const

Definition at line 265 of file DataStructure.cxx.

266 {
267  boost::property_tree::json_parser::write_json( os, data() );
268 }

◆ setData() [1/2]

void TrigConf::DataStructure::setData ( const ptree data)

Setting the configuration data.

Definition at line 39 of file DataStructure.cxx.

40 {
41  clear();
42  m_initialized = true;
43  m_dataSPtr.reset();
44  m_dataPtr = &data;
45  update();
46 }

◆ setData() [2/2]

void TrigConf::DataStructure::setData ( ptree &&  data)

Definition at line 50 of file DataStructure.cxx.

51 {
52  clear();
53  m_initialized = true;
54  m_dataSPtr = std::make_shared<ptree>(std::move(data));
55  m_dataPtr = nullptr;
56  update();
57 }

◆ setName()

void TrigConf::DataStructure::setName ( const std::string &  n)

Setting the configuration element name.

Definition at line 59 of file DataStructure.cxx.

59  {
60  m_name = n;
61 }

◆ update()

virtual void TrigConf::DataStructure::update ( )
inlineprotectedvirtual

Member Data Documentation

◆ m_dataPtr

const ptree* TrigConf::DataStructure::m_dataPtr { nullptr }
protected

Definition at line 257 of file DataStructure.h.

◆ m_dataSPtr

std::shared_ptr<ptree> TrigConf::DataStructure::m_dataSPtr { nullptr }
protected

Definition at line 256 of file DataStructure.h.

◆ m_initialized

bool TrigConf::DataStructure::m_initialized { false }
protected

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 {""}
protected

Definition at line 259 of file DataStructure.h.


The documentation for this class was generated from the following files:
TrigConf::DataStructure::data
const ptree & data() const
Access to the underlying data, if needed.
Definition: DataStructure.h:83
checkxAOD.ds
ds
Definition: Tools/PyUtils/bin/checkxAOD.py:257
TrigConf::DataStructure::isInitialized
bool isInitialized() const
Definition: DataStructure.h:216
athena.path
path
python interpreter configuration --------------------------------------—
Definition: athena.py:126
find
std::string find(const std::string &s)
return a remapped string
Definition: hcg.cxx:135
TrigConf::DataStructure::empty
bool empty() const
Check if children exist.
Definition: DataStructure.h:219
TrigConf::DataStructure::printElement
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.
Definition: DataStructure.cxx:279
athena.value
value
Definition: athena.py:122
TrigConf::DataStructure::m_dataSPtr
std::shared_ptr< ptree > m_dataSPtr
Definition: DataStructure.h:256
TrigConf::DataStructure::name
virtual const std::string & name() const final
Definition: DataStructure.cxx:109
TrigConf::DataStructure::m_name
std::string m_name
Definition: DataStructure.h:259
x
#define x
python.iconfTool.models.loaders.level
level
Definition: loaders.py:20
python.setupRTTAlg.size
int size
Definition: setupRTTAlg.py:39
uint
unsigned int uint
Definition: LArOFPhaseFill.cxx:20
beamspotman.n
n
Definition: beamspotman.py:731
TrigConf::DataStructure::className
virtual std::string className() const
A string that is the name of the class.
Definition: DataStructure.cxx:104
histSizes.list
def list(name, path='/')
Definition: histSizes.py:38
ReadFromCoolCompare.os
os
Definition: ReadFromCoolCompare.py:231
GetAllXsec.entry
list entry
Definition: GetAllXsec.py:132
TrigConf::DataStructure::getList
std::vector< DataStructure > getList(const std::string &pathToChild, bool ignoreIfMissing=false) const
Access to array structure.
Definition: DataStructure.cxx:158
TrigConf::DataStructure::m_initialized
bool m_initialized
if initialized, the underlying ptree is has been assigned to (can be empty)
Definition: DataStructure.h:254
python.PyAthena.v
v
Definition: PyAthena.py:157
DeMoScan.first
bool first
Definition: DeMoScan.py:534
TrigConf::DataStructure::clear
virtual void clear()
Clearing the configuration data.
Definition: DataStructure.cxx:65
python.Bindings.keys
keys
Definition: Control/AthenaPython/python/Bindings.py:790
TrigConf::DataStructure::ownsData
bool ownsData() const
Definition: DataStructure.h:242
python.PyAthena.obj
obj
Definition: PyAthena.py:135
TrigConf::DataStructure::DataStructure
DataStructure()
Default constructor, leading to an uninitialized configuration object.
Definition: DataStructure.cxx:11
xAOD::bool
setBGCode setTAP setLVL2ErrorBits bool
Definition: TrigDecision_v1.cxx:60
TSU::T
unsigned long long T
Definition: L1TopoDataTypes.h:35
TrigConf::DataStructure::m_dataPtr
const ptree * m_dataPtr
Definition: DataStructure.h:257
mapkey::key
key
Definition: TElectronEfficiencyCorrectionTool.cxx:37
TrigConf::DataStructure::update
virtual void update()
Update the internal data after modification of the data object.
Definition: DataStructure.h:252