dunedaq::timinglibs::dal::TimingFanoutControllerConf Class Reference

#include <TimingFanoutControllerConf.hpp>

Inheritance diagram for dunedaq::timinglibs::dal::TimingFanoutControllerConf:

Collaboration diagram for dunedaq::timinglibs::dal::TimingFanoutControllerConf:

Public Member Functions
virtual void	print (unsigned int offset, bool print_header, std::ostream &s) const
	Print details of the TimingFanoutControllerConf 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_device_ready_timeout () const
	Get "device_ready_timeout" attribute value.
void	set_device_ready_timeout (uint32_t value)
	Set "device_ready_timeout" attribute value.
virtual void	print (unsigned int offset, bool print_header, std::ostream &s) const
	Print details of the TimingFanoutControllerConf 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_device_ready_timeout () const
	Get "device_ready_timeout" attribute value.
void	set_device_ready_timeout (uint32_t value)
	Set "device_ready_timeout" attribute value.
Public Member Functions inherited from dunedaq::timinglibs::dal::TimingControllerConf
const std::string &	get_device () const
	Get "device" attribute value. String of managed device name.
void	set_device (const std::string &value)
	Set "device" attribute value. String of managed device name.
bool	get_hardware_state_recovery_enabled () const
	Get "hardware_state_recovery_enabled" attribute value. Control flag for hardware state recovery.
void	set_hardware_state_recovery_enabled (bool value)
	Set "hardware_state_recovery_enabled" attribute value. Control flag for hardware state recovery.
const std::string &	get_timing_session_name () const
	Get "timing_session_name" attribute value. Name of managed device timing session.
void	set_timing_session_name (const std::string &value)
	Set "timing_session_name" attribute value. Name of managed device timing session.
uint32_t	get_clock_source () const
	Get "clock_source" attribute value. Clock source, 0 for PLL input 0, 1 for in 1, etc.. 255 for free run mode.
void	set_clock_source (uint32_t value)
	Set "clock_source" attribute value. Clock source, 0 for PLL input 0, 1 for in 1, etc.. 255 for free run mode.
const std::string &	get_clock_config () const
	Get "clock_config" attribute value. Path of clock config file.
void	set_clock_config (const std::string &value)
	Set "clock_config" attribute value. Path of clock config file.
bool	get_soft () const
	Get "soft" attribute value. Soft reset.
void	set_soft (bool value)
	Set "soft" attribute value. Soft reset.
const std::string &	get_device () const
	Get "device" attribute value. String of managed device name.
void	set_device (const std::string &value)
	Set "device" attribute value. String of managed device name.
bool	get_hardware_state_recovery_enabled () const
	Get "hardware_state_recovery_enabled" attribute value. Control flag for hardware state recovery.
void	set_hardware_state_recovery_enabled (bool value)
	Set "hardware_state_recovery_enabled" attribute value. Control flag for hardware state recovery.
const std::string &	get_timing_session_name () const
	Get "timing_session_name" attribute value. Name of managed device timing session.
void	set_timing_session_name (const std::string &value)
	Set "timing_session_name" attribute value. Name of managed device timing session.
uint32_t	get_clock_source () const
	Get "clock_source" attribute value. Clock source, 0 for PLL input 0, 1 for in 1, etc.. 255 for free run mode.
void	set_clock_source (uint32_t value)
	Set "clock_source" attribute value. Clock source, 0 for PLL input 0, 1 for in 1, etc.. 255 for free run mode.
const std::string &	get_clock_config () const
	Get "clock_config" attribute value. Path of clock config file.
void	set_clock_config (const std::string &value)
	Set "clock_config" attribute value. Path of clock config file.
bool	get_soft () const
	Get "soft" attribute value. Soft reset.
void	set_soft (bool value)
	Set "soft" attribute value. Soft reset.
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_device_ready_timeout_str () noexcept
static const std::string &	__get_device_ready_timeout_str () noexcept
Static Public Member Functions inherited from dunedaq::timinglibs::dal::TimingControllerConf
static const std::string &	__get_device_str () noexcept
static const std::string &	__get_hardware_state_recovery_enabled_str () noexcept
static const std::string &	__get_timing_session_name_str () noexcept
static const std::string &	__get_clock_source_str () noexcept
static const std::string &	__get_clock_config_str () noexcept
static const std::string &	__get_soft_str () noexcept
static const std::string &	__get_device_str () noexcept
static const std::string &	__get_hardware_state_recovery_enabled_str () noexcept
static const std::string &	__get_timing_session_name_str () noexcept
static const std::string &	__get_clock_source_str () noexcept
static const std::string &	__get_clock_config_str () noexcept
static const std::string &	__get_soft_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_device_ready_timeout = "device_ready_timeout"
Static Public Attributes inherited from dunedaq::timinglibs::dal::TimingControllerConf
static const std::string &	s_class_name
static const std::string	s_device = "device"
static const std::string	s_hardware_state_recovery_enabled = "hardware_state_recovery_enabled"
static const std::string	s_timing_session_name = "timing_session_name"
static const std::string	s_clock_source = "clock_source"
static const std::string	s_clock_config = "clock_config"
static const std::string	s_soft = "soft"

Protected Member Functions
	TimingFanoutControllerConf (conffwk::DalRegistry &db, const conffwk::ConfigObject &obj) noexcept
virtual	~TimingFanoutControllerConf () 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
	TimingFanoutControllerConf (conffwk::DalRegistry &db, const conffwk::ConfigObject &obj) noexcept
virtual	~TimingFanoutControllerConf () 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::TimingControllerConf
	TimingControllerConf (conffwk::DalRegistry &db, const conffwk::ConfigObject &obj) noexcept
virtual	~TimingControllerConf () noexcept
bool	get (const std::string &name, std::vector< const dunedaq::conffwk::DalObject * > &vec, bool upcast_unregistered, bool first_call) const
	TimingControllerConf (conffwk::DalRegistry &db, const conffwk::ConfigObject &obj) noexcept
virtual	~TimingControllerConf () 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_device_ready_timeout

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

TimingFanoutController configuration

Definition at line 28 of file TimingFanoutControllerConf.hpp.

Constructor & Destructor Documentation

TimingFanoutControllerConf() [1/2]

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

protectednoexcept

Definition at line 27 of file TimingFanoutControllerConf.cpp.

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

~TimingFanoutControllerConf() [1/2]

dunedaq::timinglibs::dal::TimingFanoutControllerConf::~TimingFanoutControllerConf ( )

protectedvirtualnoexcept

Definition at line 76 of file TimingFanoutControllerConf.cpp.

      {
      }

TimingFanoutControllerConf() [2/2]

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

protectednoexcept

~TimingFanoutControllerConf() [2/2]

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

protectedvirtualnoexcept

Member Function Documentation

__get_device_ready_timeout_str() [1/2]

const std::string & dunedaq::timinglibs::dal::TimingFanoutControllerConf::__get_device_ready_timeout_str ( )

inlinestaticnoexcept

Definition at line 88 of file TimingFanoutControllerConf.hpp.

{ return s_device_ready_timeout; }

__get_device_ready_timeout_str() [2/2]

const std::string & dunedaq::timinglibs::dal::TimingFanoutControllerConf::__get_device_ready_timeout_str ( )

inlinestaticnoexcept

Definition at line 88 of file TimingFanoutControllerConf.hpp.

{ return s_device_ready_timeout; }

get() [1/4]

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

Definition at line 80 of file TimingFanoutControllerConf.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::TimingFanoutControllerConf::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::TimingControllerConf.

get() [3/4]

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

protected

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

protected

get_device_ready_timeout() [1/2]

uint32_t dunedaq::timinglibs::dal::TimingFanoutControllerConf::get_device_ready_timeout ( ) const

inline

Get "device_ready_timeout" attribute value.

Returns

the attribute value

Exceptions

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

Definition at line 98 of file TimingFanoutControllerConf.hpp.

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

get_device_ready_timeout() [2/2]

uint32_t dunedaq::timinglibs::dal::TimingFanoutControllerConf::get_device_ready_timeout ( ) const

inline

Get "device_ready_timeout" attribute value.

Returns

the attribute value

Exceptions

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

Definition at line 98 of file TimingFanoutControllerConf.hpp.

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

init() [1/2]

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

protectedvirtual

Initialize object (method generated by genconffwk)

Parameters

init_children

if true, initialize referenced objects

Reimplemented from dunedaq::timinglibs::dal::TimingControllerConf.

Definition at line 62 of file TimingFanoutControllerConf.cpp.

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

init() [2/2]

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

protectedvirtual

Initialize object (method generated by genconffwk)

Parameters

init_children

if true, initialize referenced objects

Reimplemented from dunedaq::timinglibs::dal::TimingControllerConf.

print() [1/2]

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

virtual

Print details of the TimingFanoutControllerConf 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::TimingControllerConf.

Definition at line 36 of file TimingFanoutControllerConf.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::TimingControllerConf::print(indent, false, s);
 
 
            // print direct attributes
 
          dunedaq::conffwk::p_sv_attr(s, str, s_device_ready_timeout, m_device_ready_timeout);
        }
        catch (dunedaq::conffwk::Exception & ex) {
          dunedaq::conffwk::DalObject::p_error(s, ex);
        }
      }

print() [2/2]

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

virtual

Print details of the TimingFanoutControllerConf 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::TimingControllerConf.

set_device_ready_timeout() [1/2]

void dunedaq::timinglibs::dal::TimingFanoutControllerConf::set_device_ready_timeout ( uint32_t value )

inline

Set "device_ready_timeout" attribute value.

Parameters

value

new attribute value

Exceptions

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

Definition at line 113 of file TimingFanoutControllerConf.hpp.

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

set_device_ready_timeout() [2/2]

void dunedaq::timinglibs::dal::TimingFanoutControllerConf::set_device_ready_timeout ( uint32_t value )

inline

Set "device_ready_timeout" attribute value.

Parameters

value

new attribute value

Exceptions

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

Definition at line 113 of file TimingFanoutControllerConf.hpp.

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

Friends And Related Symbol Documentation

conffwk::Configuration

conffwk::Configuration

friend

Definition at line 30 of file TimingFanoutControllerConf.hpp.

conffwk::DalFactory

conffwk::DalFactory

friend

Definition at line 32 of file TimingFanoutControllerConf.hpp.

conffwk::DalObject

conffwk::DalObject

friend

Definition at line 31 of file TimingFanoutControllerConf.hpp.

conffwk::DalRegistry

conffwk::DalRegistry

friend

Definition at line 33 of file TimingFanoutControllerConf.hpp.

Member Data Documentation

m_device_ready_timeout

uint32_t dunedaq::timinglibs::dal::TimingFanoutControllerConf::m_device_ready_timeout

private

Definition at line 79 of file TimingFanoutControllerConf.hpp.

s_class_name

const std::string & dunedaq::timinglibs::dal::TimingFanoutControllerConf::s_class_name

static

The name of the configuration class.

Definition at line 45 of file TimingFanoutControllerConf.hpp.

s_device_ready_timeout

const std::string dunedaq::timinglibs::dal::TimingFanoutControllerConf::s_device_ready_timeout = "device_ready_timeout"

inlinestatic

Definition at line 86 of file TimingFanoutControllerConf.hpp.

---

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

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