#include <NetworkConnectionRule.hpp>

Inheritance diagram for dunedaq::appmodel::NetworkConnectionRule:

Collaboration diagram for dunedaq::appmodel::NetworkConnectionRule:

Public Member Functions
virtual void	print (unsigned int offset, bool print_header, std::ostream &s) const
	Print details of the NetworkConnectionRule 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_endpoint_class () const
	Get "endpoint_class" attribute value.

void	set_endpoint_class (const std::string &value)
	Set "endpoint_class" attribute value.

const dunedaq::appmodel::NetworkConnectionDescriptor *	get_descriptor () const
	Get "descriptor" relationship value.

void	set_descriptor (const dunedaq::appmodel::NetworkConnectionDescriptor *value)
	Set "descriptor" relationship value.

virtual void	print (unsigned int offset, bool print_header, std::ostream &s) const
	Print details of the NetworkConnectionRule 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_endpoint_class () const
	Get "endpoint_class" attribute value.

void	set_endpoint_class (const std::string &value)
	Set "endpoint_class" attribute value.

const dunedaq::appmodel::NetworkConnectionDescriptor *	get_descriptor () const
	Get "descriptor" relationship value.

void	set_descriptor (const dunedaq::appmodel::NetworkConnectionDescriptor *value)
	Set "descriptor" relationship value.

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

static const std::string &	__get_descriptor_str () noexcept

static const std::string &	__get_endpoint_class_str () noexcept

static const std::string &	__get_descriptor_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_endpoint_class = "endpoint_class"

static const std::string	s_descriptor = "descriptor"

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

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

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

virtual	~NetworkConnectionRule () 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::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_endpoint_class

const dunedaq::appmodel::NetworkConnectionDescriptor *	m_descriptor

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 29 of file NetworkConnectionRule.hpp.

Constructor & Destructor Documentation

◆ NetworkConnectionRule() [1/2]

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

protectednoexcept

Definition at line 31 of file NetworkConnectionRule.cpp.

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

◆ ~NetworkConnectionRule() [1/2]

dunedaq::appmodel::NetworkConnectionRule::~NetworkConnectionRule ( )

protectedvirtualnoexcept

Definition at line 81 of file NetworkConnectionRule.cpp.

82 {

83 }

◆ NetworkConnectionRule() [2/2]

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

protectednoexcept

◆ ~NetworkConnectionRule() [2/2]

virtual dunedaq::appmodel::NetworkConnectionRule::~NetworkConnectionRule ( )

protectedvirtualnoexcept

Member Function Documentation

◆ __get_descriptor_str() [1/2]

static const std::string & dunedaq::appmodel::NetworkConnectionRule::__get_descriptor_str ( )

inlinestaticnoexcept

Definition at line 128 of file NetworkConnectionRule.hpp.

128{ return s_descriptor; }

dunedaq::appmodel::NetworkConnectionRule::s_descriptor

static const std::string s_descriptor

Definition NetworkConnectionRule.hpp:126

◆ __get_descriptor_str() [2/2]

static const std::string & dunedaq::appmodel::NetworkConnectionRule::__get_descriptor_str ( )

inlinestaticnoexcept

Definition at line 128 of file NetworkConnectionRule.hpp.

128{ return s_descriptor; }

◆ __get_endpoint_class_str() [1/2]

static const std::string & dunedaq::appmodel::NetworkConnectionRule::__get_endpoint_class_str ( )

inlinestaticnoexcept

Definition at line 90 of file NetworkConnectionRule.hpp.

90{ return s_endpoint_class; }

dunedaq::appmodel::NetworkConnectionRule::s_endpoint_class

static const std::string s_endpoint_class

Definition NetworkConnectionRule.hpp:88

◆ __get_endpoint_class_str() [2/2]

static const std::string & dunedaq::appmodel::NetworkConnectionRule::__get_endpoint_class_str ( )

inlinestaticnoexcept

Definition at line 90 of file NetworkConnectionRule.hpp.

90{ return s_endpoint_class; }

◆ get() [1/4]

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

Implements dunedaq::conffwk::DalObject.

Definition at line 85 of file NetworkConnectionRule.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::NetworkConnectionRule::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

Implements dunedaq::conffwk::DalObject.

◆ get() [3/4]

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

protected

Definition at line 95 of file NetworkConnectionRule.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 (first_call)
        return get_algo_objects(name, vec);
 
      return false;
    }

◆ get() [4/4]

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

protected

◆ get_descriptor() [1/2]

const dunedaq::appmodel::NetworkConnectionDescriptor * dunedaq::appmodel::NetworkConnectionRule::get_descriptor ( ) const

inline

Get "descriptor" relationship value.

Returns: the relationship value

Exceptions

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

Definition at line 138 of file NetworkConnectionRule.hpp.

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

◆ get_descriptor() [2/2]

const dunedaq::appmodel::NetworkConnectionDescriptor * dunedaq::appmodel::NetworkConnectionRule::get_descriptor ( ) const

inline

Get "descriptor" relationship value.

Returns: the relationship value

Exceptions

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

Definition at line 138 of file NetworkConnectionRule.hpp.

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

◆ get_endpoint_class() [1/2]

const std::string & dunedaq::appmodel::NetworkConnectionRule::get_endpoint_class ( ) const

inline

Get "endpoint_class" attribute value.

Returns: the attribute value

Exceptions

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

Definition at line 100 of file NetworkConnectionRule.hpp.

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

◆ get_endpoint_class() [2/2]

const std::string & dunedaq::appmodel::NetworkConnectionRule::get_endpoint_class ( ) const

inline

Get "endpoint_class" attribute value.

Returns: the attribute value

Exceptions

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

Definition at line 100 of file NetworkConnectionRule.hpp.

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

◆ init() [1/2]

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

protectedvirtual

Initialize object (method generated by genconffwk)

Parameters

init_children if true, initialize referenced objects

Implements dunedaq::conffwk::DalObject.

Definition at line 66 of file NetworkConnectionRule.cpp.

    {
      p_was_read = true;
      increment_read();
      TLOG_DEBUG(5) << "read object " << this << " (class " << s_class_name << ')';
 
      try {
        p_obj.get(s_endpoint_class, m_endpoint_class);
        m_descriptor = p_registry._ref<dunedaq::appmodel::NetworkConnectionDescriptor>(p_obj, s_descriptor, init_children);
      }
      catch (dunedaq::conffwk::Exception & ex) {
        throw_init_ex(ex);
      }
    }

◆ init() [2/2]

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

protectedvirtual

Initialize object (method generated by genconffwk)

Parameters

init_children if true, initialize referenced objects

Implements dunedaq::conffwk::DalObject.

◆ print() [1/2]

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

virtual

Print details of the NetworkConnectionRule 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

Implements dunedaq::conffwk::DalObject.

Definition at line 40 of file NetworkConnectionRule.cpp.

    {
      check_init();
 
      try {
        const std::string str(indent+2, ' ');
 
        if (print_header)
          p_hdr(s, indent, s_class_name, "dunedaq::appmodel");
 
 
          // print direct attributes
 
        dunedaq::conffwk::p_sv_attr(s, str, s_endpoint_class, m_endpoint_class);
 
 
          // print direct relationships
 
        dunedaq::conffwk::p_sv_rel(s, str, s_descriptor, m_descriptor);
      }
      catch (dunedaq::conffwk::Exception & ex) {
        dunedaq::conffwk::DalObject::p_error(s, ex);
      }
    }

◆ print() [2/2]

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

virtual

Print details of the NetworkConnectionRule 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

Implements dunedaq::conffwk::DalObject.

◆ set_descriptor() [1/2]

void dunedaq::appmodel::NetworkConnectionRule::set_descriptor ( const dunedaq::appmodel::NetworkConnectionDescriptor * value )

Set "descriptor" relationship value.

Parameters

value new relationship value

Exceptions

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

Definition at line 114 of file NetworkConnectionRule.cpp.

    {
      _set_object(s_descriptor, value);
    }

◆ set_descriptor() [2/2]

void dunedaq::appmodel::NetworkConnectionRule::set_descriptor ( const dunedaq::appmodel::NetworkConnectionDescriptor * value )

Set "descriptor" relationship value.

Parameters

value new relationship value

Exceptions

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

◆ set_endpoint_class() [1/2]

void dunedaq::appmodel::NetworkConnectionRule::set_endpoint_class ( const std::string & value )

inline

Set "endpoint_class" attribute value.

Parameters

value new attribute value

Exceptions

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

Definition at line 115 of file NetworkConnectionRule.hpp.

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

◆ set_endpoint_class() [2/2]

void dunedaq::appmodel::NetworkConnectionRule::set_endpoint_class ( const std::string & value )

inline

Set "endpoint_class" attribute value.

Parameters

value new attribute value

Exceptions

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

Definition at line 115 of file NetworkConnectionRule.hpp.

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

Friends And Related Symbol Documentation

◆ conffwk::Configuration

conffwk::Configuration

friend

Definition at line 31 of file NetworkConnectionRule.hpp.

◆ conffwk::DalFactory

conffwk::DalFactory

friend

Definition at line 33 of file NetworkConnectionRule.hpp.

◆ conffwk::DalObject

conffwk::DalObject

friend

Definition at line 32 of file NetworkConnectionRule.hpp.

◆ conffwk::DalRegistry

conffwk::DalRegistry

friend

Definition at line 34 of file NetworkConnectionRule.hpp.

Member Data Documentation

◆ m_descriptor

const dunedaq::appmodel::NetworkConnectionDescriptor * dunedaq::appmodel::NetworkConnectionRule::m_descriptor

private

Definition at line 81 of file NetworkConnectionRule.hpp.

◆ m_endpoint_class

std::string dunedaq::appmodel::NetworkConnectionRule::m_endpoint_class

private

Definition at line 80 of file NetworkConnectionRule.hpp.

◆ s_class_name

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

static

The name of the configuration class.

Definition at line 46 of file NetworkConnectionRule.hpp.

◆ s_descriptor

static const std::string dunedaq::appmodel::NetworkConnectionRule::s_descriptor = "descriptor"

inlinestatic

Definition at line 126 of file NetworkConnectionRule.hpp.

◆ s_endpoint_class

static const std::string dunedaq::appmodel::NetworkConnectionRule::s_endpoint_class = "endpoint_class"

inlinestatic

Definition at line 88 of file NetworkConnectionRule.hpp.

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

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

◆ NetworkConnectionRule() [1/2]

◆ ~NetworkConnectionRule() [1/2]

◆ NetworkConnectionRule() [2/2]

◆ ~NetworkConnectionRule() [2/2]

Member Function Documentation

◆ __get_descriptor_str() [1/2]

◆ __get_descriptor_str() [2/2]

◆ __get_endpoint_class_str() [1/2]

◆ __get_endpoint_class_str() [2/2]

◆ get() [1/4]

◆ get() [2/4]

◆ get() [3/4]

◆ get() [4/4]

◆ get_descriptor() [1/2]

◆ get_descriptor() [2/2]

◆ get_endpoint_class() [1/2]

◆ get_endpoint_class() [2/2]

◆ init() [1/2]

◆ init() [2/2]

◆ print() [1/2]

◆ print() [2/2]

◆ set_descriptor() [1/2]

◆ set_descriptor() [2/2]

◆ set_endpoint_class() [1/2]

◆ set_endpoint_class() [2/2]

Friends And Related Symbol Documentation

◆ conffwk::Configuration

◆ conffwk::DalFactory

◆ conffwk::DalObject

◆ conffwk::DalRegistry

Member Data Documentation

◆ m_descriptor

◆ m_endpoint_class

◆ s_class_name

◆ s_descriptor

◆ s_endpoint_class