dunedaq::timinglibs::dal::TimingHardwareManagerConf Class Reference

#include <TimingHardwareManagerConf.hpp>

Inheritance diagram for dunedaq::timinglibs::dal::TimingHardwareManagerConf:

Collaboration diagram for dunedaq::timinglibs::dal::TimingHardwareManagerConf:

Public Member Functions
virtual void	print (unsigned int offset, bool print_header, std::ostream &s) const
	Print details of the TimingHardwareManagerConf 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.
uint32_t	get_gather_interval () const
	Get "gather_interval" attribute value. Hardware device data gather interval [us].
void	set_gather_interval (uint32_t value)
	Set "gather_interval" attribute value. Hardware device data gather interval [us].
uint32_t	get_gather_interval_debug () const
	Get "gather_interval_debug" attribute value. Hardware device data gather debug interval [us].
void	set_gather_interval_debug (uint32_t value)
	Set "gather_interval_debug" attribute value. Hardware device data gather debug interval [us].
const std::string &	get_monitored_device_name_master () const
	Get "monitored_device_name_master" attribute value. Name of timing master device to be monitored.
void	set_monitored_device_name_master (const std::string &value)
	Set "monitored_device_name_master" attribute value. Name of timing master device to be monitored.
const std::string &	get_monitored_device_name_endpoint () const
	Get "monitored_device_name_endpoint" attribute value. Name of timing endpoint device to be monitored.
void	set_monitored_device_name_endpoint (const std::string &value)
	Set "monitored_device_name_endpoint" attribute value. Name of timing endpoint device to be monitored.
const std::string &	get_monitored_device_name_hsi () const
	Get "monitored_device_name_hsi" attribute value. Name of hsi device to be monitored.
void	set_monitored_device_name_hsi (const std::string &value)
	Set "monitored_device_name_hsi" attribute value. Name of hsi device to be monitored.
const std::vector< const dunedaq::timinglibs::dal::TimingFanoutDevice * > &	get_monitored_device_names_fanout () const
	Get "monitored_device_names_fanout" relationship value. Timing fanout devices to be monitored.
void	set_monitored_device_names_fanout (const std::vector< const dunedaq::timinglibs::dal::TimingFanoutDevice * > &value)
	Set "monitored_device_names_fanout" relationship value. Timing fanout devices to be monitored.
virtual void	print (unsigned int offset, bool print_header, std::ostream &s) const
	Print details of the TimingHardwareManagerConf 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.
uint32_t	get_gather_interval () const
	Get "gather_interval" attribute value. Hardware device data gather interval [us].
void	set_gather_interval (uint32_t value)
	Set "gather_interval" attribute value. Hardware device data gather interval [us].
uint32_t	get_gather_interval_debug () const
	Get "gather_interval_debug" attribute value. Hardware device data gather debug interval [us].
void	set_gather_interval_debug (uint32_t value)
	Set "gather_interval_debug" attribute value. Hardware device data gather debug interval [us].
const std::string &	get_monitored_device_name_master () const
	Get "monitored_device_name_master" attribute value. Name of timing master device to be monitored.
void	set_monitored_device_name_master (const std::string &value)
	Set "monitored_device_name_master" attribute value. Name of timing master device to be monitored.
const std::string &	get_monitored_device_name_endpoint () const
	Get "monitored_device_name_endpoint" attribute value. Name of timing endpoint device to be monitored.
void	set_monitored_device_name_endpoint (const std::string &value)
	Set "monitored_device_name_endpoint" attribute value. Name of timing endpoint device to be monitored.
const std::string &	get_monitored_device_name_hsi () const
	Get "monitored_device_name_hsi" attribute value. Name of hsi device to be monitored.
void	set_monitored_device_name_hsi (const std::string &value)
	Set "monitored_device_name_hsi" attribute value. Name of hsi device to be monitored.
const std::vector< const dunedaq::timinglibs::dal::TimingFanoutDevice * > &	get_monitored_device_names_fanout () const
	Get "monitored_device_names_fanout" relationship value. Timing fanout devices to be monitored.
void	set_monitored_device_names_fanout (const std::vector< const dunedaq::timinglibs::dal::TimingFanoutDevice * > &value)
	Set "monitored_device_names_fanout" relationship value. Timing fanout devices to be monitored.
Public Member Functions inherited from dunedaq::timinglibs::dal::TimingHardwareInterfaceConf
const std::string &	get_uhal_log_level () const
	Get "uhal_log_level" attribute value. Log level for uhal.
void	set_uhal_log_level (const std::string &value)
	Set "uhal_log_level" attribute value. Log level for uhal.
const std::string &	get_connections_file () const
	Get "connections_file" attribute value. device connections file.
void	set_connections_file (const std::string &value)
	Set "connections_file" attribute value. device connections file.
const std::string &	get_uhal_log_level () const
	Get "uhal_log_level" attribute value. Log level for uhal.
void	set_uhal_log_level (const std::string &value)
	Set "uhal_log_level" attribute value. Log level for uhal.
const std::string &	get_connections_file () const
	Get "connections_file" attribute value. device connections file.
void	set_connections_file (const std::string &value)
	Set "connections_file" attribute value. device connections file.
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_gather_interval_str () noexcept
static const std::string &	__get_gather_interval_debug_str () noexcept
static const std::string &	__get_monitored_device_name_master_str () noexcept
static const std::string &	__get_monitored_device_name_endpoint_str () noexcept
static const std::string &	__get_monitored_device_name_hsi_str () noexcept
static const std::string &	__get_monitored_device_names_fanout_str () noexcept
static const std::string &	__get_gather_interval_str () noexcept
static const std::string &	__get_gather_interval_debug_str () noexcept
static const std::string &	__get_monitored_device_name_master_str () noexcept
static const std::string &	__get_monitored_device_name_endpoint_str () noexcept
static const std::string &	__get_monitored_device_name_hsi_str () noexcept
static const std::string &	__get_monitored_device_names_fanout_str () noexcept
Static Public Member Functions inherited from dunedaq::timinglibs::dal::TimingHardwareInterfaceConf
static const std::string &	__get_uhal_log_level_str () noexcept
static const std::string &	__get_connections_file_str () noexcept
static const std::string &	__get_uhal_log_level_str () noexcept
static const std::string &	__get_connections_file_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_gather_interval = "gather_interval"
static const std::string	s_gather_interval_debug = "gather_interval_debug"
static const std::string	s_monitored_device_name_master = "monitored_device_name_master"
static const std::string	s_monitored_device_name_endpoint = "monitored_device_name_endpoint"
static const std::string	s_monitored_device_name_hsi = "monitored_device_name_hsi"
static const std::string	s_monitored_device_names_fanout = "monitored_device_names_fanout"
Static Public Attributes inherited from dunedaq::timinglibs::dal::TimingHardwareInterfaceConf
static const std::string &	s_class_name
static const std::string	s_uhal_log_level = "uhal_log_level"
static const std::string	s_connections_file = "connections_file"

Protected Member Functions
	TimingHardwareManagerConf (conffwk::DalRegistry &db, const conffwk::ConfigObject &obj) noexcept
virtual	~TimingHardwareManagerConf () 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
	TimingHardwareManagerConf (conffwk::DalRegistry &db, const conffwk::ConfigObject &obj) noexcept
virtual	~TimingHardwareManagerConf () 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::timinglibs::dal::TimingHardwareInterfaceConf
	TimingHardwareInterfaceConf (conffwk::DalRegistry &db, const conffwk::ConfigObject &obj) noexcept
virtual	~TimingHardwareInterfaceConf () noexcept
bool	get (const std::string &name, std::vector< const dunedaq::conffwk::DalObject * > &vec, bool upcast_unregistered, bool first_call) const
	TimingHardwareInterfaceConf (conffwk::DalRegistry &db, const conffwk::ConfigObject &obj) noexcept
virtual	~TimingHardwareInterfaceConf () 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
uint32_t	m_gather_interval
uint32_t	m_gather_interval_debug
std::string	m_monitored_device_name_master
std::string	m_monitored_device_name_endpoint
std::string	m_monitored_device_name_hsi
std::vector< const dunedaq::timinglibs::dal::TimingFanoutDevice * >	m_monitored_device_names_fanout

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

TimingHardwareManager configuration

Definition at line 39 of file TimingHardwareManagerConf.hpp.

Constructor & Destructor Documentation

TimingHardwareManagerConf() [1/2]

dunedaq::timinglibs::dal::TimingHardwareManagerConf::TimingHardwareManagerConf ( conffwk::DalRegistry & db, const conffwk::ConfigObject & obj )

protectednoexcept

Definition at line 32 of file TimingHardwareManagerConf.cpp.

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

~TimingHardwareManagerConf() [1/2]

dunedaq::timinglibs::dal::TimingHardwareManagerConf::~TimingHardwareManagerConf ( )

protectedvirtualnoexcept

Definition at line 95 of file TimingHardwareManagerConf.cpp.

      {
      }

TimingHardwareManagerConf() [2/2]

dunedaq::timinglibs::dal::TimingHardwareManagerConf::TimingHardwareManagerConf ( conffwk::DalRegistry & db, const conffwk::ConfigObject & obj )

protectednoexcept

~TimingHardwareManagerConf() [2/2]

virtual dunedaq::timinglibs::dal::TimingHardwareManagerConf::~TimingHardwareManagerConf ( )

protectedvirtualnoexcept

Member Function Documentation

__get_gather_interval_debug_str() [1/2]

static const std::string & dunedaq::timinglibs::dal::TimingHardwareManagerConf::__get_gather_interval_debug_str ( )

inlinestaticnoexcept

Definition at line 109 of file TimingHardwareManagerConf.hpp.

{ return s_gather_interval_debug; }

__get_gather_interval_debug_str() [2/2]

static const std::string & dunedaq::timinglibs::dal::TimingHardwareManagerConf::__get_gather_interval_debug_str ( )

inlinestaticnoexcept

Definition at line 109 of file TimingHardwareManagerConf.hpp.

{ return s_gather_interval_debug; }

__get_gather_interval_str() [1/2]

static const std::string & dunedaq::timinglibs::dal::TimingHardwareManagerConf::__get_gather_interval_str ( )

inlinestaticnoexcept

Definition at line 108 of file TimingHardwareManagerConf.hpp.

{ return s_gather_interval; }

__get_gather_interval_str() [2/2]

static const std::string & dunedaq::timinglibs::dal::TimingHardwareManagerConf::__get_gather_interval_str ( )

inlinestaticnoexcept

Definition at line 108 of file TimingHardwareManagerConf.hpp.

{ return s_gather_interval; }

__get_monitored_device_name_endpoint_str() [1/2]

static const std::string & dunedaq::timinglibs::dal::TimingHardwareManagerConf::__get_monitored_device_name_endpoint_str ( )

inlinestaticnoexcept

Definition at line 111 of file TimingHardwareManagerConf.hpp.

{ return s_monitored_device_name_endpoint; }

__get_monitored_device_name_endpoint_str() [2/2]

static const std::string & dunedaq::timinglibs::dal::TimingHardwareManagerConf::__get_monitored_device_name_endpoint_str ( )

inlinestaticnoexcept

Definition at line 111 of file TimingHardwareManagerConf.hpp.

{ return s_monitored_device_name_endpoint; }

__get_monitored_device_name_hsi_str() [1/2]

static const std::string & dunedaq::timinglibs::dal::TimingHardwareManagerConf::__get_monitored_device_name_hsi_str ( )

inlinestaticnoexcept

Definition at line 112 of file TimingHardwareManagerConf.hpp.

{ return s_monitored_device_name_hsi; }

__get_monitored_device_name_hsi_str() [2/2]

static const std::string & dunedaq::timinglibs::dal::TimingHardwareManagerConf::__get_monitored_device_name_hsi_str ( )

inlinestaticnoexcept

Definition at line 112 of file TimingHardwareManagerConf.hpp.

{ return s_monitored_device_name_hsi; }

__get_monitored_device_name_master_str() [1/2]

static const std::string & dunedaq::timinglibs::dal::TimingHardwareManagerConf::__get_monitored_device_name_master_str ( )

inlinestaticnoexcept

Definition at line 110 of file TimingHardwareManagerConf.hpp.

{ return s_monitored_device_name_master; }

__get_monitored_device_name_master_str() [2/2]

static const std::string & dunedaq::timinglibs::dal::TimingHardwareManagerConf::__get_monitored_device_name_master_str ( )

inlinestaticnoexcept

Definition at line 110 of file TimingHardwareManagerConf.hpp.

{ return s_monitored_device_name_master; }

__get_monitored_device_names_fanout_str() [1/2]

static const std::string & dunedaq::timinglibs::dal::TimingHardwareManagerConf::__get_monitored_device_names_fanout_str ( )

inlinestaticnoexcept

Definition at line 284 of file TimingHardwareManagerConf.hpp.

{ return s_monitored_device_names_fanout; }

__get_monitored_device_names_fanout_str() [2/2]

static const std::string & dunedaq::timinglibs::dal::TimingHardwareManagerConf::__get_monitored_device_names_fanout_str ( )

inlinestaticnoexcept

Definition at line 284 of file TimingHardwareManagerConf.hpp.

{ return s_monitored_device_names_fanout; }

get() [1/4]

std::vector< const dunedaq::conffwk::DalObject * > dunedaq::timinglibs::dal::TimingHardwareManagerConf::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::timinglibs::dal::TimingHardwareInterfaceConf.

Definition at line 99 of file TimingHardwareManagerConf.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::timinglibs::dal::TimingHardwareManagerConf::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::timinglibs::dal::TimingHardwareInterfaceConf.

get() [3/4]

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

protected

Definition at line 109 of file TimingHardwareManagerConf.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 (TimingHardwareInterfaceConf::get(name, vec, upcast_unregistered, false)) return true;
 
        if (first_call)
          return get_algo_objects(name, vec);
 
        return false;
      }

get() [4/4]

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

protected

get_gather_interval() [1/2]

uint32_t dunedaq::timinglibs::dal::TimingHardwareManagerConf::get_gather_interval ( ) const

inline

Get "gather_interval" attribute value. Hardware device data gather interval [us].

Returns

the attribute value

Exceptions

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

Definition at line 123 of file TimingHardwareManagerConf.hpp.

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

get_gather_interval() [2/2]

uint32_t dunedaq::timinglibs::dal::TimingHardwareManagerConf::get_gather_interval ( ) const

inline

Get "gather_interval" attribute value. Hardware device data gather interval [us].

Returns

the attribute value

Exceptions

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

Definition at line 123 of file TimingHardwareManagerConf.hpp.

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

get_gather_interval_debug() [1/2]

uint32_t dunedaq::timinglibs::dal::TimingHardwareManagerConf::get_gather_interval_debug ( ) const

inline

Get "gather_interval_debug" attribute value. Hardware device data gather debug interval [us].

Returns

the attribute value

Exceptions

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

Definition at line 156 of file TimingHardwareManagerConf.hpp.

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

get_gather_interval_debug() [2/2]

uint32_t dunedaq::timinglibs::dal::TimingHardwareManagerConf::get_gather_interval_debug ( ) const

inline

Get "gather_interval_debug" attribute value. Hardware device data gather debug interval [us].

Returns

the attribute value

Exceptions

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

Definition at line 156 of file TimingHardwareManagerConf.hpp.

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

get_monitored_device_name_endpoint() [1/2]

const std::string & dunedaq::timinglibs::dal::TimingHardwareManagerConf::get_monitored_device_name_endpoint ( ) const

inline

Get "monitored_device_name_endpoint" attribute value. Name of timing endpoint device to be monitored.

Returns

the attribute value

Exceptions

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

Definition at line 222 of file TimingHardwareManagerConf.hpp.

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

get_monitored_device_name_endpoint() [2/2]

const std::string & dunedaq::timinglibs::dal::TimingHardwareManagerConf::get_monitored_device_name_endpoint ( ) const

inline

Get "monitored_device_name_endpoint" attribute value. Name of timing endpoint device to be monitored.

Returns

the attribute value

Exceptions

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

Definition at line 222 of file TimingHardwareManagerConf.hpp.

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

get_monitored_device_name_hsi() [1/2]

const std::string & dunedaq::timinglibs::dal::TimingHardwareManagerConf::get_monitored_device_name_hsi ( ) const

inline

Get "monitored_device_name_hsi" attribute value. Name of hsi device to be monitored.

Returns

the attribute value

Exceptions

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

Definition at line 255 of file TimingHardwareManagerConf.hpp.

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

get_monitored_device_name_hsi() [2/2]

const std::string & dunedaq::timinglibs::dal::TimingHardwareManagerConf::get_monitored_device_name_hsi ( ) const

inline

Get "monitored_device_name_hsi" attribute value. Name of hsi device to be monitored.

Returns

the attribute value

Exceptions

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

Definition at line 255 of file TimingHardwareManagerConf.hpp.

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

get_monitored_device_name_master() [1/2]

const std::string & dunedaq::timinglibs::dal::TimingHardwareManagerConf::get_monitored_device_name_master ( ) const

inline

Get "monitored_device_name_master" attribute value. Name of timing master device to be monitored.

Returns

the attribute value

Exceptions

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

Definition at line 189 of file TimingHardwareManagerConf.hpp.

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

get_monitored_device_name_master() [2/2]

const std::string & dunedaq::timinglibs::dal::TimingHardwareManagerConf::get_monitored_device_name_master ( ) const

inline

Get "monitored_device_name_master" attribute value. Name of timing master device to be monitored.

Returns

the attribute value

Exceptions

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

Definition at line 189 of file TimingHardwareManagerConf.hpp.

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

get_monitored_device_names_fanout() [1/2]

const std::vector< const dunedaq::timinglibs::dal::TimingFanoutDevice * > & dunedaq::timinglibs::dal::TimingHardwareManagerConf::get_monitored_device_names_fanout ( ) const

inline

Get "monitored_device_names_fanout" relationship value. Timing fanout devices to be monitored.

Returns

the relationship value

Exceptions

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

Definition at line 295 of file TimingHardwareManagerConf.hpp.

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

get_monitored_device_names_fanout() [2/2]

const std::vector< const dunedaq::timinglibs::dal::TimingFanoutDevice * > & dunedaq::timinglibs::dal::TimingHardwareManagerConf::get_monitored_device_names_fanout ( ) const

inline

Get "monitored_device_names_fanout" relationship value. Timing fanout devices to be monitored.

Returns

the relationship value

Exceptions

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

Definition at line 295 of file TimingHardwareManagerConf.hpp.

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

init() [1/2]

void dunedaq::timinglibs::dal::TimingHardwareManagerConf::init ( bool init_children )

protectedvirtual

Initialize object (method generated by genconffwk)

Parameters

init_children

if true, initialize referenced objects

Reimplemented from dunedaq::timinglibs::dal::TimingHardwareInterfaceConf.

Definition at line 76 of file TimingHardwareManagerConf.cpp.

      {
        TimingHardwareInterfaceConf::init(init_children);
 
        TLOG_DEBUG(5) << "read object " << this << " (class " << s_class_name << ')';
 
        try {
          p_obj.get(s_gather_interval, m_gather_interval);
          p_obj.get(s_gather_interval_debug, m_gather_interval_debug);
          p_obj.get(s_monitored_device_name_master, m_monitored_device_name_master);
          p_obj.get(s_monitored_device_name_endpoint, m_monitored_device_name_endpoint);
          p_obj.get(s_monitored_device_name_hsi, m_monitored_device_name_hsi);
          p_registry._ref<dunedaq::timinglibs::dal::TimingFanoutDevice>(p_obj, s_monitored_device_names_fanout, m_monitored_device_names_fanout, init_children);
        }
        catch (dunedaq::conffwk::Exception & ex) {
          throw_init_ex(ex);
        }
      }

init() [2/2]

virtual void dunedaq::timinglibs::dal::TimingHardwareManagerConf::init ( bool init_children )

protectedvirtual

Initialize object (method generated by genconffwk)

Parameters

init_children

if true, initialize referenced objects

Reimplemented from dunedaq::timinglibs::dal::TimingHardwareInterfaceConf.

print() [1/2]

void dunedaq::timinglibs::dal::TimingHardwareManagerConf::print ( unsigned int offset, bool print_header, std::ostream & s ) const

virtual

Print details of the TimingHardwareManagerConf 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::timinglibs::dal::TimingHardwareInterfaceConf.

Definition at line 41 of file TimingHardwareManagerConf.cpp.

      {
        check_init();
 
        try {
          const std::string str(indent+2, ' ');
 
          if (print_header)
            p_hdr(s, indent, s_class_name, "dunedaq::timinglibs::dal");
 
 
            // print direct super-classes
 
          dunedaq::timinglibs::dal::TimingHardwareInterfaceConf::print(indent, false, s);
 
 
            // print direct attributes
 
          dunedaq::conffwk::p_sv_attr(s, str, s_gather_interval, m_gather_interval);
          dunedaq::conffwk::p_sv_attr(s, str, s_gather_interval_debug, m_gather_interval_debug);
          dunedaq::conffwk::p_sv_attr(s, str, s_monitored_device_name_master, m_monitored_device_name_master);
          dunedaq::conffwk::p_sv_attr(s, str, s_monitored_device_name_endpoint, m_monitored_device_name_endpoint);
          dunedaq::conffwk::p_sv_attr(s, str, s_monitored_device_name_hsi, m_monitored_device_name_hsi);
 
 
            // print direct relationships
 
          dunedaq::conffwk::p_mv_rel(s, str, s_monitored_device_names_fanout, m_monitored_device_names_fanout);
        }
        catch (dunedaq::conffwk::Exception & ex) {
          dunedaq::conffwk::DalObject::p_error(s, ex);
        }
      }

print() [2/2]

virtual void dunedaq::timinglibs::dal::TimingHardwareManagerConf::print ( unsigned int offset, bool print_header, std::ostream & s ) const

virtual

Print details of the TimingHardwareManagerConf 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::timinglibs::dal::TimingHardwareInterfaceConf.

set_gather_interval() [1/2]

void dunedaq::timinglibs::dal::TimingHardwareManagerConf::set_gather_interval ( uint32_t value )

inline

Set "gather_interval" attribute value. Hardware device data gather interval [us].

Parameters

value

new attribute value

Exceptions

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

Definition at line 139 of file TimingHardwareManagerConf.hpp.

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

set_gather_interval() [2/2]

void dunedaq::timinglibs::dal::TimingHardwareManagerConf::set_gather_interval ( uint32_t value )

inline

Set "gather_interval" attribute value. Hardware device data gather interval [us].

Parameters

value

new attribute value

Exceptions

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

Definition at line 139 of file TimingHardwareManagerConf.hpp.

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

set_gather_interval_debug() [1/2]

void dunedaq::timinglibs::dal::TimingHardwareManagerConf::set_gather_interval_debug ( uint32_t value )

inline

Set "gather_interval_debug" attribute value. Hardware device data gather debug interval [us].

Parameters

value

new attribute value

Exceptions

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

Definition at line 172 of file TimingHardwareManagerConf.hpp.

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

set_gather_interval_debug() [2/2]

void dunedaq::timinglibs::dal::TimingHardwareManagerConf::set_gather_interval_debug ( uint32_t value )

inline

Set "gather_interval_debug" attribute value. Hardware device data gather debug interval [us].

Parameters

value

new attribute value

Exceptions

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

Definition at line 172 of file TimingHardwareManagerConf.hpp.

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

set_monitored_device_name_endpoint() [1/2]

void dunedaq::timinglibs::dal::TimingHardwareManagerConf::set_monitored_device_name_endpoint ( const std::string & value )

inline

Set "monitored_device_name_endpoint" attribute value. Name of timing endpoint device to be monitored.

Parameters

value

new attribute value

Exceptions

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

Definition at line 238 of file TimingHardwareManagerConf.hpp.

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

set_monitored_device_name_endpoint() [2/2]

void dunedaq::timinglibs::dal::TimingHardwareManagerConf::set_monitored_device_name_endpoint ( const std::string & value )

inline

Set "monitored_device_name_endpoint" attribute value. Name of timing endpoint device to be monitored.

Parameters

value

new attribute value

Exceptions

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

Definition at line 238 of file TimingHardwareManagerConf.hpp.

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

set_monitored_device_name_hsi() [1/2]

void dunedaq::timinglibs::dal::TimingHardwareManagerConf::set_monitored_device_name_hsi ( const std::string & value )

inline

Set "monitored_device_name_hsi" attribute value. Name of hsi device to be monitored.

Parameters

value

new attribute value

Exceptions

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

Definition at line 271 of file TimingHardwareManagerConf.hpp.

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

set_monitored_device_name_hsi() [2/2]

void dunedaq::timinglibs::dal::TimingHardwareManagerConf::set_monitored_device_name_hsi ( const std::string & value )

inline

Set "monitored_device_name_hsi" attribute value. Name of hsi device to be monitored.

Parameters

value

new attribute value

Exceptions

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

Definition at line 271 of file TimingHardwareManagerConf.hpp.

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

set_monitored_device_name_master() [1/2]

void dunedaq::timinglibs::dal::TimingHardwareManagerConf::set_monitored_device_name_master ( const std::string & value )

inline

Set "monitored_device_name_master" attribute value. Name of timing master device to be monitored.

Parameters

value

new attribute value

Exceptions

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

Definition at line 205 of file TimingHardwareManagerConf.hpp.

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

set_monitored_device_name_master() [2/2]

void dunedaq::timinglibs::dal::TimingHardwareManagerConf::set_monitored_device_name_master ( const std::string & value )

inline

Set "monitored_device_name_master" attribute value. Name of timing master device to be monitored.

Parameters

value

new attribute value

Exceptions

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

Definition at line 205 of file TimingHardwareManagerConf.hpp.

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

set_monitored_device_names_fanout() [1/2]

void dunedaq::timinglibs::dal::TimingHardwareManagerConf::set_monitored_device_names_fanout

(

const std::vector< const dunedaq::timinglibs::dal::TimingFanoutDevice * > &

value

)

Set "monitored_device_names_fanout" relationship value. Timing fanout devices to be monitored.

Parameters

value

new relationship value

Exceptions

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

Definition at line 130 of file TimingHardwareManagerConf.cpp.

      {
        _set_objects(s_monitored_device_names_fanout, value);
      }

set_monitored_device_names_fanout() [2/2]

void dunedaq::timinglibs::dal::TimingHardwareManagerConf::set_monitored_device_names_fanout

(

const std::vector< const dunedaq::timinglibs::dal::TimingFanoutDevice * > &

value

)

Set "monitored_device_names_fanout" relationship value. Timing fanout devices to be monitored.

Parameters

value

new relationship value

Exceptions

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

Friends And Related Symbol Documentation

conffwk::Configuration

conffwk::Configuration

friend

Definition at line 41 of file TimingHardwareManagerConf.hpp.

conffwk::DalFactory

conffwk::DalFactory

friend

Definition at line 43 of file TimingHardwareManagerConf.hpp.

conffwk::DalObject

conffwk::DalObject

friend

Definition at line 42 of file TimingHardwareManagerConf.hpp.

conffwk::DalRegistry

conffwk::DalRegistry

friend

Definition at line 44 of file TimingHardwareManagerConf.hpp.

Member Data Documentation

m_gather_interval

uint32_t dunedaq::timinglibs::dal::TimingHardwareManagerConf::m_gather_interval

private

Definition at line 90 of file TimingHardwareManagerConf.hpp.

m_gather_interval_debug

uint32_t dunedaq::timinglibs::dal::TimingHardwareManagerConf::m_gather_interval_debug

private

Definition at line 91 of file TimingHardwareManagerConf.hpp.

m_monitored_device_name_endpoint

std::string dunedaq::timinglibs::dal::TimingHardwareManagerConf::m_monitored_device_name_endpoint

private

Definition at line 93 of file TimingHardwareManagerConf.hpp.

m_monitored_device_name_hsi

std::string dunedaq::timinglibs::dal::TimingHardwareManagerConf::m_monitored_device_name_hsi

private

Definition at line 94 of file TimingHardwareManagerConf.hpp.

m_monitored_device_name_master

std::string dunedaq::timinglibs::dal::TimingHardwareManagerConf::m_monitored_device_name_master

private

Definition at line 92 of file TimingHardwareManagerConf.hpp.

m_monitored_device_names_fanout

std::vector< const dunedaq::timinglibs::dal::TimingFanoutDevice * > dunedaq::timinglibs::dal::TimingHardwareManagerConf::m_monitored_device_names_fanout

private

Definition at line 95 of file TimingHardwareManagerConf.hpp.

s_class_name

static const std::string & dunedaq::timinglibs::dal::TimingHardwareManagerConf::s_class_name

static

The name of the configuration class.

Definition at line 56 of file TimingHardwareManagerConf.hpp.

s_gather_interval

static const std::string dunedaq::timinglibs::dal::TimingHardwareManagerConf::s_gather_interval = "gather_interval"

inlinestatic

Definition at line 102 of file TimingHardwareManagerConf.hpp.

s_gather_interval_debug

static const std::string dunedaq::timinglibs::dal::TimingHardwareManagerConf::s_gather_interval_debug = "gather_interval_debug"

inlinestatic

Definition at line 103 of file TimingHardwareManagerConf.hpp.

s_monitored_device_name_endpoint

static const std::string dunedaq::timinglibs::dal::TimingHardwareManagerConf::s_monitored_device_name_endpoint = "monitored_device_name_endpoint"

inlinestatic

Definition at line 105 of file TimingHardwareManagerConf.hpp.

s_monitored_device_name_hsi

static const std::string dunedaq::timinglibs::dal::TimingHardwareManagerConf::s_monitored_device_name_hsi = "monitored_device_name_hsi"

inlinestatic

Definition at line 106 of file TimingHardwareManagerConf.hpp.

s_monitored_device_name_master

static const std::string dunedaq::timinglibs::dal::TimingHardwareManagerConf::s_monitored_device_name_master = "monitored_device_name_master"

inlinestatic

Definition at line 104 of file TimingHardwareManagerConf.hpp.

s_monitored_device_names_fanout

static const std::string dunedaq::timinglibs::dal::TimingHardwareManagerConf::s_monitored_device_names_fanout = "monitored_device_names_fanout"

inlinestatic

Definition at line 282 of file TimingHardwareManagerConf.hpp.

---

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

• /github/workspace/dunedaq/build/timinglibs/codegen/include/timinglibs/dal/TimingHardwareManagerConf.hpp
• /github/workspace/dunedaq/build/timinglibs/codegen/src/TimingHardwareManagerConf.hpp
• /github/workspace/dunedaq/build/timinglibs/codegen/src/TimingHardwareManagerConf.cpp