DUNE-DAQ
DUNE Trigger and Data Acquisition software
Loading...
Searching...
No Matches
dunedaq::confmodel::DummyResourceSet Class Reference

#include <DummyResourceSet.hpp>

Inheritance diagram for dunedaq::confmodel::DummyResourceSet:
[legend]
Collaboration diagram for dunedaq::confmodel::DummyResourceSet:
[legend]

Public Member Functions

virtual void print (unsigned int offset, bool print_header, std::ostream &s) const
 Print details of the DummyResourceSet object.
 
virtual std::vector< const dunedaq::conffwk::DalObject * > get (const std::string &name, bool upcast_unregistered=true) const
 Get values of relationships and results of some algorithms as a vector of dunedaq::conffwk::DalObject pointers.
 
const std::vector< const dunedaq::confmodel::Resource * > & get_items () const
 Get "items" relationship value.
 
void set_items (const std::vector< const dunedaq::confmodel::Resource * > &value)
 Set "items" relationship value.
 
virtual std::vector< const Resource * > contained_resources () const
 
virtual void print (unsigned int offset, bool print_header, std::ostream &s) const
 Print details of the DummyResourceSet object.
 
virtual std::vector< const dunedaq::conffwk::DalObject * > get (const std::string &name, bool upcast_unregistered=true) const
 Get values of relationships and results of some algorithms as a vector of dunedaq::conffwk::DalObject pointers.
 
const std::vector< const dunedaq::confmodel::Resource * > & get_items () const
 Get "items" relationship value.
 
void set_items (const std::vector< const dunedaq::confmodel::Resource * > &value)
 Set "items" relationship value.
 
virtual std::vector< const Resource * > contained_resources () const
 
- Public Member Functions inherited from dunedaq::confmodel::ResourceSet
- Public Member Functions inherited from dunedaq::confmodel::Resource
void parents (const dunedaq::confmodel::Session &session, std::list< std::vector< const dunedaq::confmodel::Resource * > > &parents) const
 
bool is_disabled (const dunedaq::confmodel::ResourceTree &session) const
 
virtual bool compute_disabled_state (const std::set< std::string > &) const
 
void parents (const dunedaq::confmodel::Session &session, std::list< std::vector< const dunedaq::confmodel::Resource * > > &parents) const
 
bool is_disabled (const dunedaq::confmodel::ResourceTree &session) const
 
virtual bool compute_disabled_state (const std::set< std::string > &) const
 
- Public Member Functions inherited from dunedaq::conffwk::DalObject
const std::string & UID () const noexcept
 
const std::string & class_name () const noexcept
 
bool castable (const std::string &target) const noexcept
 
bool castable (const std::string *target) const noexcept
 
template<class TARGET >
const TARGET * cast () const noexcept
 Casts object to different class.
 
std::string full_name () const noexcept
 
const ConfigObjectconfig_object () const
 
DalRegistryregistry () const noexcept
 
Configurationconfiguration () const noexcept
 
void unread ()
 
void set (const ConfigObject &o) noexcept
 
void move (const std::string &at)
 
void rename (const std::string &new_id)
 
void p_hdr (std::ostream &s, unsigned int indent, const std::string &cl, const char *nm=nullptr) const
 print object headers
 
std::ostream & print_object (std::ostream &s) const
 print object details
 
void throw_init_ex (dunedaq::conffwk::Exception &ex)
 throw object initialisation exception (i.e.
 

Static Public Member Functions

static const std::string & __get_items_str () noexcept
 
static const std::string & __get_items_str () noexcept
 
- Static Public Member Functions inherited from dunedaq::conffwk::DalObject
static void p_null (std::ostream &s)
 print "(null)"
 
static void p_rm (std::ostream &s)
 print "(deleted object)"
 
static void p_error (std::ostream &s, dunedaq::conffwk::Exception &ex)
 print error text
 
static void throw_get_ex (const std::string &what, const std::string &class_name, const DalObject *obj)
 throw exception in generated get method (i.e.
 
static bool is_null (const DalObject *ref) noexcept
 check a pointer on DAL object is null
 

Static Public Attributes

static const std::string & s_class_name
 
static const std::string s_items = "items"
 
- Static Public Attributes inherited from dunedaq::confmodel::ResourceSet
static const std::string & s_class_name
 
- Static Public Attributes inherited from dunedaq::confmodel::Resource
static const std::string & s_class_name
 

Protected Member Functions

 DummyResourceSet (conffwk::DalRegistry &db, const conffwk::ConfigObject &obj) noexcept
 
virtual ~DummyResourceSet () noexcept
 
virtual void init (bool init_children)
 
bool get (const std::string &name, std::vector< const dunedaq::conffwk::DalObject * > &vec, bool upcast_unregistered, bool first_call) const
 
 DummyResourceSet (conffwk::DalRegistry &db, const conffwk::ConfigObject &obj) noexcept
 
virtual ~DummyResourceSet () noexcept
 
virtual void init (bool init_children)
 
bool get (const std::string &name, std::vector< const dunedaq::conffwk::DalObject * > &vec, bool upcast_unregistered, bool first_call) const
 
- Protected Member Functions inherited from dunedaq::confmodel::ResourceSet
 ResourceSet (conffwk::DalRegistry &db, const conffwk::ConfigObject &obj) noexcept
 
virtual ~ResourceSet () noexcept
 
bool get (const std::string &name, std::vector< const dunedaq::conffwk::DalObject * > &vec, bool upcast_unregistered, bool first_call) const
 
 ResourceSet (conffwk::DalRegistry &db, const conffwk::ConfigObject &obj) noexcept
 
virtual ~ResourceSet () noexcept
 
bool get (const std::string &name, std::vector< const dunedaq::conffwk::DalObject * > &vec, bool upcast_unregistered, bool first_call) const
 
- Protected Member Functions inherited from dunedaq::confmodel::Resource
 Resource (conffwk::DalRegistry &db, const conffwk::ConfigObject &obj) noexcept
 
virtual ~Resource () noexcept
 
bool get (const std::string &name, std::vector< const dunedaq::conffwk::DalObject * > &vec, bool upcast_unregistered, bool first_call) const
 
 Resource (conffwk::DalRegistry &db, const conffwk::ConfigObject &obj) noexcept
 
virtual ~Resource () noexcept
 
bool get (const std::string &name, std::vector< const dunedaq::conffwk::DalObject * > &vec, bool upcast_unregistered, bool first_call) const
 
- Protected Member Functions inherited from dunedaq::conffwk::DalObject
 DalObject (DalRegistry &db, const ConfigObject &o) noexcept
 
virtual ~DalObject ()
 
void clear () noexcept
 
void check () const
 
bool is_deleted () const
 
void increment_created () noexcept
 
void increment_read () noexcept
 
void check_init () const
 Check and initialize object if necessary.
 
template<typename T >
void _set_object (const std::string &name, const T *value)
 Helper method for generated set single-value relationship methods.
 
template<typename T >
void _set_objects (const std::string &name, const std::vector< const T * > &value)
 Helper method for generated set multi-value relationship methods.
 
bool get_rel_objects (const std::string &name, bool upcast_unregistered, std::vector< const DalObject * > &objs) const
 Read relationship values as DAL objects using DAL factory.
 
bool get_algo_objects (const std::string &name, std::vector< const DalObject * > &objs) const
 Run algorithm and return result as DAL objects using DAL factory.
 

Private Attributes

std::vector< const dunedaq::confmodel::Resource * > m_items
 

Friends

class conffwk::Configuration
 
class conffwk::DalObject
 
class conffwk::DalFactory
 
class conffwk::DalRegistry
 

Additional Inherited Members

- Protected Attributes inherited from dunedaq::conffwk::DalObject
std::mutex m_mutex
 Used to protect changes of DAL object.
 
bool p_was_read
 is true, if the object was read
 
DalRegistryp_registry
 Configuration object.
 
ConfigObject p_obj
 Config object used by given template object.
 
std::string p_UID
 Is used for template objects (see dqm_conffwk)
 

Detailed Description

Definition at line 23 of file DummyResourceSet.hpp.

Constructor & Destructor Documentation

◆ DummyResourceSet() [1/2]

dunedaq::confmodel::DummyResourceSet::DummyResourceSet ( conffwk::DalRegistry & db,
const conffwk::ConfigObject & obj )
protectednoexcept

Definition at line 26 of file DummyResourceSet.cpp.

26 :
28 ResourceSet(db, o)
29
30 {
31 ;
32 }
The base class for any generated DAL object.
Definition DalObject.hpp:45
ResourceSet(conffwk::DalRegistry &db, const conffwk::ConfigObject &obj) noexcept

◆ ~DummyResourceSet() [1/2]

dunedaq::confmodel::DummyResourceSet::~DummyResourceSet ( )
protectedvirtualnoexcept

Definition at line 75 of file DummyResourceSet.cpp.

76 {
77 }

◆ DummyResourceSet() [2/2]

dunedaq::confmodel::DummyResourceSet::DummyResourceSet ( conffwk::DalRegistry & db,
const conffwk::ConfigObject & obj )
protectednoexcept

◆ ~DummyResourceSet() [2/2]

virtual dunedaq::confmodel::DummyResourceSet::~DummyResourceSet ( )
protectedvirtualnoexcept

Member Function Documentation

◆ __get_items_str() [1/2]

static const std::string & dunedaq::confmodel::DummyResourceSet::__get_items_str ( )
inlinestaticnoexcept

Definition at line 83 of file DummyResourceSet.hpp.

83{ return s_items; }

◆ __get_items_str() [2/2]

static const std::string & dunedaq::confmodel::DummyResourceSet::__get_items_str ( )
inlinestaticnoexcept

Definition at line 83 of file DummyResourceSet.hpp.

83{ return s_items; }

◆ contained_resources() [1/2]

std::vector< const Resource * > dunedaq::confmodel::DummyResourceSet::contained_resources ( ) const
virtual

Virtual method to obtain the list of all contained Resources. Used internally by the core disabled logic. Not intended to be used in application code as that should be using individual relationships of the derived classes.

Implements dunedaq::confmodel::ResourceSet.

Definition at line 117 of file DummyResourceSet.cpp.

118 {
119return to_resources(get_items());
120 }
const std::vector< const dunedaq::confmodel::Resource * > & get_items() const
Get "items" relationship value.
std::vector< const dunedaq::confmodel::Resource * > to_resources(const std::vector< T * > &vector_of_children)

◆ contained_resources() [2/2]

virtual std::vector< const Resource * > dunedaq::confmodel::DummyResourceSet::contained_resources ( ) const
virtual

Virtual method to obtain the list of all contained Resources. Used internally by the core disabled logic. Not intended to be used in application code as that should be using individual relationships of the derived classes.

Implements dunedaq::confmodel::ResourceSet.

◆ get() [1/4]

std::vector< const dunedaq::conffwk::DalObject * > dunedaq::confmodel::DummyResourceSet::get ( const std::string & name,
bool upcast_unregistered = true ) const
virtual

Get values of relationships and results of some algorithms as a vector of dunedaq::conffwk::DalObject pointers.

Parameters are:

Parameters
namename of the relationship or algorithm
Returns
value of relationship or result of algorithm
Exceptions
std::exceptionif there is no relationship or algorithm with such name in this and base classes

Reimplemented from dunedaq::confmodel::ResourceSet.

Definition at line 79 of file DummyResourceSet.cpp.

80 {
81 std::vector<const dunedaq::conffwk::DalObject *> vec;
82
83 if (!get(name, vec, upcast_unregistered, true))
84 throw_get_ex(name, s_class_name, this);
85
86 return vec;
87 }
static void throw_get_ex(const std::string &what, const std::string &class_name, const DalObject *obj)
throw exception in generated get method (i.e.
Definition DalObject.cpp:82
static const std::string & s_class_name
virtual std::vector< const dunedaq::conffwk::DalObject * > get(const std::string &name, bool upcast_unregistered=true) const
Get values of relationships and results of some algorithms as a vector of dunedaq::conffwk::DalObject...

◆ get() [2/4]

virtual std::vector< const dunedaq::conffwk::DalObject * > dunedaq::confmodel::DummyResourceSet::get ( const std::string & name,
bool upcast_unregistered = true ) const
virtual

Get values of relationships and results of some algorithms as a vector of dunedaq::conffwk::DalObject pointers.

Parameters are:

Parameters
namename of the relationship or algorithm
Returns
value of relationship or result of algorithm
Exceptions
std::exceptionif there is no relationship or algorithm with such name in this and base classes

Reimplemented from dunedaq::confmodel::ResourceSet.

◆ get() [3/4]

bool dunedaq::confmodel::DummyResourceSet::get ( const std::string & name,
std::vector< const dunedaq::conffwk::DalObject * > & vec,
bool upcast_unregistered,
bool first_call ) const
protected

Definition at line 89 of file DummyResourceSet.cpp.

90 {
91 if (first_call)
92 {
93 std::lock_guard scoped_lock(m_mutex);
94
95 check();
96 check_init();
97
98 if (get_rel_objects(name, upcast_unregistered, vec))
99 return true;
100 }
101
102 if (ResourceSet::get(name, vec, upcast_unregistered, false)) return true;
103
104 if (first_call)
105 return get_algo_objects(name, vec);
106
107 return false;
108 }
bool get_rel_objects(const std::string &name, bool upcast_unregistered, std::vector< const DalObject * > &objs) const
Read relationship values as DAL objects using DAL factory.
Definition DalObject.cpp:8
std::mutex m_mutex
Used to protect changes of DAL object.
bool get_algo_objects(const std::string &name, std::vector< const DalObject * > &objs) const
Run algorithm and return result as DAL objects using DAL factory.
Definition DalObject.cpp:25
void check_init() const
Check and initialize object if necessary.
virtual std::vector< const dunedaq::conffwk::DalObject * > get(const std::string &name, bool upcast_unregistered=true) const
Get values of relationships and results of some algorithms as a vector of dunedaq::conffwk::DalObject...

◆ get() [4/4]

bool dunedaq::confmodel::DummyResourceSet::get ( const std::string & name,
std::vector< const dunedaq::conffwk::DalObject * > & vec,
bool upcast_unregistered,
bool first_call ) const
protected

◆ get_items() [1/2]

const std::vector< const dunedaq::confmodel::Resource * > & dunedaq::confmodel::DummyResourceSet::get_items ( ) const
inline

Get "items" relationship value.

Returns
the relationship value
Exceptions
dunedaq::conffwk::Generic,dunedaq::conffwk::DeletedObject

Definition at line 93 of file DummyResourceSet.hpp.

94 {
95 std::lock_guard scoped_lock(m_mutex);
96 check();
97 check_init();
98 if (m_items.empty())
99 {
100 std::ostringstream text;
101 text << "relationship \"" << s_items << "\" of object " << this << " is empty";
102 throw dunedaq::conffwk::Generic(ERS_HERE, text.str().c_str());
103 }
104 return m_items;
105 }
#define ERS_HERE
Generic configuration exception.
std::vector< const dunedaq::confmodel::Resource * > m_items

◆ get_items() [2/2]

const std::vector< const dunedaq::confmodel::Resource * > & dunedaq::confmodel::DummyResourceSet::get_items ( ) const
inline

Get "items" relationship value.

Returns
the relationship value
Exceptions
dunedaq::conffwk::Generic,dunedaq::conffwk::DeletedObject

Definition at line 93 of file DummyResourceSet.hpp.

94 {
95 std::lock_guard scoped_lock(m_mutex);
96 check();
97 check_init();
98 if (m_items.empty())
99 {
100 std::ostringstream text;
101 text << "relationship \"" << s_items << "\" of object " << this << " is empty";
102 throw dunedaq::conffwk::Generic(ERS_HERE, text.str().c_str());
103 }
104 return m_items;
105 }

◆ init() [1/2]

void dunedaq::confmodel::DummyResourceSet::init ( bool init_children)
protectedvirtual

Initialize object (method generated by genconffwk)

Parameters
init_childrenif true, initialize referenced objects

Reimplemented from dunedaq::confmodel::ResourceSet.

Definition at line 61 of file DummyResourceSet.cpp.

62 {
63 ResourceSet::init(init_children);
64
65 TLOG_DEBUG(5) << "read object " << this << " (class " << s_class_name << ')';
66
67 try {
69 }
70 catch (dunedaq::conffwk::Exception & ex) {
71 throw_init_ex(ex);
72 }
73 }
void throw_init_ex(dunedaq::conffwk::Exception &ex)
throw object initialisation exception (i.e.
Definition DalObject.cpp:74
DalRegistry & p_registry
Configuration object.
ConfigObject p_obj
Config object used by given template object.
const T * _ref(ConfigObject &obj, const std::string &name, bool read_children)
Get signle value of object's relation and instantiate result with it (multi-thread safe).
virtual void init(bool init_children)
#define TLOG_DEBUG(lvl,...)
Definition Logging.hpp:112

◆ init() [2/2]

virtual void dunedaq::confmodel::DummyResourceSet::init ( bool init_children)
protectedvirtual

Initialize object (method generated by genconffwk)

Parameters
init_childrenif true, initialize referenced objects

Reimplemented from dunedaq::confmodel::ResourceSet.

◆ print() [1/2]

void dunedaq::confmodel::DummyResourceSet::print ( unsigned int offset,
bool print_header,
std::ostream & s ) const
virtual

Print details of the DummyResourceSet object.

Parameters are:

Parameters
offsetnumber of spaces to shift object right (useful to print nested objects)
print_headerif false, do not print object header (to print attributes of base classes)
soutput stream

Reimplemented from dunedaq::confmodel::ResourceSet.

Definition at line 35 of file DummyResourceSet.cpp.

36 {
37 check_init();
38
39 try {
40 const std::string str(indent+2, ' ');
41
42 if (print_header)
43 p_hdr(s, indent, s_class_name, "dunedaq::confmodel");
44
45
46 // print direct super-classes
47
49
50
51 // print direct relationships
52
54 }
55 catch (dunedaq::conffwk::Exception & ex) {
57 }
58 }
void p_hdr(std::ostream &s, unsigned int indent, const std::string &cl, const char *nm=nullptr) const
print object headers
Definition DalObject.cpp:65
static void p_error(std::ostream &s, dunedaq::conffwk::Exception &ex)
print error text
Definition DalObject.cpp:59
virtual void print(unsigned int offset, bool print_header, std::ostream &s) const
Print details of the ResourceSet object.
void p_mv_rel(std::ostream &s, const std::string &str, const std::string &name, const T &objs) noexcept
print weak multi-value relationship

◆ print() [2/2]

virtual void dunedaq::confmodel::DummyResourceSet::print ( unsigned int offset,
bool print_header,
std::ostream & s ) const
virtual

Print details of the DummyResourceSet object.

Parameters are:

Parameters
offsetnumber of spaces to shift object right (useful to print nested objects)
print_headerif false, do not print object header (to print attributes of base classes)
soutput stream

Reimplemented from dunedaq::confmodel::ResourceSet.

◆ set_items() [1/2]

void dunedaq::confmodel::DummyResourceSet::set_items ( const std::vector< const dunedaq::confmodel::Resource * > & value)

Set "items" relationship value.

Parameters
valuenew relationship value
Exceptions
dunedaq::conffwk::Generic,dunedaq::conffwk::DeletedObject

Definition at line 110 of file DummyResourceSet.cpp.

111 {
112 _set_objects(s_items, value);
113 }
void _set_objects(const std::string &name, const std::vector< const T * > &value)
Helper method for generated set multi-value relationship methods.

◆ set_items() [2/2]

void dunedaq::confmodel::DummyResourceSet::set_items ( const std::vector< const dunedaq::confmodel::Resource * > & value)

Set "items" relationship value.

Parameters
valuenew relationship value
Exceptions
dunedaq::conffwk::Generic,dunedaq::conffwk::DeletedObject

Friends And Related Symbol Documentation

◆ conffwk::Configuration

Definition at line 25 of file DummyResourceSet.hpp.

◆ conffwk::DalFactory

conffwk::DalFactory
friend

Definition at line 27 of file DummyResourceSet.hpp.

◆ conffwk::DalObject

Definition at line 26 of file DummyResourceSet.hpp.

◆ conffwk::DalRegistry

Definition at line 28 of file DummyResourceSet.hpp.

Member Data Documentation

◆ m_items

std::vector< const dunedaq::confmodel::Resource * > dunedaq::confmodel::DummyResourceSet::m_items
private

Definition at line 74 of file DummyResourceSet.hpp.

◆ s_class_name

static const std::string & dunedaq::confmodel::DummyResourceSet::s_class_name
static

The name of the configuration class.

Definition at line 40 of file DummyResourceSet.hpp.

◆ s_items

static const std::string dunedaq::confmodel::DummyResourceSet::s_items = "items"
inlinestatic

Definition at line 81 of file DummyResourceSet.hpp.


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