#include <TimingHardwareInterface.hpp>

Inheritance diagram for dunedaq::timinglibs::dal::TimingHardwareInterface:

Collaboration diagram for dunedaq::timinglibs::dal::TimingHardwareInterface:

Public Member Functions
virtual void	print (unsigned int offset, bool print_header, std::ostream &s) const
	Print details of the TimingHardwareInterface 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.

virtual void	print (unsigned int offset, bool print_header, std::ostream &s) const
	Print details of the TimingHardwareInterface 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.

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 Attributes
static const std::string &	s_class_name

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

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

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

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

Friends
class	conffwk::Configuration

class	conffwk::DalObject

class	conffwk::DalFactory

class	conffwk::DalRegistry

Additional Inherited Members
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

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

TimingHardwareInterface class

Definition at line 25 of file TimingHardwareInterface.hpp.

Constructor & Destructor Documentation

◆ TimingHardwareInterface() [1/2]

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

protectednoexcept

Definition at line 27 of file TimingHardwareInterface.cpp.

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

◆ ~TimingHardwareInterface() [1/2]

dunedaq::timinglibs::dal::TimingHardwareInterface::~TimingHardwareInterface ( )

protectedvirtualnoexcept

Definition at line 56 of file TimingHardwareInterface.cpp.

57 {

58 }

◆ TimingHardwareInterface() [2/2]

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

protectednoexcept

◆ ~TimingHardwareInterface() [2/2]

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

protectedvirtualnoexcept

Member Function Documentation

◆ get() [1/4]

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

Reimplemented in dunedaq::hsilibs::dal::HSIController, dunedaq::hsilibs::dal::HSIController, dunedaq::timinglibs::dal::TimingHardwareManagerBase, dunedaq::timinglibs::dal::TimingHardwareManagerBase, dunedaq::timinglibs::dal::TimingHardwareManagerPDII, and dunedaq::timinglibs::dal::TimingHardwareManagerPDII.

Definition at line 60 of file TimingHardwareInterface.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::TimingHardwareInterface::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.

Reimplemented in dunedaq::hsilibs::dal::HSIController, dunedaq::hsilibs::dal::HSIController, dunedaq::timinglibs::dal::TimingHardwareManagerBase, dunedaq::timinglibs::dal::TimingHardwareManagerBase, dunedaq::timinglibs::dal::TimingHardwareManagerPDII, and dunedaq::timinglibs::dal::TimingHardwareManagerPDII.

◆ get() [3/4]

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

protected

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

protected

◆ init() [1/2]

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

protectedvirtual

Initialize object (method generated by genconffwk)

Parameters

init_children if true, initialize referenced objects

Implements dunedaq::conffwk::DalObject.

Reimplemented in dunedaq::hsilibs::dal::HSIController, dunedaq::hsilibs::dal::HSIController, dunedaq::timinglibs::dal::TimingHardwareManagerBase, dunedaq::timinglibs::dal::TimingHardwareManagerBase, dunedaq::timinglibs::dal::TimingHardwareManagerPDII, and dunedaq::timinglibs::dal::TimingHardwareManagerPDII.

Definition at line 49 of file TimingHardwareInterface.cpp.

      {
        p_was_read = true;
        increment_read();
        TLOG_DEBUG(5) << "read object " << this << " (class " << s_class_name << ')';
      }

◆ init() [2/2]

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

protectedvirtual

Initialize object (method generated by genconffwk)

Parameters

init_children if true, initialize referenced objects

Implements dunedaq::conffwk::DalObject.

Reimplemented in dunedaq::hsilibs::dal::HSIController, dunedaq::hsilibs::dal::HSIController, dunedaq::timinglibs::dal::TimingHardwareManagerBase, dunedaq::timinglibs::dal::TimingHardwareManagerBase, dunedaq::timinglibs::dal::TimingHardwareManagerPDII, and dunedaq::timinglibs::dal::TimingHardwareManagerPDII.

◆ print() [1/2]

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

virtual

Print details of the TimingHardwareInterface 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.

Reimplemented in dunedaq::hsilibs::dal::HSIController, dunedaq::hsilibs::dal::HSIController, dunedaq::timinglibs::dal::TimingHardwareManagerBase, dunedaq::timinglibs::dal::TimingHardwareManagerBase, dunedaq::timinglibs::dal::TimingHardwareManagerPDII, and dunedaq::timinglibs::dal::TimingHardwareManagerPDII.

Definition at line 34 of file TimingHardwareInterface.cpp.

      {
        check_init();
 
        try {
 
          if (print_header)
            p_hdr(s, indent, s_class_name, "dunedaq::timinglibs::dal");
        }
        catch (dunedaq::conffwk::Exception & ex) {
          dunedaq::conffwk::DalObject::p_error(s, ex);
        }
      }

◆ print() [2/2]

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

virtual

Print details of the TimingHardwareInterface 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.

Reimplemented in dunedaq::hsilibs::dal::HSIController, dunedaq::hsilibs::dal::HSIController, dunedaq::timinglibs::dal::TimingHardwareManagerBase, dunedaq::timinglibs::dal::TimingHardwareManagerBase, dunedaq::timinglibs::dal::TimingHardwareManagerPDII, and dunedaq::timinglibs::dal::TimingHardwareManagerPDII.

Friends And Related Symbol Documentation

◆ conffwk::Configuration

conffwk::Configuration

friend

Definition at line 27 of file TimingHardwareInterface.hpp.

◆ conffwk::DalFactory

conffwk::DalFactory

friend

Definition at line 29 of file TimingHardwareInterface.hpp.

◆ conffwk::DalObject

conffwk::DalObject

friend

Definition at line 28 of file TimingHardwareInterface.hpp.

◆ conffwk::DalRegistry

conffwk::DalRegistry

friend

Definition at line 30 of file TimingHardwareInterface.hpp.

Member Data Documentation

◆ s_class_name

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

static

The name of the configuration class.

Definition at line 42 of file TimingHardwareInterface.hpp.

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

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

Public Member Functions

Static Public Attributes

Protected Member Functions

Friends

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ TimingHardwareInterface() [1/2]

◆ ~TimingHardwareInterface() [1/2]

◆ TimingHardwareInterface() [2/2]

◆ ~TimingHardwareInterface() [2/2]

Member Function Documentation

◆ get() [1/4]

◆ get() [2/4]

◆ get() [3/4]

◆ get() [4/4]

◆ init() [1/2]

◆ init() [2/2]

◆ print() [1/2]

◆ print() [2/2]

Friends And Related Symbol Documentation

◆ conffwk::Configuration

◆ conffwk::DalFactory

◆ conffwk::DalObject

◆ conffwk::DalRegistry

Member Data Documentation

◆ s_class_name