dunedaq::appmodel::DaphneConf Class Reference

#include <DaphneConf.hpp>

Inheritance diagram for dunedaq::appmodel::DaphneConf:

Collaboration diagram for dunedaq::appmodel::DaphneConf:

Public Member Functions
virtual void	print (unsigned int offset, bool print_header, std::ostream &s) const
	Print details of the DaphneConf 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.
uint16_t	get_timeout_ms () const
	Get "timeout_ms" attribute value. timeout used for the board operations.
void	set_timeout_ms (uint16_t value)
	Set "timeout_ms" attribute value. timeout used for the board operations.
const std::string &	get_json_file () const
	Get "json_file" attribute value.
void	set_json_file (const std::string &value)
	Set "json_file" attribute value.
const dunedaq::appmodel::DaphneV2BoardConf *	get_default_v2_settings () const
	Get "default_v2_settings" relationship value. Value to be used during scrap.
void	set_default_v2_settings (const dunedaq::appmodel::DaphneV2BoardConf *value)
	Set "default_v2_settings" relationship value. Value to be used during scrap.
std::chrono::milliseconds	get_timeout () const
nlohmann::json	get_json () const
uint16_t	get_board_slot (const std::string &ip) const
virtual void	print (unsigned int offset, bool print_header, std::ostream &s) const
	Print details of the DaphneConf 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.
uint16_t	get_timeout_ms () const
	Get "timeout_ms" attribute value. timeout used for the board operations.
void	set_timeout_ms (uint16_t value)
	Set "timeout_ms" attribute value. timeout used for the board operations.
const std::string &	get_json_file () const
	Get "json_file" attribute value.
void	set_json_file (const std::string &value)
	Set "json_file" attribute value.
const dunedaq::appmodel::DaphneV2BoardConf *	get_default_v2_settings () const
	Get "default_v2_settings" relationship value. Value to be used during scrap.
void	set_default_v2_settings (const dunedaq::appmodel::DaphneV2BoardConf *value)
	Set "default_v2_settings" relationship value. Value to be used during scrap.
std::chrono::milliseconds	get_timeout () const
nlohmann::json	get_json () const
uint16_t	get_board_slot (const std::string &ip) const
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_timeout_ms_str () noexcept
static const std::string &	__get_json_file_str () noexcept
static const std::string &	__get_default_v2_settings_str () noexcept
static const std::string &	__get_timeout_ms_str () noexcept
static const std::string &	__get_json_file_str () noexcept
static const std::string &	__get_default_v2_settings_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_timeout_ms = "timeout_ms"
static const std::string	s_json_file = "json_file"
static const std::string	s_default_v2_settings = "default_v2_settings"

Protected Member Functions
	DaphneConf (conffwk::DalRegistry &db, const conffwk::ConfigObject &obj) noexcept
virtual	~DaphneConf () 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
	DaphneConf (conffwk::DalRegistry &db, const conffwk::ConfigObject &obj) noexcept
virtual	~DaphneConf () 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
uint16_t	m_timeout_ms
std::string	m_json_file
const dunedaq::appmodel::DaphneV2BoardConf *	m_default_v2_settings

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

Top entry for the configuraiton of a single daphne board

Definition at line 41 of file DaphneConf.hpp.

Constructor & Destructor Documentation

DaphneConf() [1/2]

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

protectednoexcept

Definition at line 31 of file DaphneConf.cpp.

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

~DaphneConf() [1/2]

dunedaq::appmodel::DaphneConf::~DaphneConf ( )

protectedvirtualnoexcept

Definition at line 83 of file DaphneConf.cpp.

    {
    }

DaphneConf() [2/2]

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

protectednoexcept

~DaphneConf() [2/2]

virtual dunedaq::appmodel::DaphneConf::~DaphneConf ( )

protectedvirtualnoexcept

Member Function Documentation

__get_default_v2_settings_str() [1/2]

static const std::string & dunedaq::appmodel::DaphneConf::__get_default_v2_settings_str ( )

inlinestaticnoexcept

Definition at line 176 of file DaphneConf.hpp.

{ return s_default_v2_settings; }

__get_default_v2_settings_str() [2/2]

static const std::string & dunedaq::appmodel::DaphneConf::__get_default_v2_settings_str ( )

inlinestaticnoexcept

Definition at line 176 of file DaphneConf.hpp.

{ return s_default_v2_settings; }

__get_json_file_str() [1/2]

static const std::string & dunedaq::appmodel::DaphneConf::__get_json_file_str ( )

inlinestaticnoexcept

Definition at line 105 of file DaphneConf.hpp.

{ return s_json_file; }

__get_json_file_str() [2/2]

static const std::string & dunedaq::appmodel::DaphneConf::__get_json_file_str ( )

inlinestaticnoexcept

Definition at line 105 of file DaphneConf.hpp.

{ return s_json_file; }

__get_timeout_ms_str() [1/2]

static const std::string & dunedaq::appmodel::DaphneConf::__get_timeout_ms_str ( )

inlinestaticnoexcept

Definition at line 104 of file DaphneConf.hpp.

{ return s_timeout_ms; }

__get_timeout_ms_str() [2/2]

static const std::string & dunedaq::appmodel::DaphneConf::__get_timeout_ms_str ( )

inlinestaticnoexcept

Definition at line 104 of file DaphneConf.hpp.

{ return s_timeout_ms; }

get() [1/4]

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

protected

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

protected

get_board_slot() [1/2]

uint16_t dunedaq::appmodel::DaphneConf::get_board_slot

(

const std::string &

ip

)

const

Get the board slot from the IP

Definition at line 228 of file DaphneApplication.cpp.

                                                              {
 
  auto conf_dict = get_json();
  auto it = conf_dict.find(ip);
  if ( it == conf_dict.end() ) {
    throw MissingIP(ERS_HERE, ip);
  }
 
  return it->at("slot").get<uint16_t>();
}

get_board_slot() [2/2]

uint16_t dunedaq::appmodel::DaphneConf::get_board_slot

(

const std::string &

ip

)

const

Get the board slot from the IP

get_default_v2_settings() [1/2]

const dunedaq::appmodel::DaphneV2BoardConf * dunedaq::appmodel::DaphneConf::get_default_v2_settings ( ) const

inline

Get "default_v2_settings" relationship value. Value to be used during scrap.

Returns

the relationship value

Exceptions

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

Definition at line 187 of file DaphneConf.hpp.

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

get_default_v2_settings() [2/2]

const dunedaq::appmodel::DaphneV2BoardConf * dunedaq::appmodel::DaphneConf::get_default_v2_settings ( ) const

inline

Get "default_v2_settings" relationship value. Value to be used during scrap.

Returns

the relationship value

Exceptions

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

Definition at line 187 of file DaphneConf.hpp.

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

get_json() [1/2]

nlohmann::json dunedaq::appmodel::DaphneConf::get_json

(

)

const

Getter to cast the configuration into a json

Definition at line 136 of file DaphneConf.cpp.

    {
return nlohmann::json::parse(get_json_file());
    }

get_json() [2/2]

nlohmann::json dunedaq::appmodel::DaphneConf::get_json

(

)

const

Getter to cast the configuration into a json

get_json_file() [1/2]

const std::string & dunedaq::appmodel::DaphneConf::get_json_file ( ) const

inline

Get "json_file" attribute value.

Returns

the attribute value

Exceptions

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

Definition at line 148 of file DaphneConf.hpp.

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

get_json_file() [2/2]

const std::string & dunedaq::appmodel::DaphneConf::get_json_file ( ) const

inline

Get "json_file" attribute value.

Returns

the attribute value

Exceptions

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

Definition at line 148 of file DaphneConf.hpp.

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

get_timeout() [1/2]

std::chrono::milliseconds dunedaq::appmodel::DaphneConf::get_timeout

(

)

const

get the interval casted in ms

Definition at line 127 of file DaphneConf.cpp.

    {
return std::chrono::milliseconds(get_timeout_ms());
    }

get_timeout() [2/2]

std::chrono::milliseconds dunedaq::appmodel::DaphneConf::get_timeout

(

)

const

get the interval casted in ms

get_timeout_ms() [1/2]

uint16_t dunedaq::appmodel::DaphneConf::get_timeout_ms ( ) const

inline

Get "timeout_ms" attribute value. timeout used for the board operations.

Returns

the attribute value

Exceptions

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

Definition at line 116 of file DaphneConf.hpp.

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

get_timeout_ms() [2/2]

uint16_t dunedaq::appmodel::DaphneConf::get_timeout_ms ( ) const

inline

Get "timeout_ms" attribute value. timeout used for the board operations.

Returns

the attribute value

Exceptions

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

Definition at line 116 of file DaphneConf.hpp.

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

init() [1/2]

void dunedaq::appmodel::DaphneConf::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 67 of file DaphneConf.cpp.

    {
      p_was_read = true;
      increment_read();
      TLOG_DEBUG(5) << "read object " << this << " (class " << s_class_name << ')';
 
      try {
        p_obj.get(s_timeout_ms, m_timeout_ms);
        p_obj.get(s_json_file, m_json_file);
        m_default_v2_settings = p_registry._ref<dunedaq::appmodel::DaphneV2BoardConf>(p_obj, s_default_v2_settings, init_children);
      }
      catch (dunedaq::conffwk::Exception & ex) {
        throw_init_ex(ex);
      }
    }

init() [2/2]

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

virtual

Print details of the DaphneConf 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 DaphneConf.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_timeout_ms, m_timeout_ms);
        dunedaq::conffwk::p_sv_attr(s, str, s_json_file, m_json_file);
 
 
          // print direct relationships
 
        dunedaq::conffwk::p_sv_rel(s, str, s_default_v2_settings, m_default_v2_settings);
      }
      catch (dunedaq::conffwk::Exception & ex) {
        dunedaq::conffwk::DalObject::p_error(s, ex);
      }
    }

print() [2/2]

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

virtual

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

void dunedaq::appmodel::DaphneConf::set_default_v2_settings

(

const dunedaq::appmodel::DaphneV2BoardConf *

value

)

Set "default_v2_settings" relationship value. Value to be used during scrap.

Parameters

value

new relationship value

Exceptions

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

Definition at line 116 of file DaphneConf.cpp.

    {
      _set_object(s_default_v2_settings, value);
    }

set_default_v2_settings() [2/2]

void dunedaq::appmodel::DaphneConf::set_default_v2_settings

(

const dunedaq::appmodel::DaphneV2BoardConf *

value

)

Set "default_v2_settings" relationship value. Value to be used during scrap.

Parameters

value

new relationship value

Exceptions

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

set_json_file() [1/2]

void dunedaq::appmodel::DaphneConf::set_json_file ( const std::string & value )

inline

Set "json_file" attribute value.

Parameters

value

new attribute value

Exceptions

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

Definition at line 163 of file DaphneConf.hpp.

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

set_json_file() [2/2]

void dunedaq::appmodel::DaphneConf::set_json_file ( const std::string & value )

inline

Set "json_file" attribute value.

Parameters

value

new attribute value

Exceptions

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

Definition at line 163 of file DaphneConf.hpp.

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

set_timeout_ms() [1/2]

void dunedaq::appmodel::DaphneConf::set_timeout_ms ( uint16_t value )

inline

Set "timeout_ms" attribute value. timeout used for the board operations.

Parameters

value

new attribute value

Exceptions

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

Definition at line 132 of file DaphneConf.hpp.

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

set_timeout_ms() [2/2]

void dunedaq::appmodel::DaphneConf::set_timeout_ms ( uint16_t value )

inline

Set "timeout_ms" attribute value. timeout used for the board operations.

Parameters

value

new attribute value

Exceptions

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

Definition at line 132 of file DaphneConf.hpp.

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

Friends And Related Symbol Documentation

conffwk::Configuration

conffwk::Configuration

friend

Definition at line 43 of file DaphneConf.hpp.

conffwk::DalFactory

conffwk::DalFactory

friend

Definition at line 45 of file DaphneConf.hpp.

conffwk::DalObject

conffwk::DalObject

friend

Definition at line 44 of file DaphneConf.hpp.

conffwk::DalRegistry

conffwk::DalRegistry

friend

Definition at line 46 of file DaphneConf.hpp.

Member Data Documentation

m_default_v2_settings

const dunedaq::appmodel::DaphneV2BoardConf * dunedaq::appmodel::DaphneConf::m_default_v2_settings

private

Definition at line 94 of file DaphneConf.hpp.

m_json_file

std::string dunedaq::appmodel::DaphneConf::m_json_file

private

Definition at line 93 of file DaphneConf.hpp.

m_timeout_ms

uint16_t dunedaq::appmodel::DaphneConf::m_timeout_ms

private

Definition at line 92 of file DaphneConf.hpp.

s_class_name

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

static

The name of the configuration class.

Definition at line 58 of file DaphneConf.hpp.

s_default_v2_settings

static const std::string dunedaq::appmodel::DaphneConf::s_default_v2_settings = "default_v2_settings"

inlinestatic

Definition at line 174 of file DaphneConf.hpp.

s_json_file

static const std::string dunedaq::appmodel::DaphneConf::s_json_file = "json_file"

inlinestatic

Definition at line 102 of file DaphneConf.hpp.

s_timeout_ms

static const std::string dunedaq::appmodel::DaphneConf::s_timeout_ms = "timeout_ms"

inlinestatic

Definition at line 101 of file DaphneConf.hpp.

---

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

• /github/workspace/dunedaq/build/appmodel/codegen/include/appmodel/DaphneConf.hpp
• /github/workspace/dunedaq/build/appmodel/codegen/src/DaphneConf.hpp
• /github/workspace/dunedaq/sourcecode/appmodel/src/DaphneApplication.cpp
• /github/workspace/dunedaq/build/appmodel/codegen/src/DaphneConf.cpp