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

#include <DetDataSender.hpp>

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

Public Member Functions

virtual void print (unsigned int offset, bool print_header, std::ostream &s) const
 Print details of the DetDataSender 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.
 
virtual void print (unsigned int offset, bool print_header, std::ostream &s) const
 Print details of the DetDataSender 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.
 
- Public Member Functions inherited from dunedaq::confmodel::ResourceSetAND
- Public Member Functions inherited from dunedaq::confmodel::ResourceSet
const std::vector< const dunedaq::confmodel::ResourceBase * > & get_contains () const
 Get "contains" relationship value. A resource set is a container of resources to easily implement group operations (add/remove, enable/disable).
 
void set_contains (const std::vector< const dunedaq::confmodel::ResourceBase * > &value)
 Set "contains" relationship value. A resource set is a container of resources to easily implement group operations (add/remove, enable/disable).
 
const std::vector< const dunedaq::confmodel::ResourceBase * > & get_contains () const
 Get "contains" relationship value. A resource set is a container of resources to easily implement group operations (add/remove, enable/disable).
 
void set_contains (const std::vector< const dunedaq::confmodel::ResourceBase * > &value)
 Set "contains" relationship value. A resource set is a container of resources to easily implement group operations (add/remove, enable/disable).
 
- Public Member Functions inherited from dunedaq::confmodel::ResourceBase
- Public Member Functions inherited from dunedaq::confmodel::Component
void get_parents (const dunedaq::confmodel::Session &session, std::list< std::vector< const dunedaq::confmodel::Component * > > &parents) const
 
bool disabled (const dunedaq::confmodel::Session &session) const
 
void get_parents (const dunedaq::confmodel::Session &session, std::list< std::vector< const dunedaq::confmodel::Component * > > &parents) const
 
bool disabled (const dunedaq::confmodel::Session &session) 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 Attributes

static const std::string & s_class_name
 
- Static Public Attributes inherited from dunedaq::confmodel::ResourceSetAND
static const std::string & s_class_name
 
- Static Public Attributes inherited from dunedaq::confmodel::ResourceSet
static const std::string & s_class_name
 
static const std::string s_contains = "contains"
 
- Static Public Attributes inherited from dunedaq::confmodel::ResourceBase
static const std::string & s_class_name
 
- Static Public Attributes inherited from dunedaq::confmodel::Component
static const std::string & s_class_name
 

Protected Member Functions

 DetDataSender (conffwk::DalRegistry &db, const conffwk::ConfigObject &obj) noexcept
 
virtual ~DetDataSender () 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
 
 DetDataSender (conffwk::DalRegistry &db, const conffwk::ConfigObject &obj) noexcept
 
virtual ~DetDataSender () 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::ResourceSetAND
 ResourceSetAND (conffwk::DalRegistry &db, const conffwk::ConfigObject &obj) noexcept
 
virtual ~ResourceSetAND () noexcept
 
bool get (const std::string &name, std::vector< const dunedaq::conffwk::DalObject * > &vec, bool upcast_unregistered, bool first_call) const
 
 ResourceSetAND (conffwk::DalRegistry &db, const conffwk::ConfigObject &obj) noexcept
 
virtual ~ResourceSetAND () 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::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::ResourceBase
 ResourceBase (conffwk::DalRegistry &db, const conffwk::ConfigObject &obj) noexcept
 
virtual ~ResourceBase () noexcept
 
bool get (const std::string &name, std::vector< const dunedaq::conffwk::DalObject * > &vec, bool upcast_unregistered, bool first_call) const
 
 ResourceBase (conffwk::DalRegistry &db, const conffwk::ConfigObject &obj) noexcept
 
virtual ~ResourceBase () 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::Component
 Component (conffwk::DalRegistry &db, const conffwk::ConfigObject &obj) noexcept
 
virtual ~Component () noexcept
 
bool get (const std::string &name, std::vector< const dunedaq::conffwk::DalObject * > &vec, bool upcast_unregistered, bool first_call) const
 
 Component (conffwk::DalRegistry &db, const conffwk::ConfigObject &obj) noexcept
 
virtual ~Component () 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.
 

Friends

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

Additional Inherited Members

- Static Public Member Functions inherited from dunedaq::confmodel::ResourceSet
static const std::string & __get_contains_str () noexcept
 
static const std::string & __get_contains_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
 
- 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 DetDataSender.hpp.

Constructor & Destructor Documentation

◆ DetDataSender() [1/2]

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

Definition at line 15 of file DetDataSender.cpp.

15 :
17 ResourceSetAND(db, o)
18
19 {
20 ;
21 }
The base class for any generated DAL object.
Definition DalObject.hpp:45
ResourceSetAND(conffwk::DalRegistry &db, const conffwk::ConfigObject &obj) noexcept

◆ ~DetDataSender() [1/2]

dunedaq::confmodel::DetDataSender::~DetDataSender ( )
protectedvirtualnoexcept

Definition at line 51 of file DetDataSender.cpp.

52 {
53 }

◆ DetDataSender() [2/2]

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

◆ ~DetDataSender() [2/2]

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

Member Function Documentation

◆ get() [1/4]

std::vector< const dunedaq::conffwk::DalObject * > dunedaq::confmodel::DetDataSender::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::ResourceSetAND.

Reimplemented in dunedaq::appmodel::FakeDataSender, dunedaq::appmodel::FakeDataSender, dunedaq::appmodel::FelixDataSender, dunedaq::appmodel::FelixDataSender, dunedaq::appmodel::HermesDataSender, dunedaq::appmodel::HermesDataSender, dunedaq::appmodel::NWDetDataSender, dunedaq::appmodel::NWDetDataSender, dunedaq::appmodel::SocketDataSender, dunedaq::appmodel::SocketDataSender, dunedaq::appmodel::TdeAmcDetDataSender, and dunedaq::appmodel::TdeAmcDetDataSender.

Definition at line 55 of file DetDataSender.cpp.

56 {
57 std::vector<const dunedaq::conffwk::DalObject *> vec;
58
59 if (!get(name, vec, upcast_unregistered, true))
60 throw_get_ex(name, s_class_name, this);
61
62 return vec;
63 }
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
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...
static const std::string & s_class_name

◆ get() [2/4]

virtual std::vector< const dunedaq::conffwk::DalObject * > dunedaq::confmodel::DetDataSender::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::ResourceSetAND.

Reimplemented in dunedaq::appmodel::FakeDataSender, dunedaq::appmodel::FakeDataSender, dunedaq::appmodel::FelixDataSender, dunedaq::appmodel::FelixDataSender, dunedaq::appmodel::HermesDataSender, dunedaq::appmodel::HermesDataSender, dunedaq::appmodel::NWDetDataSender, dunedaq::appmodel::NWDetDataSender, dunedaq::appmodel::SocketDataSender, dunedaq::appmodel::SocketDataSender, dunedaq::appmodel::TdeAmcDetDataSender, and dunedaq::appmodel::TdeAmcDetDataSender.

◆ get() [3/4]

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

Definition at line 65 of file DetDataSender.cpp.

66 {
67 if (first_call)
68 {
69 std::lock_guard scoped_lock(m_mutex);
70
71 check();
72 check_init();
73
74 if (get_rel_objects(name, upcast_unregistered, vec))
75 return true;
76 }
77
78 if (ResourceSetAND::get(name, vec, upcast_unregistered, false)) return true;
79
80 if (first_call)
81 return get_algo_objects(name, vec);
82
83 return false;
84 }
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::DetDataSender::get ( const std::string & name,
std::vector< const dunedaq::conffwk::DalObject * > & vec,
bool upcast_unregistered,
bool first_call ) const
protected

◆ init() [1/2]

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

◆ init() [2/2]

◆ print() [1/2]

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

Print details of the DetDataSender 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::ResourceSetAND.

Reimplemented in dunedaq::appmodel::FakeDataSender, dunedaq::appmodel::FakeDataSender, dunedaq::appmodel::FelixDataSender, dunedaq::appmodel::FelixDataSender, dunedaq::appmodel::HermesDataSender, dunedaq::appmodel::HermesDataSender, dunedaq::appmodel::NWDetDataSender, dunedaq::appmodel::NWDetDataSender, dunedaq::appmodel::SocketDataSender, dunedaq::appmodel::SocketDataSender, dunedaq::appmodel::TdeAmcDetDataSender, and dunedaq::appmodel::TdeAmcDetDataSender.

Definition at line 24 of file DetDataSender.cpp.

25 {
26 check_init();
27
28 try {
29
30 if (print_header)
31 p_hdr(s, indent, s_class_name, "dunedaq::confmodel");
32
33
34 // print direct super-classes
35
37 }
38 catch (dunedaq::conffwk::Exception & ex) {
40 }
41 }
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 ResourceSetAND object.

◆ print() [2/2]

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

Friends And Related Symbol Documentation

◆ conffwk::Configuration

Definition at line 25 of file DetDataSender.hpp.

◆ conffwk::DalFactory

conffwk::DalFactory
friend

Definition at line 27 of file DetDataSender.hpp.

◆ conffwk::DalObject

Definition at line 26 of file DetDataSender.hpp.

◆ conffwk::DalRegistry

Definition at line 28 of file DetDataSender.hpp.

Member Data Documentation

◆ s_class_name

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

The name of the configuration class.

Definition at line 40 of file DetDataSender.hpp.


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