#include <NWDetDataReceiver.hpp>

Inheritance diagram for dunedaq::appmodel::NWDetDataReceiver:

Collaboration diagram for dunedaq::appmodel::NWDetDataReceiver:

Public Member Functions
virtual void	print (unsigned int offset, bool print_header, std::ostream &s) const
	Print details of the NWDetDataReceiver 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 dunedaq::confmodel::NetworkInterface *	get_uses () const
	Get "uses" relationship value.

void	set_uses (const dunedaq::confmodel::NetworkInterface *value)
	Set "uses" relationship value.

virtual void	print (unsigned int offset, bool print_header, std::ostream &s) const
	Print details of the NWDetDataReceiver 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 dunedaq::confmodel::NetworkInterface *	get_uses () const
	Get "uses" relationship value.

void	set_uses (const dunedaq::confmodel::NetworkInterface *value)
	Set "uses" relationship value.

Public Member Functions inherited from dunedaq::confmodel::DetDataReceiver
Public Member Functions inherited from dunedaq::confmodel::Resource
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 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_uses_str () noexcept

static const std::string &	__get_uses_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_uses = "uses"

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

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

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

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

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

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

virtual	~DetDataReceiver () noexcept

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

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

virtual	~DetDataReceiver () 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::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.

Private Attributes
const dunedaq::confmodel::NetworkInterface *	m_uses

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 NWDetDataReceiver.hpp.

Constructor & Destructor Documentation

◆ NWDetDataReceiver() [1/2]

dunedaq::appmodel::NWDetDataReceiver::NWDetDataReceiver	(	conffwk::DalRegistry &	db,
		const conffwk::ConfigObject &	obj )

protectednoexcept

Definition at line 20 of file NWDetDataReceiver.cpp.

                                                                                                      :
      dunedaq::conffwk::DalObject(db, o),
      dunedaq::confmodel::DetDataReceiver(db, o),
      m_uses (nullptr)
 
    {
      ;
    }

◆ ~NWDetDataReceiver() [1/2]

dunedaq::appmodel::NWDetDataReceiver::~NWDetDataReceiver ( )

protectedvirtualnoexcept

Definition at line 70 of file NWDetDataReceiver.cpp.

71 {

72 }

◆ NWDetDataReceiver() [2/2]

dunedaq::appmodel::NWDetDataReceiver::NWDetDataReceiver	(	conffwk::DalRegistry &	db,
		const conffwk::ConfigObject &	obj )

protectednoexcept

◆ ~NWDetDataReceiver() [2/2]

virtual dunedaq::appmodel::NWDetDataReceiver::~NWDetDataReceiver ( )

protectedvirtualnoexcept

Member Function Documentation

◆ __get_uses_str() [1/2]

static const std::string & dunedaq::appmodel::NWDetDataReceiver::__get_uses_str ( )

inlinestaticnoexcept

Definition at line 92 of file NWDetDataReceiver.hpp.

92{ return s_uses; }

dunedaq::appmodel::NWDetDataReceiver::s_uses

static const std::string s_uses

Definition NWDetDataReceiver.hpp:90

◆ __get_uses_str() [2/2]

static const std::string & dunedaq::appmodel::NWDetDataReceiver::__get_uses_str ( )

inlinestaticnoexcept

Definition at line 92 of file NWDetDataReceiver.hpp.

92{ return s_uses; }

◆ get() [1/4]

std::vector< const dunedaq::conffwk::DalObject * > dunedaq::appmodel::NWDetDataReceiver::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::DetDataReceiver.

Reimplemented in dunedaq::appmodel::DPDKReceiver, dunedaq::appmodel::DPDKReceiver, dunedaq::appmodel::SocketReceiver, and dunedaq::appmodel::SocketReceiver.

Definition at line 74 of file NWDetDataReceiver.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::appmodel::NWDetDataReceiver::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::DetDataReceiver.

Reimplemented in dunedaq::appmodel::DPDKReceiver, dunedaq::appmodel::DPDKReceiver, dunedaq::appmodel::SocketReceiver, and dunedaq::appmodel::SocketReceiver.

◆ get() [3/4]

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

protected

Definition at line 84 of file NWDetDataReceiver.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 (DetDataReceiver::get(name, vec, upcast_unregistered, false)) return true;
 
      if (first_call)
        return get_algo_objects(name, vec);
 
      return false;
    }

◆ get() [4/4]

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

protected

◆ get_uses() [1/2]

const dunedaq::confmodel::NetworkInterface * dunedaq::appmodel::NWDetDataReceiver::get_uses ( ) const

inline

Get "uses" relationship value.

Returns: the relationship value

Exceptions

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

Definition at line 102 of file NWDetDataReceiver.hpp.

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

◆ get_uses() [2/2]

const dunedaq::confmodel::NetworkInterface * dunedaq::appmodel::NWDetDataReceiver::get_uses ( ) const

inline

Get "uses" relationship value.

Returns: the relationship value

Exceptions

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

Definition at line 102 of file NWDetDataReceiver.hpp.

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

◆ init() [1/2]

void dunedaq::appmodel::NWDetDataReceiver::init ( bool init_children )

protectedvirtual

Initialize object (method generated by genconffwk)

Parameters

init_children if true, initialize referenced objects

Reimplemented from dunedaq::confmodel::DetDataReceiver.

Reimplemented in dunedaq::appmodel::DPDKReceiver, dunedaq::appmodel::DPDKReceiver, dunedaq::appmodel::SocketReceiver, and dunedaq::appmodel::SocketReceiver.

Definition at line 56 of file NWDetDataReceiver.cpp.

    {
      DetDataReceiver::init(init_children);
 
      TLOG_DEBUG(5) << "read object " << this << " (class " << s_class_name << ')';
 
      try {
        m_uses = p_registry._ref<dunedaq::confmodel::NetworkInterface>(p_obj, s_uses, init_children);
      }
      catch (dunedaq::conffwk::Exception & ex) {
        throw_init_ex(ex);
      }
    }

◆ init() [2/2]

virtual void dunedaq::appmodel::NWDetDataReceiver::init ( bool init_children )

protectedvirtual

Initialize object (method generated by genconffwk)

Parameters

init_children if true, initialize referenced objects

Reimplemented from dunedaq::confmodel::DetDataReceiver.

Reimplemented in dunedaq::appmodel::DPDKReceiver, dunedaq::appmodel::DPDKReceiver, dunedaq::appmodel::SocketReceiver, and dunedaq::appmodel::SocketReceiver.

◆ print() [1/2]

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

virtual

Print details of the NWDetDataReceiver 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::DetDataReceiver.

Reimplemented in dunedaq::appmodel::DPDKReceiver, dunedaq::appmodel::DPDKReceiver, dunedaq::appmodel::SocketReceiver, and dunedaq::appmodel::SocketReceiver.

Definition at line 30 of file NWDetDataReceiver.cpp.

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

◆ print() [2/2]

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

virtual

Print details of the NWDetDataReceiver 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::DetDataReceiver.

Reimplemented in dunedaq::appmodel::DPDKReceiver, dunedaq::appmodel::DPDKReceiver, dunedaq::appmodel::SocketReceiver, and dunedaq::appmodel::SocketReceiver.

◆ set_uses() [1/2]

void dunedaq::appmodel::NWDetDataReceiver::set_uses ( const dunedaq::confmodel::NetworkInterface * value )

Set "uses" relationship value.

Parameters

value new relationship value

Exceptions

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

Definition at line 105 of file NWDetDataReceiver.cpp.

    {
      _set_object(s_uses, value);
    }

◆ set_uses() [2/2]

void dunedaq::appmodel::NWDetDataReceiver::set_uses ( const dunedaq::confmodel::NetworkInterface * value )

Set "uses" 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 NWDetDataReceiver.hpp.

◆ conffwk::DalFactory

conffwk::DalFactory

friend

Definition at line 36 of file NWDetDataReceiver.hpp.

◆ conffwk::DalObject

conffwk::DalObject

friend

Definition at line 35 of file NWDetDataReceiver.hpp.

◆ conffwk::DalRegistry

conffwk::DalRegistry

friend

Definition at line 37 of file NWDetDataReceiver.hpp.

Member Data Documentation

◆ m_uses

const dunedaq::confmodel::NetworkInterface * dunedaq::appmodel::NWDetDataReceiver::m_uses

private

Definition at line 83 of file NWDetDataReceiver.hpp.

◆ s_class_name

static const std::string & dunedaq::appmodel::NWDetDataReceiver::s_class_name

static

The name of the configuration class.

Definition at line 49 of file NWDetDataReceiver.hpp.

◆ s_uses

static const std::string dunedaq::appmodel::NWDetDataReceiver::s_uses = "uses"

inlinestatic

Definition at line 90 of file NWDetDataReceiver.hpp.

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

/github/workspace/dunedaq/build/appmodel/codegen/include/appmodel/NWDetDataReceiver.hpp
/github/workspace/dunedaq/build/appmodel/codegen/src/NWDetDataReceiver.hpp
/github/workspace/dunedaq/build/appmodel/codegen/src/NWDetDataReceiver.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

◆ NWDetDataReceiver() [1/2]

◆ ~NWDetDataReceiver() [1/2]

◆ NWDetDataReceiver() [2/2]

◆ ~NWDetDataReceiver() [2/2]

Member Function Documentation

◆ __get_uses_str() [1/2]

◆ __get_uses_str() [2/2]

◆ get() [1/4]

◆ get() [2/4]

◆ get() [3/4]

◆ get() [4/4]

◆ get_uses() [1/2]

◆ get_uses() [2/2]

◆ init() [1/2]

◆ init() [2/2]

◆ print() [1/2]

◆ print() [2/2]

◆ set_uses() [1/2]

◆ set_uses() [2/2]

Friends And Related Symbol Documentation

◆ conffwk::Configuration

◆ conffwk::DalFactory

◆ conffwk::DalObject

◆ conffwk::DalRegistry

Member Data Documentation

◆ m_uses

◆ s_class_name

◆ s_uses