dunedaq::confmodel::Service Class Reference

#include <Service.hpp>

Inheritance diagram for dunedaq::confmodel::Service:

Collaboration diagram for dunedaq::confmodel::Service:

Public Member Functions
virtual void	print (unsigned int offset, bool print_header, std::ostream &s) const
	Print details of the Service 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_protocol () const
	Get "protocol" attribute value.
void	set_protocol (const std::string &value)
	Set "protocol" attribute value.
uint16_t	get_port () const
	Get "port" attribute value.
void	set_port (uint16_t value)
	Set "port" attribute value.
const std::string &	get_eth_device_name () const
	Get "eth_device_name" attribute value.
void	set_eth_device_name (const std::string &value)
	Set "eth_device_name" attribute value.
const std::string &	get_path () const
	Get "path" attribute value.
void	set_path (const std::string &value)
	Set "path" attribute value.
virtual void	print (unsigned int offset, bool print_header, std::ostream &s) const
	Print details of the Service 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_protocol () const
	Get "protocol" attribute value.
void	set_protocol (const std::string &value)
	Set "protocol" attribute value.
uint16_t	get_port () const
	Get "port" attribute value.
void	set_port (uint16_t value)
	Set "port" attribute value.
const std::string &	get_eth_device_name () const
	Get "eth_device_name" attribute value.
void	set_eth_device_name (const std::string &value)
	Set "eth_device_name" attribute value.
const std::string &	get_path () const
	Get "path" attribute value.
void	set_path (const std::string &value)
	Set "path" attribute 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_protocol_str () noexcept
static const std::string &	__get_port_str () noexcept
static const std::string &	__get_eth_device_name_str () noexcept
static const std::string &	__get_path_str () noexcept
static const std::string &	__get_protocol_str () noexcept
static const std::string &	__get_port_str () noexcept
static const std::string &	__get_eth_device_name_str () noexcept
static const std::string &	__get_path_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_protocol = "protocol"
static const std::string	s_port = "port"
static const std::string	s_eth_device_name = "eth_device_name"
static const std::string	s_path = "path"

Protected Member Functions
	Service (conffwk::DalRegistry &db, const conffwk::ConfigObject &obj) noexcept
virtual	~Service () 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
	Service (conffwk::DalRegistry &db, const conffwk::ConfigObject &obj) noexcept
virtual	~Service () 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_protocol
uint16_t	m_port
std::string	m_eth_device_name
std::string	m_path

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 20 of file Service.hpp.

Constructor & Destructor Documentation

Service() [1/2]

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

protectednoexcept

Definition at line 26 of file Service.cpp.

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

~Service() [1/2]

dunedaq::confmodel::Service::~Service ( )

protectedvirtualnoexcept

Definition at line 74 of file Service.cpp.

    {
    }

Service() [2/2]

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

protectednoexcept

~Service() [2/2]

virtual dunedaq::confmodel::Service::~Service ( )

protectedvirtualnoexcept

Member Function Documentation

__get_eth_device_name_str() [1/2]

static const std::string & dunedaq::confmodel::Service::__get_eth_device_name_str ( )

inlinestaticnoexcept

Definition at line 88 of file Service.hpp.

{ return s_eth_device_name; }

__get_eth_device_name_str() [2/2]

static const std::string & dunedaq::confmodel::Service::__get_eth_device_name_str ( )

inlinestaticnoexcept

Definition at line 88 of file Service.hpp.

{ return s_eth_device_name; }

__get_path_str() [1/2]

static const std::string & dunedaq::confmodel::Service::__get_path_str ( )

inlinestaticnoexcept

Definition at line 89 of file Service.hpp.

{ return s_path; }

__get_path_str() [2/2]

static const std::string & dunedaq::confmodel::Service::__get_path_str ( )

inlinestaticnoexcept

Definition at line 89 of file Service.hpp.

{ return s_path; }

__get_port_str() [1/2]

static const std::string & dunedaq::confmodel::Service::__get_port_str ( )

inlinestaticnoexcept

Definition at line 87 of file Service.hpp.

{ return s_port; }

__get_port_str() [2/2]

static const std::string & dunedaq::confmodel::Service::__get_port_str ( )

inlinestaticnoexcept

Definition at line 87 of file Service.hpp.

{ return s_port; }

__get_protocol_str() [1/2]

static const std::string & dunedaq::confmodel::Service::__get_protocol_str ( )

inlinestaticnoexcept

Definition at line 86 of file Service.hpp.

{ return s_protocol; }

__get_protocol_str() [2/2]

static const std::string & dunedaq::confmodel::Service::__get_protocol_str ( )

inlinestaticnoexcept

Definition at line 86 of file Service.hpp.

{ return s_protocol; }

get() [1/4]

std::vector< const dunedaq::conffwk::DalObject * > dunedaq::confmodel::Service::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 78 of file Service.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::Service::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::confmodel::Service::get ( const std::string & name, std::vector< const dunedaq::conffwk::DalObject * > & vec, bool upcast_unregistered, bool first_call ) const

protected

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

protected

get_eth_device_name() [1/2]

const std::string & dunedaq::confmodel::Service::get_eth_device_name ( ) const

inline

Get "eth_device_name" attribute value.

Returns

the attribute value

Exceptions

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

Definition at line 161 of file Service.hpp.

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

get_eth_device_name() [2/2]

const std::string & dunedaq::confmodel::Service::get_eth_device_name ( ) const

inline

Get "eth_device_name" attribute value.

Returns

the attribute value

Exceptions

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

Definition at line 161 of file Service.hpp.

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

get_path() [1/2]

const std::string & dunedaq::confmodel::Service::get_path ( ) const

inline

Get "path" attribute value.

Returns

the attribute value

Exceptions

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

Definition at line 192 of file Service.hpp.

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

get_path() [2/2]

const std::string & dunedaq::confmodel::Service::get_path ( ) const

inline

Get "path" attribute value.

Returns

the attribute value

Exceptions

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

Definition at line 192 of file Service.hpp.

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

get_port() [1/2]

uint16_t dunedaq::confmodel::Service::get_port ( ) const

inline

Get "port" attribute value.

Returns

the attribute value

Exceptions

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

Definition at line 130 of file Service.hpp.

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

get_port() [2/2]

uint16_t dunedaq::confmodel::Service::get_port ( ) const

inline

Get "port" attribute value.

Returns

the attribute value

Exceptions

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

Definition at line 130 of file Service.hpp.

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

get_protocol() [1/2]

const std::string & dunedaq::confmodel::Service::get_protocol ( ) const

inline

Get "protocol" attribute value.

Returns

the attribute value

Exceptions

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

Definition at line 99 of file Service.hpp.

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

get_protocol() [2/2]

const std::string & dunedaq::confmodel::Service::get_protocol ( ) const

inline

Get "protocol" attribute value.

Returns

the attribute value

Exceptions

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

Definition at line 99 of file Service.hpp.

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

init() [1/2]

void dunedaq::confmodel::Service::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 57 of file Service.cpp.

    {
      p_was_read = true;
      increment_read();
      TLOG_DEBUG(5) << "read object " << this << " (class " << s_class_name << ')';
 
      try {
        p_obj.get(s_protocol, m_protocol);
        p_obj.get(s_port, m_port);
        p_obj.get(s_eth_device_name, m_eth_device_name);
        p_obj.get(s_path, m_path);
      }
      catch (dunedaq::conffwk::Exception & ex) {
        throw_init_ex(ex);
      }
    }

init() [2/2]

virtual void dunedaq::confmodel::Service::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::confmodel::Service::print ( unsigned int offset, bool print_header, std::ostream & s ) const

virtual

Print details of the Service 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 33 of file Service.cpp.

    {
      check_init();
 
      try {
        const std::string str(indent+2, ' ');
 
        if (print_header)
          p_hdr(s, indent, s_class_name, "dunedaq::confmodel");
 
 
          // print direct attributes
 
        dunedaq::conffwk::p_sv_attr(s, str, s_protocol, m_protocol);
        dunedaq::conffwk::p_sv_attr(s, str, s_port, m_port);
        dunedaq::conffwk::p_sv_attr(s, str, s_eth_device_name, m_eth_device_name);
        dunedaq::conffwk::p_sv_attr(s, str, s_path, m_path);
      }
      catch (dunedaq::conffwk::Exception & ex) {
        dunedaq::conffwk::DalObject::p_error(s, ex);
      }
    }

print() [2/2]

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

virtual

Print details of the Service 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_eth_device_name() [1/2]

void dunedaq::confmodel::Service::set_eth_device_name ( const std::string & value )

inline

Set "eth_device_name" attribute value.

Parameters

value

new attribute value

Exceptions

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

Definition at line 176 of file Service.hpp.

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

set_eth_device_name() [2/2]

void dunedaq::confmodel::Service::set_eth_device_name ( const std::string & value )

inline

Set "eth_device_name" attribute value.

Parameters

value

new attribute value

Exceptions

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

Definition at line 176 of file Service.hpp.

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

set_path() [1/2]

void dunedaq::confmodel::Service::set_path ( const std::string & value )

inline

Set "path" attribute value.

Parameters

value

new attribute value

Exceptions

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

Definition at line 207 of file Service.hpp.

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

set_path() [2/2]

void dunedaq::confmodel::Service::set_path ( const std::string & value )

inline

Set "path" attribute value.

Parameters

value

new attribute value

Exceptions

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

Definition at line 207 of file Service.hpp.

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

set_port() [1/2]

void dunedaq::confmodel::Service::set_port ( uint16_t value )

inline

Set "port" attribute value.

Parameters

value

new attribute value

Exceptions

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

Definition at line 145 of file Service.hpp.

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

set_port() [2/2]

void dunedaq::confmodel::Service::set_port ( uint16_t value )

inline

Set "port" attribute value.

Parameters

value

new attribute value

Exceptions

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

Definition at line 145 of file Service.hpp.

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

set_protocol() [1/2]

void dunedaq::confmodel::Service::set_protocol ( const std::string & value )

inline

Set "protocol" attribute value.

Parameters

value

new attribute value

Exceptions

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

Definition at line 114 of file Service.hpp.

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

set_protocol() [2/2]

void dunedaq::confmodel::Service::set_protocol ( const std::string & value )

inline

Set "protocol" attribute value.

Parameters

value

new attribute value

Exceptions

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

Definition at line 114 of file Service.hpp.

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

Friends And Related Symbol Documentation

conffwk::Configuration

conffwk::Configuration

friend

Definition at line 22 of file Service.hpp.

conffwk::DalFactory

conffwk::DalFactory

friend

Definition at line 24 of file Service.hpp.

conffwk::DalObject

conffwk::DalObject

friend

Definition at line 23 of file Service.hpp.

conffwk::DalRegistry

conffwk::DalRegistry

friend

Definition at line 25 of file Service.hpp.

Member Data Documentation

m_eth_device_name

std::string dunedaq::confmodel::Service::m_eth_device_name

private

Definition at line 73 of file Service.hpp.

m_path

std::string dunedaq::confmodel::Service::m_path

private

Definition at line 74 of file Service.hpp.

m_port

uint16_t dunedaq::confmodel::Service::m_port

private

Definition at line 72 of file Service.hpp.

m_protocol

std::string dunedaq::confmodel::Service::m_protocol

private

Definition at line 71 of file Service.hpp.

s_class_name

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

static

The name of the configuration class.

Definition at line 37 of file Service.hpp.

s_eth_device_name

static const std::string dunedaq::confmodel::Service::s_eth_device_name = "eth_device_name"

inlinestatic

Definition at line 83 of file Service.hpp.

s_path

static const std::string dunedaq::confmodel::Service::s_path = "path"

inlinestatic

Definition at line 84 of file Service.hpp.

s_port

static const std::string dunedaq::confmodel::Service::s_port = "port"

inlinestatic

Definition at line 82 of file Service.hpp.

s_protocol

static const std::string dunedaq::confmodel::Service::s_protocol = "protocol"

inlinestatic

Definition at line 81 of file Service.hpp.

---

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

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