#include <NetworkDevice.hpp>

Inheritance diagram for dunedaq::confmodel::NetworkDevice:

Collaboration diagram for dunedaq::confmodel::NetworkDevice:

Public Member Functions
virtual void	print (unsigned int offset, bool print_header, std::ostream &s) const
	Print details of the NetworkDevice 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_pcie_addr () const
	Get "pcie_addr" attribute value. PCIe address of NIC on readout host.

void	set_pcie_addr (const std::string &value)
	Set "pcie_addr" attribute value. PCIe address of NIC on readout host.

virtual void	print (unsigned int offset, bool print_header, std::ostream &s) const
	Print details of the NetworkDevice 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_pcie_addr () const
	Get "pcie_addr" attribute value. PCIe address of NIC on readout host.

void	set_pcie_addr (const std::string &value)
	Set "pcie_addr" attribute value. PCIe address of NIC on readout host.

Public Member Functions inherited from dunedaq::confmodel::HostComponent
uint8_t	get_numa_id () const
	Get "numa_id" attribute value.

void	set_numa_id (uint8_t value)
	Set "numa_id" attribute value.

uint8_t	get_numa_id () const
	Get "numa_id" attribute value.

void	set_numa_id (uint8_t value)
	Set "numa_id" 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.

Public Member Functions inherited from dunedaq::confmodel::NetworkInterface
const std::string &	get_mac_address () const
	Get "mac_address" attribute value. Destination MAC address on readout host.

void	set_mac_address (const std::string &value)
	Set "mac_address" attribute value. Destination MAC address on readout host.

const std::vector< std::string > &	get_ip_address () const
	Get "ip_address" attribute value. IP address in form a.b.c.d.

void	set_ip_address (const std::vector< std::string > &value)
	Set "ip_address" attribute value. IP address in form a.b.c.d.

const std::string &	get_interface_name () const
	Get "interface_name" attribute value. Name of interface e.g. eth0 or eno1.

void	set_interface_name (const std::string &value)
	Set "interface_name" attribute value. Name of interface e.g. eth0 or eno1.

const std::string &	get_network_mask () const
	Get "network_mask" attribute value. Network mask in for a.b.c.d.

void	set_network_mask (const std::string &value)
	Set "network_mask" attribute value. Network mask in for a.b.c.d.

const std::string &	get_network_name () const
	Get "network_name" attribute value. Name of network on this interface Control or Data.

void	set_network_name (const std::string &value)
	Set "network_name" attribute value. Name of network on this interface Control or Data.

const std::string &	get_mac_address () const
	Get "mac_address" attribute value. Destination MAC address on readout host.

void	set_mac_address (const std::string &value)
	Set "mac_address" attribute value. Destination MAC address on readout host.

const std::vector< std::string > &	get_ip_address () const
	Get "ip_address" attribute value. IP address in form a.b.c.d.

void	set_ip_address (const std::vector< std::string > &value)
	Set "ip_address" attribute value. IP address in form a.b.c.d.

const std::string &	get_interface_name () const
	Get "interface_name" attribute value. Name of interface e.g. eth0 or eno1.

void	set_interface_name (const std::string &value)
	Set "interface_name" attribute value. Name of interface e.g. eth0 or eno1.

const std::string &	get_network_mask () const
	Get "network_mask" attribute value. Network mask in for a.b.c.d.

void	set_network_mask (const std::string &value)
	Set "network_mask" attribute value. Network mask in for a.b.c.d.

const std::string &	get_network_name () const
	Get "network_name" attribute value. Name of network on this interface Control or Data.

void	set_network_name (const std::string &value)
	Set "network_name" attribute value. Name of network on this interface Control or Data.

Static Public Member Functions
static const std::string &	__get_pcie_addr_str () noexcept

static const std::string &	__get_pcie_addr_str () noexcept

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

static const std::string &	__get_numa_id_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 Member Functions inherited from dunedaq::confmodel::NetworkInterface
static const std::string &	__get_mac_address_str () noexcept

static const std::string &	__get_ip_address_str () noexcept

static const std::string &	__get_interface_name_str () noexcept

static const std::string &	__get_network_mask_str () noexcept

static const std::string &	__get_network_name_str () noexcept

static const std::string &	__get_mac_address_str () noexcept

static const std::string &	__get_ip_address_str () noexcept

static const std::string &	__get_interface_name_str () noexcept

static const std::string &	__get_network_mask_str () noexcept

static const std::string &	__get_network_name_str () noexcept

Static Public Attributes
static const std::string &	s_class_name

static const std::string	s_pcie_addr = "pcie_addr"

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

static const std::string	s_numa_id = "numa_id"

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

static const std::string	s_mac_address = "mac_address"

static const std::string	s_ip_address = "ip_address"

static const std::string	s_interface_name = "interface_name"

static const std::string	s_network_mask = "network_mask"

static const std::string	s_network_name = "network_name"

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

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

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

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

virtual	~HostComponent () noexcept

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

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

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

Protected Member Functions inherited from dunedaq::confmodel::NetworkInterface
	NetworkInterface (conffwk::DalRegistry &db, const conffwk::ConfigObject &obj) noexcept

virtual	~NetworkInterface () noexcept

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

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

virtual	~NetworkInterface () noexcept

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

Private Attributes
std::string	m_pcie_addr

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 24 of file NetworkDevice.hpp.

Constructor & Destructor Documentation

◆ NetworkDevice() [1/2]

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

protectednoexcept

Definition at line 26 of file NetworkDevice.cpp.

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

◆ ~NetworkDevice() [1/2]

dunedaq::confmodel::NetworkDevice::~NetworkDevice ( )

protectedvirtualnoexcept

Definition at line 78 of file NetworkDevice.cpp.

79 {

80 }

◆ NetworkDevice() [2/2]

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

protectednoexcept

◆ ~NetworkDevice() [2/2]

virtual dunedaq::confmodel::NetworkDevice::~NetworkDevice ( )

protectedvirtualnoexcept

Member Function Documentation

◆ __get_pcie_addr_str() [1/2]

static const std::string & dunedaq::confmodel::NetworkDevice::__get_pcie_addr_str ( )

inlinestaticnoexcept

Definition at line 84 of file NetworkDevice.hpp.

84{ return s_pcie_addr; }

dunedaq::confmodel::NetworkDevice::s_pcie_addr

static const std::string s_pcie_addr

Definition NetworkDevice.hpp:82

◆ __get_pcie_addr_str() [2/2]

static const std::string & dunedaq::confmodel::NetworkDevice::__get_pcie_addr_str ( )

inlinestaticnoexcept

Definition at line 84 of file NetworkDevice.hpp.

84{ return s_pcie_addr; }

◆ get() [1/4]

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

Definition at line 82 of file NetworkDevice.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::NetworkDevice::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::HostComponent.

◆ get() [3/4]

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

protected

Definition at line 92 of file NetworkDevice.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 (HostComponent::get(name, vec, upcast_unregistered, false)) return true;
      if (NetworkInterface::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::NetworkDevice::get	(	const std::string &	name,
		std::vector< const dunedaq::conffwk::DalObject * > &	vec,
		bool	upcast_unregistered,
		bool	first_call ) const

protected

◆ get_pcie_addr() [1/2]

const std::string & dunedaq::confmodel::NetworkDevice::get_pcie_addr ( ) const

inline

Get "pcie_addr" attribute value. PCIe address of NIC on readout host.

Returns: the attribute value

Exceptions

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

Definition at line 95 of file NetworkDevice.hpp.

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

◆ get_pcie_addr() [2/2]

const std::string & dunedaq::confmodel::NetworkDevice::get_pcie_addr ( ) const

inline

Get "pcie_addr" attribute value. PCIe address of NIC on readout host.

Returns: the attribute value

Exceptions

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

Definition at line 95 of file NetworkDevice.hpp.

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

◆ init() [1/2]

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

protectedvirtual

Initialize object (method generated by genconffwk)

Parameters

init_children if true, initialize referenced objects

Reimplemented from dunedaq::confmodel::HostComponent.

Definition at line 63 of file NetworkDevice.cpp.

    {
      HostComponent::init(init_children);
      NetworkInterface::init(init_children);
 
      TLOG_DEBUG(5) << "read object " << this << " (class " << s_class_name << ')';
 
      try {
        p_obj.get(s_pcie_addr, m_pcie_addr);
      }
      catch (dunedaq::conffwk::Exception & ex) {
        throw_init_ex(ex);
      }
    }

◆ init() [2/2]

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

protectedvirtual

Initialize object (method generated by genconffwk)

Parameters

init_children if true, initialize referenced objects

Reimplemented from dunedaq::confmodel::HostComponent.

◆ print() [1/2]

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

virtual

Print details of the NetworkDevice 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::HostComponent.

Definition at line 36 of file NetworkDevice.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::HostComponent::print(indent, false, s);
        dunedaq::confmodel::NetworkInterface::print(indent, false, s);
 
 
          // print direct attributes
 
        dunedaq::conffwk::p_sv_attr(s, str, s_pcie_addr, m_pcie_addr);
      }
      catch (dunedaq::conffwk::Exception & ex) {
        dunedaq::conffwk::DalObject::p_error(s, ex);
      }
    }

◆ print() [2/2]

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

virtual

Print details of the NetworkDevice 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::HostComponent.

◆ set_pcie_addr() [1/2]

void dunedaq::confmodel::NetworkDevice::set_pcie_addr ( const std::string & value )

inline

Set "pcie_addr" attribute value. PCIe address of NIC on readout host.

Parameters

value new attribute value

Exceptions

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

Definition at line 111 of file NetworkDevice.hpp.

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

◆ set_pcie_addr() [2/2]

void dunedaq::confmodel::NetworkDevice::set_pcie_addr ( const std::string & value )

inline

Set "pcie_addr" attribute value. PCIe address of NIC on readout host.

Parameters

value new attribute value

Exceptions

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

Definition at line 111 of file NetworkDevice.hpp.

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

Friends And Related Symbol Documentation

◆ conffwk::Configuration

conffwk::Configuration

friend

Definition at line 26 of file NetworkDevice.hpp.

◆ conffwk::DalFactory

conffwk::DalFactory

friend

Definition at line 28 of file NetworkDevice.hpp.

◆ conffwk::DalObject

conffwk::DalObject

friend

Definition at line 27 of file NetworkDevice.hpp.

◆ conffwk::DalRegistry

conffwk::DalRegistry

friend

Definition at line 29 of file NetworkDevice.hpp.

Member Data Documentation

◆ m_pcie_addr

std::string dunedaq::confmodel::NetworkDevice::m_pcie_addr

private

Definition at line 75 of file NetworkDevice.hpp.

◆ s_class_name

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

static

The name of the configuration class.

Definition at line 41 of file NetworkDevice.hpp.

◆ s_pcie_addr

static const std::string dunedaq::confmodel::NetworkDevice::s_pcie_addr = "pcie_addr"

inlinestatic

Definition at line 82 of file NetworkDevice.hpp.

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

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

◆ NetworkDevice() [1/2]

◆ ~NetworkDevice() [1/2]

◆ NetworkDevice() [2/2]

◆ ~NetworkDevice() [2/2]

Member Function Documentation

◆ __get_pcie_addr_str() [1/2]

◆ __get_pcie_addr_str() [2/2]

◆ get() [1/4]

◆ get() [2/4]

◆ get() [3/4]

◆ get() [4/4]

◆ get_pcie_addr() [1/2]

◆ get_pcie_addr() [2/2]

◆ init() [1/2]

◆ init() [2/2]

◆ print() [1/2]

◆ print() [2/2]

◆ set_pcie_addr() [1/2]

◆ set_pcie_addr() [2/2]

Friends And Related Symbol Documentation

◆ conffwk::Configuration

◆ conffwk::DalFactory

◆ conffwk::DalObject

◆ conffwk::DalRegistry

Member Data Documentation

◆ m_pcie_addr

◆ s_class_name

◆ s_pcie_addr