#include <NetworkConnection.hpp>

Inheritance diagram for dunedaq::confmodel::NetworkConnection:

Collaboration diagram for dunedaq::confmodel::NetworkConnection:

Classes
struct	Connection_type

Public Member Functions
virtual void	print (unsigned int offset, bool print_header, std::ostream &s) const
	Print details of the NetworkConnection 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::string &	get_connection_type () const
	Get "connection_type" attribute value. Type of the network connection.

void	set_connection_type (const std::string &value)
	Set "connection_type" attribute value. Type of the network connection.

const dunedaq::confmodel::Service *	get_associated_service () const
	Get "associated_service" relationship value. Service provided by this connection.

void	set_associated_service (const dunedaq::confmodel::Service *value)
	Set "associated_service" relationship value. Service provided by this connection.

virtual void	print (unsigned int offset, bool print_header, std::ostream &s) const
	Print details of the NetworkConnection 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::string &	get_connection_type () const
	Get "connection_type" attribute value. Type of the network connection.

void	set_connection_type (const std::string &value)
	Set "connection_type" attribute value. Type of the network connection.

const dunedaq::confmodel::Service *	get_associated_service () const
	Get "associated_service" relationship value. Service provided by this connection.

void	set_associated_service (const dunedaq::confmodel::Service *value)
	Set "associated_service" relationship value. Service provided by this connection.

Public Member Functions inherited from dunedaq::confmodel::Connection
const std::string &	get_data_type () const
	Get "data_type" attribute value. String identifying the data that travel through this connection. This can be used to match up the endpoints of this connection.

void	set_data_type (const std::string &value)
	Set "data_type" attribute value. String identifying the data that travel through this connection. This can be used to match up the endpoints of this connection.

uint32_t	get_send_timeout_ms () const
	Get "send_timeout_ms" attribute value. Timeout in ms for sending on this connection.

void	set_send_timeout_ms (uint32_t value)
	Set "send_timeout_ms" attribute value. Timeout in ms for sending on this connection.

uint32_t	get_recv_timeout_ms () const
	Get "recv_timeout_ms" attribute value. Timeout in ms for receiving on this connection.

void	set_recv_timeout_ms (uint32_t value)
	Set "recv_timeout_ms" attribute value. Timeout in ms for receiving on this connection.

const std::string &	get_data_type () const
	Get "data_type" attribute value. String identifying the data that travel through this connection. This can be used to match up the endpoints of this connection.

void	set_data_type (const std::string &value)
	Set "data_type" attribute value. String identifying the data that travel through this connection. This can be used to match up the endpoints of this connection.

uint32_t	get_send_timeout_ms () const
	Get "send_timeout_ms" attribute value. Timeout in ms for sending on this connection.

void	set_send_timeout_ms (uint32_t value)
	Set "send_timeout_ms" attribute value. Timeout in ms for sending on this connection.

uint32_t	get_recv_timeout_ms () const
	Get "recv_timeout_ms" attribute value. Timeout in ms for receiving on this connection.

void	set_recv_timeout_ms (uint32_t value)
	Set "recv_timeout_ms" attribute value. Timeout in ms for receiving on this connection.

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_connection_type_str () noexcept

static const std::string &	__get_associated_service_str () noexcept

static const std::string &	__get_connection_type_str () noexcept

static const std::string &	__get_associated_service_str () noexcept

Static Public Member Functions inherited from dunedaq::confmodel::Connection
static const std::string &	__get_data_type_str () noexcept

static const std::string &	__get_send_timeout_ms_str () noexcept

static const std::string &	__get_recv_timeout_ms_str () noexcept

static const std::string &	__get_data_type_str () noexcept

static const std::string &	__get_send_timeout_ms_str () noexcept

static const std::string &	__get_recv_timeout_ms_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_connection_type = "connection_type"

static const std::string	s_associated_service = "associated_service"

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

static const std::string	s_data_type = "data_type"

static const std::string	s_send_timeout_ms = "send_timeout_ms"

static const std::string	s_recv_timeout_ms = "recv_timeout_ms"

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

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

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

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

virtual	~Connection () noexcept

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

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

virtual	~Connection () 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::string	m_connection_type

const dunedaq::confmodel::Service *	m_associated_service

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

Constructor & Destructor Documentation

◆ NetworkConnection() [1/2]

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

protectednoexcept

Definition at line 31 of file NetworkConnection.cpp.

                                                                                                      :
      dunedaq::conffwk::DalObject(db, o),
      Connection(db, o),
      m_associated_service (nullptr)
 
    {
      ;
    }

◆ ~NetworkConnection() [1/2]

dunedaq::confmodel::NetworkConnection::~NetworkConnection ( )

protectedvirtualnoexcept

Definition at line 87 of file NetworkConnection.cpp.

88 {

89 }

◆ NetworkConnection() [2/2]

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

protectednoexcept

◆ ~NetworkConnection() [2/2]

virtual dunedaq::confmodel::NetworkConnection::~NetworkConnection ( )

protectedvirtualnoexcept

Member Function Documentation

◆ __get_associated_service_str() [1/2]

static const std::string & dunedaq::confmodel::NetworkConnection::__get_associated_service_str ( )

inlinestaticnoexcept

Definition at line 142 of file NetworkConnection.hpp.

142{ return s_associated_service; }

dunedaq::confmodel::NetworkConnection::s_associated_service

static const std::string s_associated_service

Definition NetworkConnection.hpp:140

◆ __get_associated_service_str() [2/2]

static const std::string & dunedaq::confmodel::NetworkConnection::__get_associated_service_str ( )

inlinestaticnoexcept

Definition at line 142 of file NetworkConnection.hpp.

142{ return s_associated_service; }

◆ __get_connection_type_str() [1/2]

static const std::string & dunedaq::confmodel::NetworkConnection::__get_connection_type_str ( )

inlinestaticnoexcept

Definition at line 93 of file NetworkConnection.hpp.

93{ return s_connection_type; }

dunedaq::confmodel::NetworkConnection::s_connection_type

static const std::string s_connection_type

Definition NetworkConnection.hpp:91

◆ __get_connection_type_str() [2/2]

static const std::string & dunedaq::confmodel::NetworkConnection::__get_connection_type_str ( )

inlinestaticnoexcept

Definition at line 93 of file NetworkConnection.hpp.

93{ return s_connection_type; }

◆ get() [1/4]

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

Definition at line 91 of file NetworkConnection.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::NetworkConnection::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::Connection.

◆ get() [3/4]

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

protected

Definition at line 101 of file NetworkConnection.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 (Connection::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::NetworkConnection::get	(	const std::string &	name,
		std::vector< const dunedaq::conffwk::DalObject * > &	vec,
		bool	upcast_unregistered,
		bool	first_call ) const

protected

◆ get_associated_service() [1/2]

const dunedaq::confmodel::Service * dunedaq::confmodel::NetworkConnection::get_associated_service ( ) const

inline

Get "associated_service" relationship value. Service provided by this connection.

Returns: the relationship value

Exceptions

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

Definition at line 153 of file NetworkConnection.hpp.

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

◆ get_associated_service() [2/2]

const dunedaq::confmodel::Service * dunedaq::confmodel::NetworkConnection::get_associated_service ( ) const

inline

Get "associated_service" relationship value. Service provided by this connection.

Returns: the relationship value

Exceptions

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

Definition at line 153 of file NetworkConnection.hpp.

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

◆ get_connection_type() [1/2]

const std::string & dunedaq::confmodel::NetworkConnection::get_connection_type ( ) const

inline

Get "connection_type" attribute value. Type of the network connection.

Returns: the attribute value

Exceptions

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

Definition at line 113 of file NetworkConnection.hpp.

          {
            std::lock_guard scoped_lock(m_mutex);
            check();
            check_init();
            return m_connection_type;
          }

◆ get_connection_type() [2/2]

const std::string & dunedaq::confmodel::NetworkConnection::get_connection_type ( ) const

inline

Get "connection_type" attribute value. Type of the network connection.

Returns: the attribute value

Exceptions

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

Definition at line 113 of file NetworkConnection.hpp.

          {
            std::lock_guard scoped_lock(m_mutex);
            check();
            check_init();
            return m_connection_type;
          }

◆ init() [1/2]

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

protectedvirtual

Initialize object (method generated by genconffwk)

Parameters

init_children if true, initialize referenced objects

Reimplemented from dunedaq::confmodel::Connection.

Definition at line 72 of file NetworkConnection.cpp.

    {
      Connection::init(init_children);
 
      TLOG_DEBUG(5) << "read object " << this << " (class " << s_class_name << ')';
 
      try {
        p_obj.get(s_connection_type, m_connection_type);
        m_associated_service = p_registry._ref<dunedaq::confmodel::Service>(p_obj, s_associated_service, init_children);
      }
      catch (dunedaq::conffwk::Exception & ex) {
        throw_init_ex(ex);
      }
    }

◆ init() [2/2]

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

protectedvirtual

Initialize object (method generated by genconffwk)

Parameters

init_children if true, initialize referenced objects

Reimplemented from dunedaq::confmodel::Connection.

◆ print() [1/2]

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

virtual

Print details of the NetworkConnection 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::Connection.

Definition at line 41 of file NetworkConnection.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::Connection::print(indent, false, s);
 
 
          // print direct attributes
 
        dunedaq::conffwk::p_sv_attr(s, str, s_connection_type, m_connection_type);
 
 
          // print direct relationships
 
        dunedaq::conffwk::p_sv_rel(s, str, indent, s_associated_service, m_associated_service);
      }
      catch (dunedaq::conffwk::Exception & ex) {
        dunedaq::conffwk::DalObject::p_error(s, ex);
      }
    }

◆ print() [2/2]

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

virtual

Print details of the NetworkConnection 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::Connection.

◆ set_associated_service() [1/2]

void dunedaq::confmodel::NetworkConnection::set_associated_service ( const dunedaq::confmodel::Service * value )

Set "associated_service" relationship value. Service provided by this connection.

Parameters

value new relationship value

Exceptions

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

Definition at line 122 of file NetworkConnection.cpp.

    {
      _set_object(s_associated_service, value);
    }

◆ set_associated_service() [2/2]

void dunedaq::confmodel::NetworkConnection::set_associated_service ( const dunedaq::confmodel::Service * value )

Set "associated_service" relationship value. Service provided by this connection.

Parameters

value new relationship value

Exceptions

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

◆ set_connection_type() [1/2]

void dunedaq::confmodel::NetworkConnection::set_connection_type ( const std::string & value )

inline

Set "connection_type" attribute value. Type of the network connection.

Parameters

value new attribute value

Exceptions

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

Definition at line 129 of file NetworkConnection.hpp.

          {
            std::lock_guard scoped_lock(m_mutex);
            check();
            clear();
            p_obj.set_enum(s_connection_type, value);
          }

◆ set_connection_type() [2/2]

void dunedaq::confmodel::NetworkConnection::set_connection_type ( const std::string & value )

inline

Set "connection_type" attribute value. Type of the network connection.

Parameters

value new attribute value

Exceptions

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

Definition at line 129 of file NetworkConnection.hpp.

          {
            std::lock_guard scoped_lock(m_mutex);
            check();
            clear();
            p_obj.set_enum(s_connection_type, value);
          }

Friends And Related Symbol Documentation

◆ conffwk::Configuration

conffwk::Configuration

friend

Definition at line 34 of file NetworkConnection.hpp.

◆ conffwk::DalFactory

conffwk::DalFactory

friend

Definition at line 36 of file NetworkConnection.hpp.

◆ conffwk::DalObject

conffwk::DalObject

friend

Definition at line 35 of file NetworkConnection.hpp.

◆ conffwk::DalRegistry

conffwk::DalRegistry

friend

Definition at line 37 of file NetworkConnection.hpp.

Member Data Documentation

◆ m_associated_service

const dunedaq::confmodel::Service * dunedaq::confmodel::NetworkConnection::m_associated_service

private

Definition at line 84 of file NetworkConnection.hpp.

◆ m_connection_type

std::string dunedaq::confmodel::NetworkConnection::m_connection_type

private

Definition at line 83 of file NetworkConnection.hpp.

◆ s_associated_service

static const std::string dunedaq::confmodel::NetworkConnection::s_associated_service = "associated_service"

inlinestatic

Definition at line 140 of file NetworkConnection.hpp.

◆ s_class_name

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

static

The name of the configuration class.

Definition at line 49 of file NetworkConnection.hpp.

◆ s_connection_type

static const std::string dunedaq::confmodel::NetworkConnection::s_connection_type = "connection_type"

inlinestatic

Definition at line 91 of file NetworkConnection.hpp.

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

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

Classes

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Member Functions

Private Attributes

Friends

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ NetworkConnection() [1/2]

◆ ~NetworkConnection() [1/2]

◆ NetworkConnection() [2/2]

◆ ~NetworkConnection() [2/2]

Member Function Documentation

◆ __get_associated_service_str() [1/2]

◆ __get_associated_service_str() [2/2]

◆ __get_connection_type_str() [1/2]

◆ __get_connection_type_str() [2/2]

◆ get() [1/4]

◆ get() [2/4]

◆ get() [3/4]

◆ get() [4/4]

◆ get_associated_service() [1/2]

◆ get_associated_service() [2/2]

◆ get_connection_type() [1/2]

◆ get_connection_type() [2/2]

◆ init() [1/2]

◆ init() [2/2]

◆ print() [1/2]

◆ print() [2/2]

◆ set_associated_service() [1/2]

◆ set_associated_service() [2/2]

◆ set_connection_type() [1/2]

◆ set_connection_type() [2/2]

Friends And Related Symbol Documentation

◆ conffwk::Configuration

◆ conffwk::DalFactory

◆ conffwk::DalObject

◆ conffwk::DalRegistry

Member Data Documentation

◆ m_associated_service

◆ m_connection_type

◆ s_associated_service

◆ s_class_name

◆ s_connection_type