dunedaq::timinglibs::dal::TimingEndpointControllerBase Class Reference

#include <TimingEndpointControllerBase.hpp>

Inheritance diagram for dunedaq::timinglibs::dal::TimingEndpointControllerBase:

Collaboration diagram for dunedaq::timinglibs::dal::TimingEndpointControllerBase:

Public Member Functions
virtual void	print (unsigned int offset, bool print_header, std::ostream &s) const
	Print details of the TimingEndpointControllerBase 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 TimingEndpointControllerBase 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::timinglibs::dal::TimingController
const dunedaq::timinglibs::dal::TimingControllerConf *	get_configuration () const
	Get "configuration" relationship value.
void	set_configuration (const dunedaq::timinglibs::dal::TimingControllerConf *value)
	Set "configuration" relationship value.
const dunedaq::timinglibs::dal::TimingControllerConf *	get_configuration () const
	Get "configuration" relationship value.
void	set_configuration (const dunedaq::timinglibs::dal::TimingControllerConf *value)
	Set "configuration" relationship value.
Public Member Functions inherited from dunedaq::confmodel::DaqModule
const std::vector< const dunedaq::confmodel::Connection * > &	get_inputs () const
	Get "inputs" relationship value. List of connections to/from this module.
void	set_inputs (const std::vector< const dunedaq::confmodel::Connection * > &value)
	Set "inputs" relationship value. List of connections to/from this module.
const std::vector< const dunedaq::confmodel::Connection * > &	get_outputs () const
	Get "outputs" relationship value. Output connections from this module.
void	set_outputs (const std::vector< const dunedaq::confmodel::Connection * > &value)
	Set "outputs" relationship value. Output connections from this module.
const std::vector< const dunedaq::confmodel::HostComponent * > &	get_used_resources () const
	Get "used_resources" relationship value.
void	set_used_resources (const std::vector< const dunedaq::confmodel::HostComponent * > &value)
	Set "used_resources" relationship value.
const std::vector< const dunedaq::confmodel::Connection * > &	get_inputs () const
	Get "inputs" relationship value. List of connections to/from this module.
void	set_inputs (const std::vector< const dunedaq::confmodel::Connection * > &value)
	Set "inputs" relationship value. List of connections to/from this module.
const std::vector< const dunedaq::confmodel::Connection * > &	get_outputs () const
	Get "outputs" relationship value. Output connections from this module.
void	set_outputs (const std::vector< const dunedaq::confmodel::Connection * > &value)
	Set "outputs" relationship value. Output connections from this module.
const std::vector< const dunedaq::confmodel::HostComponent * > &	get_used_resources () const
	Get "used_resources" relationship value.
void	set_used_resources (const std::vector< const dunedaq::confmodel::HostComponent * > &value)
	Set "used_resources" relationship value.
Public Member Functions inherited from dunedaq::conffwk::DalObject
const std::string &	UID () const noexcept
const std::string &	class_name () const noexcept
bool	castable (const std::string &target) const noexcept
bool	castable (const std::string *target) const noexcept
template<class TARGET >
const TARGET *	cast () const noexcept
	Casts object to different class.
std::string	full_name () const noexcept
const ConfigObject &	config_object () const
DalRegistry &	registry () const noexcept
Configuration &	configuration () const noexcept
void	unread ()
void	set (const ConfigObject &o) noexcept
void	move (const std::string &at)
void	rename (const std::string &new_id)
void	p_hdr (std::ostream &s, unsigned int indent, const std::string &cl, const char *nm=nullptr) const
	print object headers
std::ostream &	print_object (std::ostream &s) const
	print object details
void	throw_init_ex (dunedaq::conffwk::Exception &ex)
	throw object initialisation exception (i.e.

Static Public Attributes
static const std::string &	s_class_name
Static Public Attributes inherited from dunedaq::timinglibs::dal::TimingController
static const std::string &	s_class_name
static const std::string	s_configuration = "configuration"
Static Public Attributes inherited from dunedaq::confmodel::DaqModule
static const std::string &	s_class_name
static const std::string	s_inputs = "inputs"
static const std::string	s_outputs = "outputs"
static const std::string	s_used_resources = "used_resources"

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

Friends
class	conffwk::Configuration
class	conffwk::DalObject
class	conffwk::DalFactory
class	conffwk::DalRegistry

Additional Inherited Members
Static Public Member Functions inherited from dunedaq::timinglibs::dal::TimingController
static const std::string &	__get_configuration_str () noexcept
static const std::string &	__get_configuration_str () noexcept
Static Public Member Functions inherited from dunedaq::confmodel::DaqModule
static const std::string &	__get_inputs_str () noexcept
static const std::string &	__get_outputs_str () noexcept
static const std::string &	__get_used_resources_str () noexcept
static const std::string &	__get_inputs_str () noexcept
static const std::string &	__get_outputs_str () noexcept
static const std::string &	__get_used_resources_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
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

TimingEndpointControllerBase module

Definition at line 28 of file TimingEndpointControllerBase.hpp.

Constructor & Destructor Documentation

TimingEndpointControllerBase() [1/2]

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

protectednoexcept

Definition at line 27 of file TimingEndpointControllerBase.cpp.

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

~TimingEndpointControllerBase() [1/2]

dunedaq::timinglibs::dal::TimingEndpointControllerBase::~TimingEndpointControllerBase ( )

protectedvirtualnoexcept

Definition at line 63 of file TimingEndpointControllerBase.cpp.

      {
      }

TimingEndpointControllerBase() [2/2]

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

protectednoexcept

~TimingEndpointControllerBase() [2/2]

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

protectedvirtualnoexcept

Member Function Documentation

get() [1/4]

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

Reimplemented in dunedaq::hsilibs::dal::HSIController, dunedaq::hsilibs::dal::HSIController, dunedaq::timinglibs::dal::TimingEndpointController, dunedaq::timinglibs::dal::TimingEndpointController, dunedaq::timinglibs::dal::TimingFanoutController, and dunedaq::timinglibs::dal::TimingFanoutController.

Definition at line 67 of file TimingEndpointControllerBase.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::TimingEndpointControllerBase::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::TimingController.

Reimplemented in dunedaq::hsilibs::dal::HSIController, dunedaq::hsilibs::dal::HSIController, dunedaq::timinglibs::dal::TimingEndpointController, dunedaq::timinglibs::dal::TimingEndpointController, dunedaq::timinglibs::dal::TimingFanoutController, and dunedaq::timinglibs::dal::TimingFanoutController.

get() [3/4]

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

protected

Definition at line 77 of file TimingEndpointControllerBase.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 (TimingController::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::TimingEndpointControllerBase::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::TimingEndpointControllerBase::init ( bool init_children )

protectedvirtual

Initialize object (method generated by genconffwk)

Parameters

init_children

if true, initialize referenced objects

Reimplemented from dunedaq::timinglibs::dal::TimingController.

Reimplemented in dunedaq::hsilibs::dal::HSIController, dunedaq::hsilibs::dal::HSIController, dunedaq::timinglibs::dal::TimingEndpointController, dunedaq::timinglibs::dal::TimingEndpointController, dunedaq::timinglibs::dal::TimingFanoutController, and dunedaq::timinglibs::dal::TimingFanoutController.

Definition at line 56 of file TimingEndpointControllerBase.cpp.

      {
        TimingController::init(init_children);
 
        TLOG_DEBUG(5) << "read object " << this << " (class " << s_class_name << ')';
      }

init() [2/2]

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

protectedvirtual

Initialize object (method generated by genconffwk)

Parameters

init_children

if true, initialize referenced objects

Reimplemented from dunedaq::timinglibs::dal::TimingController.

Reimplemented in dunedaq::hsilibs::dal::HSIController, dunedaq::hsilibs::dal::HSIController, dunedaq::timinglibs::dal::TimingEndpointController, dunedaq::timinglibs::dal::TimingEndpointController, dunedaq::timinglibs::dal::TimingFanoutController, and dunedaq::timinglibs::dal::TimingFanoutController.

print() [1/2]

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

virtual

Print details of the TimingEndpointControllerBase 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::TimingController.

Reimplemented in dunedaq::hsilibs::dal::HSIController, dunedaq::hsilibs::dal::HSIController, dunedaq::timinglibs::dal::TimingEndpointController, dunedaq::timinglibs::dal::TimingEndpointController, dunedaq::timinglibs::dal::TimingFanoutController, and dunedaq::timinglibs::dal::TimingFanoutController.

Definition at line 36 of file TimingEndpointControllerBase.cpp.

      {
        check_init();
 
        try {
 
          if (print_header)
            p_hdr(s, indent, s_class_name, "dunedaq::timinglibs::dal");
 
 
            // print direct super-classes
 
          dunedaq::timinglibs::dal::TimingController::print(indent, false, s);
        }
        catch (dunedaq::conffwk::Exception & ex) {
          dunedaq::conffwk::DalObject::p_error(s, ex);
        }
      }

print() [2/2]

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

virtual

Print details of the TimingEndpointControllerBase 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::TimingController.

Reimplemented in dunedaq::hsilibs::dal::HSIController, dunedaq::hsilibs::dal::HSIController, dunedaq::timinglibs::dal::TimingEndpointController, dunedaq::timinglibs::dal::TimingEndpointController, dunedaq::timinglibs::dal::TimingFanoutController, and dunedaq::timinglibs::dal::TimingFanoutController.

Friends And Related Symbol Documentation

conffwk::Configuration

conffwk::Configuration

friend

Definition at line 30 of file TimingEndpointControllerBase.hpp.

conffwk::DalFactory

conffwk::DalFactory

friend

Definition at line 32 of file TimingEndpointControllerBase.hpp.

conffwk::DalObject

conffwk::DalObject

friend

Definition at line 31 of file TimingEndpointControllerBase.hpp.

conffwk::DalRegistry

conffwk::DalRegistry

friend

Definition at line 33 of file TimingEndpointControllerBase.hpp.

Member Data Documentation

s_class_name

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

static

The name of the configuration class.

Definition at line 45 of file TimingEndpointControllerBase.hpp.

---

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

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