#include <SocketWriterConf.hpp>

Inheritance diagram for dunedaq::appmodel::SocketWriterConf:

Collaboration diagram for dunedaq::appmodel::SocketWriterConf:

Classes
struct	Socket_type

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

void	set_socket_type (const std::string &value)
	Set "socket_type" attribute value. Socket type.

const std::string &	get_remote_ip () const
	Get "remote_ip" attribute value. Remote IP address.

void	set_remote_ip (const std::string &value)
	Set "remote_ip" attribute value. Remote IP address.

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

void	set_socket_type (const std::string &value)
	Set "socket_type" attribute value. Socket type.

const std::string &	get_remote_ip () const
	Get "remote_ip" attribute value. Remote IP address.

void	set_remote_ip (const std::string &value)
	Set "remote_ip" attribute value. Remote IP address.

Public Member Functions inherited from dunedaq::appmodel::SocketDataWriterConf
const std::string &	get_template_for () const
	Get "template_for" attribute value. OKS class of the SocketDataWriterModule that this config is a template for.

void	set_template_for (const std::string &value)
	Set "template_for" attribute value. OKS class of the SocketDataWriterModule that this config is a template for.

const std::string &	get_template_for () const
	Get "template_for" attribute value. OKS class of the SocketDataWriterModule that this config is a template for.

void	set_template_for (const std::string &value)
	Set "template_for" attribute value. OKS class of the SocketDataWriterModule that this config is a template for.

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

static const std::string &	__get_remote_ip_str () noexcept

static const std::string &	__get_socket_type_str () noexcept

static const std::string &	__get_remote_ip_str () noexcept

Static Public Member Functions inherited from dunedaq::appmodel::SocketDataWriterConf
static const std::string &	__get_template_for_str () noexcept

static const std::string &	__get_template_for_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_socket_type = "socket_type"

static const std::string	s_remote_ip = "remote_ip"

Static Public Attributes inherited from dunedaq::appmodel::SocketDataWriterConf
static const std::string &	s_class_name

static const std::string	s_template_for = "template_for"

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

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

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

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

virtual	~SocketDataWriterConf () noexcept

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

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

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

std::string	m_remote_ip

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 23 of file SocketWriterConf.hpp.

Constructor & Destructor Documentation

◆ SocketWriterConf() [1/2]

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

protectednoexcept

Definition at line 26 of file SocketWriterConf.cpp.

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

◆ ~SocketWriterConf() [1/2]

dunedaq::appmodel::SocketWriterConf::~SocketWriterConf ( )

protectedvirtualnoexcept

Definition at line 77 of file SocketWriterConf.cpp.

78 {

79 }

◆ SocketWriterConf() [2/2]

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

protectednoexcept

◆ ~SocketWriterConf() [2/2]

virtual dunedaq::appmodel::SocketWriterConf::~SocketWriterConf ( )

protectedvirtualnoexcept

Member Function Documentation

◆ __get_remote_ip_str() [1/2]

static const std::string & dunedaq::appmodel::SocketWriterConf::__get_remote_ip_str ( )

inlinestaticnoexcept

Definition at line 86 of file SocketWriterConf.hpp.

86{ return s_remote_ip; }

dunedaq::appmodel::SocketWriterConf::s_remote_ip

static const std::string s_remote_ip

Definition SocketWriterConf.hpp:83

◆ __get_remote_ip_str() [2/2]

static const std::string & dunedaq::appmodel::SocketWriterConf::__get_remote_ip_str ( )

inlinestaticnoexcept

Definition at line 86 of file SocketWriterConf.hpp.

86{ return s_remote_ip; }

◆ __get_socket_type_str() [1/2]

static const std::string & dunedaq::appmodel::SocketWriterConf::__get_socket_type_str ( )

inlinestaticnoexcept

Definition at line 85 of file SocketWriterConf.hpp.

85{ return s_socket_type; }

dunedaq::appmodel::SocketWriterConf::s_socket_type

static const std::string s_socket_type

Definition SocketWriterConf.hpp:82

◆ __get_socket_type_str() [2/2]

static const std::string & dunedaq::appmodel::SocketWriterConf::__get_socket_type_str ( )

inlinestaticnoexcept

Definition at line 85 of file SocketWriterConf.hpp.

85{ return s_socket_type; }

◆ get() [1/4]

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

Definition at line 81 of file SocketWriterConf.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::SocketWriterConf::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::appmodel::SocketDataWriterConf.

◆ get() [3/4]

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

protected

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

protected

◆ get_remote_ip() [1/2]

const std::string & dunedaq::appmodel::SocketWriterConf::get_remote_ip ( ) const

inline

Get "remote_ip" attribute value. Remote IP address.

Returns: the attribute value

Exceptions

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

Definition at line 139 of file SocketWriterConf.hpp.

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

◆ get_remote_ip() [2/2]

const std::string & dunedaq::appmodel::SocketWriterConf::get_remote_ip ( ) const

inline

Get "remote_ip" attribute value. Remote IP address.

Returns: the attribute value

Exceptions

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

Definition at line 139 of file SocketWriterConf.hpp.

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

◆ get_socket_type() [1/2]

const std::string & dunedaq::appmodel::SocketWriterConf::get_socket_type ( ) const

inline

Get "socket_type" attribute value. Socket type.

Returns: the attribute value

Exceptions

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

Definition at line 106 of file SocketWriterConf.hpp.

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

◆ get_socket_type() [2/2]

const std::string & dunedaq::appmodel::SocketWriterConf::get_socket_type ( ) const

inline

Get "socket_type" attribute value. Socket type.

Returns: the attribute value

Exceptions

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

Definition at line 106 of file SocketWriterConf.hpp.

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

◆ init() [1/2]

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

protectedvirtual

Initialize object (method generated by genconffwk)

Parameters

init_children if true, initialize referenced objects

Reimplemented from dunedaq::appmodel::SocketDataWriterConf.

Definition at line 62 of file SocketWriterConf.cpp.

    {
      SocketDataWriterConf::init(init_children);
 
      TLOG_DEBUG(5) << "read object " << this << " (class " << s_class_name << ')';
 
      try {
        p_obj.get(s_socket_type, m_socket_type);
        p_obj.get(s_remote_ip, m_remote_ip);
      }
      catch (dunedaq::conffwk::Exception & ex) {
        throw_init_ex(ex);
      }
    }

◆ init() [2/2]

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

protectedvirtual

Initialize object (method generated by genconffwk)

Parameters

init_children if true, initialize referenced objects

Reimplemented from dunedaq::appmodel::SocketDataWriterConf.

◆ print() [1/2]

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

virtual

Print details of the SocketWriterConf 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::appmodel::SocketDataWriterConf.

Definition at line 35 of file SocketWriterConf.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::appmodel::SocketDataWriterConf::print(indent, false, s);
 
 
          // print direct attributes
 
        dunedaq::conffwk::p_sv_attr(s, str, s_socket_type, m_socket_type);
        dunedaq::conffwk::p_sv_attr(s, str, s_remote_ip, m_remote_ip);
      }
      catch (dunedaq::conffwk::Exception & ex) {
        dunedaq::conffwk::DalObject::p_error(s, ex);
      }
    }

◆ print() [2/2]

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

virtual

Print details of the SocketWriterConf 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::appmodel::SocketDataWriterConf.

◆ set_remote_ip() [1/2]

void dunedaq::appmodel::SocketWriterConf::set_remote_ip ( const std::string & value )

inline

Set "remote_ip" attribute value. Remote IP address.

Parameters

value new attribute value

Exceptions

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

Definition at line 155 of file SocketWriterConf.hpp.

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

◆ set_remote_ip() [2/2]

void dunedaq::appmodel::SocketWriterConf::set_remote_ip ( const std::string & value )

inline

Set "remote_ip" attribute value. Remote IP address.

Parameters

value new attribute value

Exceptions

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

Definition at line 155 of file SocketWriterConf.hpp.

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

◆ set_socket_type() [1/2]

void dunedaq::appmodel::SocketWriterConf::set_socket_type ( const std::string & value )

inline

Set "socket_type" attribute value. Socket type.

Parameters

value new attribute value

Exceptions

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

Definition at line 122 of file SocketWriterConf.hpp.

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

◆ set_socket_type() [2/2]

void dunedaq::appmodel::SocketWriterConf::set_socket_type ( const std::string & value )

inline

Set "socket_type" attribute value. Socket type.

Parameters

value new attribute value

Exceptions

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

Definition at line 122 of file SocketWriterConf.hpp.

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

Friends And Related Symbol Documentation

◆ conffwk::Configuration

conffwk::Configuration

friend

Definition at line 25 of file SocketWriterConf.hpp.

◆ conffwk::DalFactory

conffwk::DalFactory

friend

Definition at line 27 of file SocketWriterConf.hpp.

◆ conffwk::DalObject

conffwk::DalObject

friend

Definition at line 26 of file SocketWriterConf.hpp.

◆ conffwk::DalRegistry

conffwk::DalRegistry

friend

Definition at line 28 of file SocketWriterConf.hpp.

Member Data Documentation

◆ m_remote_ip

std::string dunedaq::appmodel::SocketWriterConf::m_remote_ip

private

Definition at line 75 of file SocketWriterConf.hpp.

◆ m_socket_type

std::string dunedaq::appmodel::SocketWriterConf::m_socket_type

private

Definition at line 74 of file SocketWriterConf.hpp.

◆ s_class_name

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

static

The name of the configuration class.

Definition at line 40 of file SocketWriterConf.hpp.

◆ s_remote_ip

static const std::string dunedaq::appmodel::SocketWriterConf::s_remote_ip = "remote_ip"

inlinestatic

Definition at line 83 of file SocketWriterConf.hpp.

◆ s_socket_type

static const std::string dunedaq::appmodel::SocketWriterConf::s_socket_type = "socket_type"

inlinestatic

Definition at line 82 of file SocketWriterConf.hpp.

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

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

◆ SocketWriterConf() [1/2]

◆ ~SocketWriterConf() [1/2]

◆ SocketWriterConf() [2/2]

◆ ~SocketWriterConf() [2/2]

Member Function Documentation

◆ __get_remote_ip_str() [1/2]

◆ __get_remote_ip_str() [2/2]

◆ __get_socket_type_str() [1/2]

◆ __get_socket_type_str() [2/2]

◆ get() [1/4]

◆ get() [2/4]

◆ get() [3/4]

◆ get() [4/4]

◆ get_remote_ip() [1/2]

◆ get_remote_ip() [2/2]

◆ get_socket_type() [1/2]

◆ get_socket_type() [2/2]

◆ init() [1/2]

◆ init() [2/2]

◆ print() [1/2]

◆ print() [2/2]

◆ set_remote_ip() [1/2]

◆ set_remote_ip() [2/2]

◆ set_socket_type() [1/2]

◆ set_socket_type() [2/2]

Friends And Related Symbol Documentation

◆ conffwk::Configuration

◆ conffwk::DalFactory

◆ conffwk::DalObject

◆ conffwk::DalRegistry

Member Data Documentation

◆ m_remote_ip

◆ m_socket_type

◆ s_class_name

◆ s_remote_ip

◆ s_socket_type