dunedaq::confmodel::DetDataSender Class Reference

#include <DetDataSender.hpp>

Inheritance diagram for dunedaq::confmodel::DetDataSender:

Collaboration diagram for dunedaq::confmodel::DetDataSender:

Public Member Functions
virtual void	print (unsigned int offset, bool print_header, std::ostream &s) const
	Print details of the DetDataSender 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.
const std::vector< const dunedaq::confmodel::DetectorStream * > &	get_streams () const
	Get "streams" relationship value.
void	set_streams (const std::vector< const dunedaq::confmodel::DetectorStream * > &value)
	Set "streams" relationship value.
virtual std::vector< const Resource * >	contained_resources () const override
virtual void	print (unsigned int offset, bool print_header, std::ostream &s) const
	Print details of the DetDataSender 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.
const std::vector< const dunedaq::confmodel::DetectorStream * > &	get_streams () const
	Get "streams" relationship value.
void	set_streams (const std::vector< const dunedaq::confmodel::DetectorStream * > &value)
	Set "streams" relationship value.
virtual std::vector< const Resource * >	contained_resources () const override
Public Member Functions inherited from dunedaq::confmodel::ResourceSetDisableAND
bool	compute_disabled_state (const std::set< std::string > &disabled) const final
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 Member Functions
static const std::string &	__get_streams_str () noexcept
static const std::string &	__get_streams_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_streams = "streams"
Static Public Attributes inherited from dunedaq::confmodel::ResourceSetDisableAND
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
	DetDataSender (conffwk::DalRegistry &db, const conffwk::ConfigObject &obj) noexcept
virtual	~DetDataSender () 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
	DetDataSender (conffwk::DalRegistry &db, const conffwk::ConfigObject &obj) noexcept
virtual	~DetDataSender () 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::ResourceSetDisableAND
	ResourceSetDisableAND (conffwk::DalRegistry &db, const conffwk::ConfigObject &obj) noexcept
virtual	~ResourceSetDisableAND () noexcept
bool	get (const std::string &name, std::vector< const dunedaq::conffwk::DalObject * > &vec, bool upcast_unregistered, bool first_call) const
	ResourceSetDisableAND (conffwk::DalRegistry &db, const conffwk::ConfigObject &obj) noexcept
virtual	~ResourceSetDisableAND () 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::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.

Private Attributes
std::vector< const dunedaq::confmodel::DetectorStream * >	m_streams

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

Definition at line 32 of file DetDataSender.hpp.

Constructor & Destructor Documentation

DetDataSender() [1/2]

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

protectednoexcept

Definition at line 20 of file DetDataSender.cpp.

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

~DetDataSender() [1/2]

dunedaq::confmodel::DetDataSender::~DetDataSender ( )

protectedvirtualnoexcept

Definition at line 69 of file DetDataSender.cpp.

    {
    }

DetDataSender() [2/2]

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

protectednoexcept

~DetDataSender() [2/2]

virtual dunedaq::confmodel::DetDataSender::~DetDataSender ( )

protectedvirtualnoexcept

Member Function Documentation

__get_streams_str() [1/2]

static const std::string & dunedaq::confmodel::DetDataSender::__get_streams_str ( )

inlinestaticnoexcept

Definition at line 92 of file DetDataSender.hpp.

{ return s_streams; }

__get_streams_str() [2/2]

static const std::string & dunedaq::confmodel::DetDataSender::__get_streams_str ( )

inlinestaticnoexcept

Definition at line 92 of file DetDataSender.hpp.

{ return s_streams; }

contained_resources() [1/2]

std::vector< const Resource * > dunedaq::confmodel::DetDataSender::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 406 of file dalMethods.cpp.

                                                                    {
  return to_resources(get_streams());
}

contained_resources() [2/2]

virtual std::vector< const Resource * > dunedaq::confmodel::DetDataSender::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::DetDataSender::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::ResourceSetDisableAND.

Reimplemented in dunedaq::appmodel::FakeDataSender, dunedaq::appmodel::FakeDataSender, dunedaq::appmodel::FelixDataSender, dunedaq::appmodel::FelixDataSender, dunedaq::appmodel::HermesDataSender, dunedaq::appmodel::HermesDataSender, dunedaq::appmodel::NWDetDataSender, dunedaq::appmodel::NWDetDataSender, dunedaq::appmodel::SocketDataSender, dunedaq::appmodel::SocketDataSender, dunedaq::appmodel::TdeAmcDetDataSender, dunedaq::appmodel::TdeAmcDetDataSender, dunedaq::confmodel::DummySender, and dunedaq::confmodel::DummySender.

Definition at line 73 of file DetDataSender.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::DetDataSender::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::ResourceSetDisableAND.

Reimplemented in dunedaq::appmodel::FakeDataSender, dunedaq::appmodel::FakeDataSender, dunedaq::appmodel::FelixDataSender, dunedaq::appmodel::FelixDataSender, dunedaq::appmodel::HermesDataSender, dunedaq::appmodel::HermesDataSender, dunedaq::appmodel::NWDetDataSender, dunedaq::appmodel::NWDetDataSender, dunedaq::appmodel::SocketDataSender, dunedaq::appmodel::SocketDataSender, dunedaq::appmodel::TdeAmcDetDataSender, dunedaq::appmodel::TdeAmcDetDataSender, dunedaq::confmodel::DummySender, and dunedaq::confmodel::DummySender.

get() [3/4]

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

protected

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

protected

get_streams() [1/2]

const std::vector< const dunedaq::confmodel::DetectorStream * > & dunedaq::confmodel::DetDataSender::get_streams ( ) const

inline

Get "streams" relationship value.

Returns

the relationship value

Exceptions

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

Definition at line 102 of file DetDataSender.hpp.

        {
          std::lock_guard scoped_lock(m_mutex);
          check();
          check_init();
          if (m_streams.empty())
            {
              std::ostringstream text;
              text << "relationship \"" << s_streams << "\" of object " << this << " is empty";
              throw dunedaq::conffwk::Generic(ERS_HERE, text.str().c_str());
            }
          return m_streams;
        }

get_streams() [2/2]

const std::vector< const dunedaq::confmodel::DetectorStream * > & dunedaq::confmodel::DetDataSender::get_streams ( ) const

inline

Get "streams" relationship value.

Returns

the relationship value

Exceptions

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

Definition at line 102 of file DetDataSender.hpp.

        {
          std::lock_guard scoped_lock(m_mutex);
          check();
          check_init();
          if (m_streams.empty())
            {
              std::ostringstream text;
              text << "relationship \"" << s_streams << "\" of object " << this << " is empty";
              throw dunedaq::conffwk::Generic(ERS_HERE, text.str().c_str());
            }
          return m_streams;
        }

init() [1/2]

void dunedaq::confmodel::DetDataSender::init ( bool init_children )

protectedvirtual

Initialize object (method generated by genconffwk)

Parameters

init_children

if true, initialize referenced objects

Reimplemented from dunedaq::confmodel::ResourceSetDisableAND.

Reimplemented in dunedaq::appmodel::FakeDataSender, dunedaq::appmodel::FakeDataSender, dunedaq::appmodel::FelixDataSender, dunedaq::appmodel::FelixDataSender, dunedaq::appmodel::HermesDataSender, dunedaq::appmodel::HermesDataSender, dunedaq::appmodel::NWDetDataSender, dunedaq::appmodel::NWDetDataSender, dunedaq::appmodel::SocketDataSender, dunedaq::appmodel::SocketDataSender, dunedaq::appmodel::TdeAmcDetDataSender, dunedaq::appmodel::TdeAmcDetDataSender, dunedaq::confmodel::DummySender, and dunedaq::confmodel::DummySender.

Definition at line 55 of file DetDataSender.cpp.

    {
      ResourceSetDisableAND::init(init_children);
 
      TLOG_DEBUG(5) << "read object " << this << " (class " << s_class_name << ')';
 
      try {
        p_registry._ref<dunedaq::confmodel::DetectorStream>(p_obj, s_streams, m_streams, init_children);
      }
      catch (dunedaq::conffwk::Exception & ex) {
        throw_init_ex(ex);
      }
    }

init() [2/2]

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

protectedvirtual

Initialize object (method generated by genconffwk)

Parameters

init_children

if true, initialize referenced objects

Reimplemented from dunedaq::confmodel::ResourceSetDisableAND.

Reimplemented in dunedaq::appmodel::FakeDataSender, dunedaq::appmodel::FakeDataSender, dunedaq::appmodel::FelixDataSender, dunedaq::appmodel::FelixDataSender, dunedaq::appmodel::HermesDataSender, dunedaq::appmodel::HermesDataSender, dunedaq::appmodel::NWDetDataSender, dunedaq::appmodel::NWDetDataSender, dunedaq::appmodel::SocketDataSender, dunedaq::appmodel::SocketDataSender, dunedaq::appmodel::TdeAmcDetDataSender, dunedaq::appmodel::TdeAmcDetDataSender, dunedaq::confmodel::DummySender, and dunedaq::confmodel::DummySender.

print() [1/2]

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

virtual

Print details of the DetDataSender 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::ResourceSetDisableAND.

Reimplemented in dunedaq::appmodel::FakeDataSender, dunedaq::appmodel::FakeDataSender, dunedaq::appmodel::FelixDataSender, dunedaq::appmodel::FelixDataSender, dunedaq::appmodel::HermesDataSender, dunedaq::appmodel::HermesDataSender, dunedaq::appmodel::NWDetDataSender, dunedaq::appmodel::NWDetDataSender, dunedaq::appmodel::SocketDataSender, dunedaq::appmodel::SocketDataSender, dunedaq::appmodel::TdeAmcDetDataSender, dunedaq::appmodel::TdeAmcDetDataSender, dunedaq::confmodel::DummySender, and dunedaq::confmodel::DummySender.

Definition at line 29 of file DetDataSender.cpp.

    {
      check_init();
 
      try {
        const std::string str(indent+2, ' ');
 
        if (print_header)
          p_hdr(s, indent, s_class_name, "dunedaq::confmodel");
 
 
          // print direct super-classes
 
        dunedaq::confmodel::ResourceSetDisableAND::print(indent, false, s);
 
 
          // print direct relationships
 
        dunedaq::conffwk::p_mv_rel(s, str, s_streams, m_streams);
      }
      catch (dunedaq::conffwk::Exception & ex) {
        dunedaq::conffwk::DalObject::p_error(s, ex);
      }
    }

print() [2/2]

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

virtual

Print details of the DetDataSender 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::ResourceSetDisableAND.

Reimplemented in dunedaq::appmodel::FakeDataSender, dunedaq::appmodel::FakeDataSender, dunedaq::appmodel::FelixDataSender, dunedaq::appmodel::FelixDataSender, dunedaq::appmodel::HermesDataSender, dunedaq::appmodel::HermesDataSender, dunedaq::appmodel::NWDetDataSender, dunedaq::appmodel::NWDetDataSender, dunedaq::appmodel::SocketDataSender, dunedaq::appmodel::SocketDataSender, dunedaq::appmodel::TdeAmcDetDataSender, dunedaq::appmodel::TdeAmcDetDataSender, dunedaq::confmodel::DummySender, and dunedaq::confmodel::DummySender.

set_streams() [1/2]

void dunedaq::confmodel::DetDataSender::set_streams

(

const std::vector< const dunedaq::confmodel::DetectorStream * > &

value

)

Set "streams" relationship value.

Parameters

value

new relationship value

Exceptions

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

Definition at line 104 of file DetDataSender.cpp.

    {
      _set_objects(s_streams, value);
    }

set_streams() [2/2]

void dunedaq::confmodel::DetDataSender::set_streams

(

const std::vector< const dunedaq::confmodel::DetectorStream * > &

value

)

Set "streams" relationship value.

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 34 of file DetDataSender.hpp.

conffwk::DalFactory

conffwk::DalFactory

friend

Definition at line 36 of file DetDataSender.hpp.

conffwk::DalObject

conffwk::DalObject

friend

Definition at line 35 of file DetDataSender.hpp.

conffwk::DalRegistry

conffwk::DalRegistry

friend

Definition at line 37 of file DetDataSender.hpp.

Member Data Documentation

m_streams

std::vector< const dunedaq::confmodel::DetectorStream * > dunedaq::confmodel::DetDataSender::m_streams

private

Definition at line 83 of file DetDataSender.hpp.

s_class_name

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

static

The name of the configuration class.

Definition at line 49 of file DetDataSender.hpp.

s_streams

static const std::string dunedaq::confmodel::DetDataSender::s_streams = "streams"

inlinestatic

Definition at line 90 of file DetDataSender.hpp.

---

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

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