#include <DaqModulesGroupById.hpp>

Inheritance diagram for dunedaq::confmodel::DaqModulesGroupById:

Collaboration diagram for dunedaq::confmodel::DaqModulesGroupById:

Public Member Functions
virtual void	print (unsigned int offset, bool print_header, std::ostream &s) const
	Print details of the DaqModulesGroupById 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::DaqModule * > &	get_modules () const
	Get "modules" relationship value.

void	set_modules (const std::vector< const dunedaq::confmodel::DaqModule * > &value)
	Set "modules" relationship value.

virtual void	print (unsigned int offset, bool print_header, std::ostream &s) const
	Print details of the DaqModulesGroupById 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::DaqModule * > &	get_modules () const
	Get "modules" relationship value.

void	set_modules (const std::vector< const dunedaq::confmodel::DaqModule * > &value)
	Set "modules" relationship value.

Public Member Functions inherited from dunedaq::confmodel::DaqModulesGroup
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 ConfigObject &	config_object () const

DalRegistry &	registry () const noexcept

Configuration &	configuration () 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_modules_str () noexcept

static const std::string &	__get_modules_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_modules = "modules"

Static Public Attributes inherited from dunedaq::confmodel::DaqModulesGroup
static const std::string &	s_class_name

Protected Member Functions
	DaqModulesGroupById (conffwk::DalRegistry &db, const conffwk::ConfigObject &obj) noexcept

virtual	~DaqModulesGroupById () 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

	DaqModulesGroupById (conffwk::DalRegistry &db, const conffwk::ConfigObject &obj) noexcept

virtual	~DaqModulesGroupById () 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::DaqModulesGroup
	DaqModulesGroup (conffwk::DalRegistry &db, const conffwk::ConfigObject &obj) noexcept

virtual	~DaqModulesGroup () noexcept

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

	DaqModulesGroup (conffwk::DalRegistry &db, const conffwk::ConfigObject &obj) noexcept

virtual	~DaqModulesGroup () 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::DaqModule * >	m_modules

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

DalRegistry &	p_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 32 of file DaqModulesGroupById.hpp.

Constructor & Destructor Documentation

◆ DaqModulesGroupById() [1/2]

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

protectednoexcept

Definition at line 31 of file DaqModulesGroupById.cpp.

                                                                                                          :
      dunedaq::conffwk::DalObject(db, o),
      DaqModulesGroup(db, o)
 
    {
      ;
    }

◆ ~DaqModulesGroupById() [1/2]

dunedaq::confmodel::DaqModulesGroupById::~DaqModulesGroupById ( )

protectedvirtualnoexcept

Definition at line 80 of file DaqModulesGroupById.cpp.

81 {

82 }

◆ DaqModulesGroupById() [2/2]

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

protectednoexcept

◆ ~DaqModulesGroupById() [2/2]

virtual dunedaq::confmodel::DaqModulesGroupById::~DaqModulesGroupById ( )

protectedvirtualnoexcept

Member Function Documentation

◆ __get_modules_str() [1/2]

static const std::string & dunedaq::confmodel::DaqModulesGroupById::__get_modules_str ( )

inlinestaticnoexcept

Definition at line 92 of file DaqModulesGroupById.hpp.

92{ return s_modules; }

dunedaq::confmodel::DaqModulesGroupById::s_modules

static const std::string s_modules

Definition DaqModulesGroupById.hpp:90

◆ __get_modules_str() [2/2]

static const std::string & dunedaq::confmodel::DaqModulesGroupById::__get_modules_str ( )

inlinestaticnoexcept

Definition at line 92 of file DaqModulesGroupById.hpp.

92{ return s_modules; }

◆ get() [1/4]

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

name	name of the relationship or algorithm

Returns: value of relationship or result of algorithm

Exceptions

std::exception if there is no relationship or algorithm with such name in this and base classes

Reimplemented from dunedaq::confmodel::DaqModulesGroup.

Definition at line 84 of file DaqModulesGroupById.cpp.

    {
      std::vector<const dunedaq::conffwk::DalObject *> vec;
 
      if (!get(name, vec, upcast_unregistered, true))
        throw_get_ex(name, s_class_name, this);
 
      return vec;
    }

◆ get() [2/4]

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

name	name of the relationship or algorithm

Returns: value of relationship or result of algorithm

Exceptions

std::exception if there is no relationship or algorithm with such name in this and base classes

Reimplemented from dunedaq::confmodel::DaqModulesGroup.

◆ get() [3/4]

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

protected

Definition at line 94 of file DaqModulesGroupById.cpp.

    {
      if (first_call)
        {
          std::lock_guard scoped_lock(m_mutex);
 
          check();
          check_init();
 
          if (get_rel_objects(name, upcast_unregistered, vec))
            return true;
        }
 
      if (DaqModulesGroup::get(name, vec, upcast_unregistered, false)) return true;
 
      if (first_call)
        return get_algo_objects(name, vec);
 
      return false;
    }

◆ get() [4/4]

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

protected

◆ get_modules() [1/2]

const std::vector< const dunedaq::confmodel::DaqModule * > & dunedaq::confmodel::DaqModulesGroupById::get_modules ( ) const

inline

Get "modules" relationship value.

Returns: the relationship value

Exceptions

dunedaq::conffwk::Generic,dunedaq::conffwk::DeletedObject

Definition at line 102 of file DaqModulesGroupById.hpp.

        {
          std::lock_guard scoped_lock(m_mutex);
          check();
          check_init();
          if (m_modules.empty())
            {
              std::ostringstream text;
              text << "relationship \"" << s_modules << "\" of object " << this << " is empty";
              throw dunedaq::conffwk::Generic(ERS_HERE, text.str().c_str());
            }
          return m_modules;
        }

◆ get_modules() [2/2]

const std::vector< const dunedaq::confmodel::DaqModule * > & dunedaq::confmodel::DaqModulesGroupById::get_modules ( ) const

inline

Get "modules" relationship value.

Returns: the relationship value

Exceptions

dunedaq::conffwk::Generic,dunedaq::conffwk::DeletedObject

Definition at line 102 of file DaqModulesGroupById.hpp.

        {
          std::lock_guard scoped_lock(m_mutex);
          check();
          check_init();
          if (m_modules.empty())
            {
              std::ostringstream text;
              text << "relationship \"" << s_modules << "\" of object " << this << " is empty";
              throw dunedaq::conffwk::Generic(ERS_HERE, text.str().c_str());
            }
          return m_modules;
        }

◆ init() [1/2]

void dunedaq::confmodel::DaqModulesGroupById::init ( bool init_children )

protectedvirtual

Initialize object (method generated by genconffwk)

Parameters

init_children if true, initialize referenced objects

Reimplemented from dunedaq::confmodel::DaqModulesGroup.

Definition at line 66 of file DaqModulesGroupById.cpp.

    {
      DaqModulesGroup::init(init_children);
 
      TLOG_DEBUG(5) << "read object " << this << " (class " << s_class_name << ')';
 
      try {
        p_registry._ref<dunedaq::confmodel::DaqModule>(p_obj, s_modules, m_modules, init_children);
      }
      catch (dunedaq::conffwk::Exception & ex) {
        throw_init_ex(ex);
      }
    }

◆ init() [2/2]

virtual void dunedaq::confmodel::DaqModulesGroupById::init ( bool init_children )

protectedvirtual

Initialize object (method generated by genconffwk)

Parameters

init_children if true, initialize referenced objects

Reimplemented from dunedaq::confmodel::DaqModulesGroup.

◆ print() [1/2]

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

virtual

Print details of the DaqModulesGroupById object.

Parameters are:

Parameters

offset	number of spaces to shift object right (useful to print nested objects)
print_header	if false, do not print object header (to print attributes of base classes)
s	output stream

Reimplemented from dunedaq::confmodel::DaqModulesGroup.

Definition at line 40 of file DaqModulesGroupById.cpp.

    {
      check_init();
 
      try {
        const std::string str(indent+2, ' ');
 
        if (print_header)
          p_hdr(s, indent, s_class_name, "dunedaq::confmodel");
 
 
          // print direct super-classes
 
        dunedaq::confmodel::DaqModulesGroup::print(indent, false, s);
 
 
          // print direct relationships
 
        dunedaq::conffwk::p_mv_rel(s, str, s_modules, m_modules);
      }
      catch (dunedaq::conffwk::Exception & ex) {
        dunedaq::conffwk::DalObject::p_error(s, ex);
      }
    }

◆ print() [2/2]

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

virtual

Print details of the DaqModulesGroupById object.

Parameters are:

Parameters

offset	number of spaces to shift object right (useful to print nested objects)
print_header	if false, do not print object header (to print attributes of base classes)
s	output stream

Reimplemented from dunedaq::confmodel::DaqModulesGroup.

◆ set_modules() [1/2]

void dunedaq::confmodel::DaqModulesGroupById::set_modules ( const std::vector< const dunedaq::confmodel::DaqModule * > & value )

Set "modules" relationship value.

Parameters

value new relationship value

Exceptions

dunedaq::conffwk::Generic,dunedaq::conffwk::DeletedObject

Definition at line 115 of file DaqModulesGroupById.cpp.

    {
      _set_objects(s_modules, value);
    }

◆ set_modules() [2/2]

void dunedaq::confmodel::DaqModulesGroupById::set_modules ( const std::vector< const dunedaq::confmodel::DaqModule * > & value )

Set "modules" relationship value.

Parameters

value new relationship value

Exceptions

dunedaq::conffwk::Generic,dunedaq::conffwk::DeletedObject

Friends And Related Symbol Documentation

◆ conffwk::Configuration

conffwk::Configuration

friend

Definition at line 34 of file DaqModulesGroupById.hpp.

◆ conffwk::DalFactory

conffwk::DalFactory

friend

Definition at line 36 of file DaqModulesGroupById.hpp.

◆ conffwk::DalObject

conffwk::DalObject

friend

Definition at line 35 of file DaqModulesGroupById.hpp.

◆ conffwk::DalRegistry

conffwk::DalRegistry

friend

Definition at line 37 of file DaqModulesGroupById.hpp.

Member Data Documentation

◆ m_modules

std::vector< const dunedaq::confmodel::DaqModule * > dunedaq::confmodel::DaqModulesGroupById::m_modules

private

Definition at line 83 of file DaqModulesGroupById.hpp.

◆ s_class_name

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

static

The name of the configuration class.

Definition at line 49 of file DaqModulesGroupById.hpp.

◆ s_modules

static const std::string dunedaq::confmodel::DaqModulesGroupById::s_modules = "modules"

inlinestatic

Definition at line 90 of file DaqModulesGroupById.hpp.

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

/github/workspace/dunedaq/build/confmodel/codegen/include/confmodel/DaqModulesGroupById.hpp
/github/workspace/dunedaq/build/confmodel/codegen/src/DaqModulesGroupById.hpp
/github/workspace/dunedaq/build/confmodel/codegen/src/DaqModulesGroupById.cpp

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Member Functions

Private Attributes

Friends

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ DaqModulesGroupById() [1/2]

◆ ~DaqModulesGroupById() [1/2]

◆ DaqModulesGroupById() [2/2]

◆ ~DaqModulesGroupById() [2/2]

Member Function Documentation

◆ __get_modules_str() [1/2]

◆ __get_modules_str() [2/2]

◆ get() [1/4]

◆ get() [2/4]

◆ get() [3/4]

◆ get() [4/4]

◆ get_modules() [1/2]

◆ get_modules() [2/2]

◆ init() [1/2]

◆ init() [2/2]

◆ print() [1/2]

◆ print() [2/2]

◆ set_modules() [1/2]

◆ set_modules() [2/2]

Friends And Related Symbol Documentation

◆ conffwk::Configuration

◆ conffwk::DalFactory

◆ conffwk::DalObject

◆ conffwk::DalRegistry

Member Data Documentation

◆ m_modules

◆ s_class_name

◆ s_modules