#include <DetectorToDaqConnection.hpp>

Inheritance diagram for dunedaq::confmodel::DetectorToDaqConnection:

Collaboration diagram for dunedaq::confmodel::DetectorToDaqConnection:

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

std::vector< const confmodel::DetectorStream * >	streams () const

virtual std::vector< const Resource * >	contained_resources () const override

virtual std::vector< const DetDataSender * >	senders () const =0

virtual const DetDataReceiver *	receiver () const =0

bool	compute_disabled_state (const std::set< std::string > &disabled) const final

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

std::vector< const confmodel::DetectorStream * >	streams () const

virtual std::vector< const Resource * >	contained_resources () const override

virtual std::vector< const DetDataSender * >	senders () const =0

virtual const DetDataReceiver *	receiver () const =0

bool	compute_disabled_state (const std::set< std::string > &disabled) const final

Public Member Functions inherited from dunedaq::confmodel::ResourceSet
Public Member Functions inherited from dunedaq::confmodel::Resource
void	parents (const dunedaq::confmodel::Session &session, std::list< std::vector< const dunedaq::confmodel::Resource * > > &parents) const

bool	is_disabled (const dunedaq::confmodel::ResourceTree &session) const

void	parents (const dunedaq::confmodel::Session &session, std::list< std::vector< const dunedaq::confmodel::Resource * > > &parents) const

bool	is_disabled (const dunedaq::confmodel::ResourceTree &session) const

Public Member Functions inherited from dunedaq::conffwk::DalObject
const std::string &	UID () const noexcept

const std::string &	class_name () const noexcept

bool	castable (const std::string &target) const noexcept

bool	castable (const std::string *target) const noexcept

template<class TARGET >
const TARGET *	cast () const noexcept
	Casts object to different class.

std::string	full_name () const noexcept

const ConfigObject &	config_object () const

DalRegistry &	registry () const noexcept

Configuration &	configuration () const noexcept

void	unread ()

void	set (const ConfigObject &o) noexcept

void	move (const std::string &at)

void	rename (const std::string &new_id)

void	p_hdr (std::ostream &s, unsigned int indent, const std::string &cl, const char *nm=nullptr) const
	print object headers

std::ostream &	print_object (std::ostream &s) const
	print object details

void	throw_init_ex (dunedaq::conffwk::Exception &ex)
	throw object initialisation exception (i.e.

Static Public Attributes
static const std::string &	s_class_name

Static Public Attributes inherited from dunedaq::confmodel::ResourceSet
static const std::string &	s_class_name

Static Public Attributes inherited from dunedaq::confmodel::Resource
static const std::string &	s_class_name

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

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

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

virtual	~DetectorToDaqConnection () 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::confmodel::ResourceSet
	ResourceSet (conffwk::DalRegistry &db, const conffwk::ConfigObject &obj) noexcept

virtual	~ResourceSet () noexcept

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

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

virtual	~ResourceSet () 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::Resource
	Resource (conffwk::DalRegistry &db, const conffwk::ConfigObject &obj) noexcept

virtual	~Resource () noexcept

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

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

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

Definition at line 34 of file DetectorToDaqConnection.hpp.

Constructor & Destructor Documentation

◆ DetectorToDaqConnection() [1/2]

dunedaq::confmodel::DetectorToDaqConnection::DetectorToDaqConnection	(	conffwk::DalRegistry &	db,
		const conffwk::ConfigObject &	obj )

protectednoexcept

Definition at line 15 of file DetectorToDaqConnection.cpp.

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

◆ ~DetectorToDaqConnection() [1/2]

dunedaq::confmodel::DetectorToDaqConnection::~DetectorToDaqConnection ( )

protectedvirtualnoexcept

Definition at line 51 of file DetectorToDaqConnection.cpp.

52 {

53 }

◆ DetectorToDaqConnection() [2/2]

dunedaq::confmodel::DetectorToDaqConnection::DetectorToDaqConnection	(	conffwk::DalRegistry &	db,
		const conffwk::ConfigObject &	obj )

protectednoexcept

◆ ~DetectorToDaqConnection() [2/2]

virtual dunedaq::confmodel::DetectorToDaqConnection::~DetectorToDaqConnection ( )

protectedvirtualnoexcept

Member Function Documentation

◆ compute_disabled_state() [1/2]

bool dunedaq::confmodel::DetectorToDaqConnection::compute_disabled_state ( const std::set< std::string > & disabled ) const

finalvirtual

Custom implementation of method for DetectorToDaqConnection. Must AND the senders and OR the seult with the receiver.

Reimplemented from dunedaq::confmodel::Resource.

Definition at line 418 of file dalMethods.cpp.

                                                                                                 {
  if (disabled_resources.contains(UID())) {
    return true;
  }
  bool send_disabled = true;
  for (auto sender: senders()) {
    if (!sender->compute_disabled_state(disabled_resources)) {
      send_disabled = false;
      break;
    }
  }
  TLOG_DBG(6) << "receiver disabled=" << receiver()->compute_disabled_state(disabled_resources)
              << " senders disabled=" << send_disabled;
  if (receiver()->compute_disabled_state(disabled_resources) || send_disabled) {
    return true;
  }
  return false;
}

◆ compute_disabled_state() [2/2]

bool dunedaq::confmodel::DetectorToDaqConnection::compute_disabled_state ( const std::set< std::string > & disabled ) const

finalvirtual

Custom implementation of method for DetectorToDaqConnection. Must AND the senders and OR the seult with the receiver.

Reimplemented from dunedaq::confmodel::Resource.

◆ contained_resources() [1/2]

std::vector< const Resource * > dunedaq::confmodel::DetectorToDaqConnection::contained_resources ( ) const

overridevirtual

Virtual method to obtain the list of all contained Resources. Used internally by the core disabled logic. Not intended to be used in application code as that should be using individual relationships of the derived classes.

Implements dunedaq::confmodel::ResourceSet.

Definition at line 410 of file dalMethods.cpp.

                                                                              {
  auto res = to_resources(senders());
  res.push_back(receiver());
  return res;
}

◆ contained_resources() [2/2]

virtual std::vector< const Resource * > dunedaq::confmodel::DetectorToDaqConnection::contained_resources ( ) const

overridevirtual

Virtual method to obtain the list of all contained Resources. Used internally by the core disabled logic. Not intended to be used in application code as that should be using individual relationships of the derived classes.

Implements dunedaq::confmodel::ResourceSet.

◆ get() [1/4]

std::vector< const dunedaq::conffwk::DalObject * > dunedaq::confmodel::DetectorToDaqConnection::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::confmodel::ResourceSet.

Reimplemented in dunedaq::appmodel::FelixDetectorToDaqConnection, dunedaq::appmodel::FelixDetectorToDaqConnection, dunedaq::appmodel::NetworkDetectorToDaqConnection, dunedaq::appmodel::NetworkDetectorToDaqConnection, dunedaq::confmodel::DummyD2D, and dunedaq::confmodel::DummyD2D.

Definition at line 55 of file DetectorToDaqConnection.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::confmodel::DetectorToDaqConnection::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::confmodel::ResourceSet.

Reimplemented in dunedaq::appmodel::FelixDetectorToDaqConnection, dunedaq::appmodel::FelixDetectorToDaqConnection, dunedaq::appmodel::NetworkDetectorToDaqConnection, dunedaq::appmodel::NetworkDetectorToDaqConnection, dunedaq::confmodel::DummyD2D, and dunedaq::confmodel::DummyD2D.

◆ get() [3/4]

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

protected

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

◆ get() [4/4]

bool dunedaq::confmodel::DetectorToDaqConnection::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::confmodel::DetectorToDaqConnection::init ( bool init_children )

protectedvirtual

Initialize object (method generated by genconffwk)

Parameters

init_children if true, initialize referenced objects

Reimplemented from dunedaq::confmodel::ResourceSet.

Reimplemented in dunedaq::appmodel::FelixDetectorToDaqConnection, dunedaq::appmodel::FelixDetectorToDaqConnection, dunedaq::appmodel::NetworkDetectorToDaqConnection, dunedaq::appmodel::NetworkDetectorToDaqConnection, dunedaq::confmodel::DummyD2D, and dunedaq::confmodel::DummyD2D.

Definition at line 44 of file DetectorToDaqConnection.cpp.

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

◆ init() [2/2]

virtual void dunedaq::confmodel::DetectorToDaqConnection::init ( bool init_children )

protectedvirtual

Initialize object (method generated by genconffwk)

Parameters

init_children if true, initialize referenced objects

Reimplemented from dunedaq::confmodel::ResourceSet.

Reimplemented in dunedaq::appmodel::FelixDetectorToDaqConnection, dunedaq::appmodel::FelixDetectorToDaqConnection, dunedaq::appmodel::NetworkDetectorToDaqConnection, dunedaq::appmodel::NetworkDetectorToDaqConnection, dunedaq::confmodel::DummyD2D, and dunedaq::confmodel::DummyD2D.

◆ print() [1/2]

void dunedaq::confmodel::DetectorToDaqConnection::print	(	unsigned int	offset,
		bool	print_header,
		std::ostream &	s ) const

virtual

Print details of the DetectorToDaqConnection 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::confmodel::ResourceSet.

Reimplemented in dunedaq::appmodel::FelixDetectorToDaqConnection, dunedaq::appmodel::FelixDetectorToDaqConnection, dunedaq::appmodel::NetworkDetectorToDaqConnection, dunedaq::appmodel::NetworkDetectorToDaqConnection, dunedaq::confmodel::DummyD2D, and dunedaq::confmodel::DummyD2D.

Definition at line 24 of file DetectorToDaqConnection.cpp.

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

◆ print() [2/2]

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

virtual

Print details of the DetectorToDaqConnection 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::confmodel::ResourceSet.

Reimplemented in dunedaq::appmodel::FelixDetectorToDaqConnection, dunedaq::appmodel::FelixDetectorToDaqConnection, dunedaq::appmodel::NetworkDetectorToDaqConnection, dunedaq::appmodel::NetworkDetectorToDaqConnection, dunedaq::confmodel::DummyD2D, and dunedaq::confmodel::DummyD2D.

◆ receiver() [1/2]

virtual const DetDataReceiver * dunedaq::confmodel::DetectorToDaqConnection::receiver ( ) const

pure virtual

Pure virtual method to get DataReceiver associated with this connection

Implemented in dunedaq::appmodel::FelixDetectorToDaqConnection, dunedaq::appmodel::FelixDetectorToDaqConnection, dunedaq::appmodel::NetworkDetectorToDaqConnection, dunedaq::appmodel::NetworkDetectorToDaqConnection, dunedaq::confmodel::DummyD2D, and dunedaq::confmodel::DummyD2D.

◆ receiver() [2/2]

virtual const DetDataReceiver * dunedaq::confmodel::DetectorToDaqConnection::receiver ( ) const

pure virtual

Pure virtual method to get DataReceiver associated with this connection

Implemented in dunedaq::appmodel::FelixDetectorToDaqConnection, dunedaq::appmodel::FelixDetectorToDaqConnection, dunedaq::appmodel::NetworkDetectorToDaqConnection, dunedaq::appmodel::NetworkDetectorToDaqConnection, dunedaq::confmodel::DummyD2D, and dunedaq::confmodel::DummyD2D.

◆ senders() [1/2]

virtual std::vector< const DetDataSender * > dunedaq::confmodel::DetectorToDaqConnection::senders ( ) const

pure virtual

Pure virtual method to get vector of DataSenders

Implemented in dunedaq::appmodel::FelixDetectorToDaqConnection, dunedaq::appmodel::FelixDetectorToDaqConnection, dunedaq::appmodel::NetworkDetectorToDaqConnection, dunedaq::appmodel::NetworkDetectorToDaqConnection, dunedaq::confmodel::DummyD2D, and dunedaq::confmodel::DummyD2D.

◆ senders() [2/2]

virtual std::vector< const DetDataSender * > dunedaq::confmodel::DetectorToDaqConnection::senders ( ) const

pure virtual

Pure virtual method to get vector of DataSenders

Implemented in dunedaq::appmodel::FelixDetectorToDaqConnection, dunedaq::appmodel::FelixDetectorToDaqConnection, dunedaq::appmodel::NetworkDetectorToDaqConnection, dunedaq::appmodel::NetworkDetectorToDaqConnection, dunedaq::confmodel::DummyD2D, and dunedaq::confmodel::DummyD2D.

◆ streams() [1/2]

std::vector< const confmodel::DetectorStream * > dunedaq::confmodel::DetectorToDaqConnection::streams ( ) const

Definition at line 371 of file dalMethods.cpp.

                                       {
  std::vector<const confmodel::DetectorStream*> all_streams;
  // Loop over senders
  for (auto sender : this->senders()) {
    auto sender_streams = sender->get_streams();
    all_streams.insert(all_streams.end(), sender_streams.begin(), sender_streams.end());
  }
  return all_streams;
}

◆ streams() [2/2]

std::vector< const confmodel::DetectorStream * > dunedaq::confmodel::DetectorToDaqConnection::streams ( ) const

Friends And Related Symbol Documentation

◆ conffwk::Configuration

conffwk::Configuration

friend

Definition at line 36 of file DetectorToDaqConnection.hpp.

◆ conffwk::DalFactory

conffwk::DalFactory

friend

Definition at line 38 of file DetectorToDaqConnection.hpp.

◆ conffwk::DalObject

conffwk::DalObject

friend

Definition at line 37 of file DetectorToDaqConnection.hpp.

◆ conffwk::DalRegistry

conffwk::DalRegistry

friend

Definition at line 39 of file DetectorToDaqConnection.hpp.

Member Data Documentation

◆ s_class_name

static const std::string & dunedaq::confmodel::DetectorToDaqConnection::s_class_name

static

The name of the configuration class.

Definition at line 51 of file DetectorToDaqConnection.hpp.

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

/github/workspace/dunedaq/build/confmodel/codegen/include/confmodel/DetectorToDaqConnection.hpp
/github/workspace/dunedaq/build/confmodel/codegen/src/DetectorToDaqConnection.hpp
/github/workspace/dunedaq/sourcecode/confmodel/src/dalMethods.cpp
/github/workspace/dunedaq/build/confmodel/codegen/src/DetectorToDaqConnection.cpp

Public Member Functions

Static Public Attributes

Protected Member Functions

Friends

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ DetectorToDaqConnection() [1/2]

◆ ~DetectorToDaqConnection() [1/2]

◆ DetectorToDaqConnection() [2/2]

◆ ~DetectorToDaqConnection() [2/2]

Member Function Documentation

◆ compute_disabled_state() [1/2]

◆ compute_disabled_state() [2/2]

◆ contained_resources() [1/2]

◆ contained_resources() [2/2]

◆ get() [1/4]

◆ get() [2/4]

◆ get() [3/4]

◆ get() [4/4]

◆ init() [1/2]

◆ init() [2/2]

◆ print() [1/2]

◆ print() [2/2]

◆ receiver() [1/2]

◆ receiver() [2/2]

◆ senders() [1/2]

◆ senders() [2/2]

◆ streams() [1/2]

◆ streams() [2/2]

Friends And Related Symbol Documentation

◆ conffwk::Configuration

◆ conffwk::DalFactory

◆ conffwk::DalObject

◆ conffwk::DalRegistry

Member Data Documentation

◆ s_class_name