#include <Component.hpp>

Inheritance diagram for dunedaq::confmodel::Component:

Collaboration diagram for dunedaq::confmodel::Component:

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

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

bool	disabled (const dunedaq::confmodel::Session &session) const

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

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

bool	disabled (const dunedaq::confmodel::Session &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

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

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

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

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

Abstract base class for Segment and Resource classes. It is only used to allow objects of derived classes to be put into list of disabled items. For more information read https://twiki.cern.ch/twiki/bin/viewauth/Atlas/DaqHltDal#3_4_Resource_Classes

Definition at line 33 of file Component.hpp.

Constructor & Destructor Documentation

◆ Component() [1/2]

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

protectednoexcept

Definition at line 15 of file Component.cpp.

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

◆ ~Component() [1/2]

dunedaq::confmodel::Component::~Component ( )

protectedvirtualnoexcept

Definition at line 44 of file Component.cpp.

45 {

46 }

◆ Component() [2/2]

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

protectednoexcept

◆ ~Component() [2/2]

virtual dunedaq::confmodel::Component::~Component ( )

protectedvirtualnoexcept

Member Function Documentation

◆ disabled() [1/2]

bool Component::disabled ( const dunedaq::confmodel::Session & session ) const

The algorithm checks if the segment / resource is disabled in the partition that uses it.

Parameters

partition partition object containing this resource or segment

Definition at line 224 of file disabled-components.cpp.

{
  TLOG_DEBUG( 6) << "Session UID: " << session.UID() << " this->UID()=" << UID();
  // fill disabled (e.g. after session changes)
 
  if (session.m_disabled_components.size() == 0) {
    if (session.get_disabled().empty() && 
        session.m_disabled_components.m_user_disabled.empty()) {
      TLOG_DEBUG( 6) << "Session has no disabled components";
      return false;  // the session has no disabled components
    }
    else {
      // get two lists of all session's resource-set-or and resource-set-and
      // also test any circular dependencies between segments and resource sets
      TestCircularDependency cd_fuse("component \'is-disabled\' status", &session);
      std::vector<const ResourceSetOR *> rs_or;
      std::vector<const ResourceSetAND *> rs_and;
      fill(session, rs_or, rs_and, cd_fuse);
 
      // calculate explicitly and implicitly (nested) disabled components
      {
        std::vector<const Component *> vector_of_disabled;
        vector_of_disabled.reserve(session.get_disabled().size() + session.m_disabled_components.m_user_disabled.size());
 
        // add user disabled components, if any
        for (auto & i : session.m_disabled_components.m_user_disabled) {
          vector_of_disabled.push_back(i);
          TLOG_DEBUG(6) <<  "disable component " << i->UID() << " because it is explicitly disabled by user" ;
        }
 
        // add session-disabled components ignoring explicitly enabled by user
        for (auto & i : session.get_disabled()) {
          TLOG_DEBUG(6) <<  "check component " << i->UID() << " explicitly disabled in session" ;
 
          if (session.m_disabled_components.m_user_enabled.find(i) == session.m_disabled_components.m_user_enabled.end()) {
            vector_of_disabled.push_back(i);
            TLOG_DEBUG(6) <<  "disable component " << i->UID() << " because it is not explicitly enabled in session" ;
          }
          else {
            TLOG_DEBUG(6) <<  "skip component " << i->UID() << " because it is enabled by user" ;
          }
        }
 
        // fill set of explicitly and implicitly (segment/resource-set containers) disabled components
        for (auto & i : vector_of_disabled) {
          session.m_disabled_components.disable(*i);
 
          if (const ResourceSet * rs = i->cast<ResourceSet>()) {
            session.m_disabled_components.disable_children(*rs);
          }
          else if (const Segment * seg = i->cast<Segment>()) {
            TLOG_DEBUG(6) << "Disabling children of segment " << seg->UID();
            session.m_disabled_components.disable_children(*seg);
          }
        }
      }
 
      for (unsigned long count = 1; true; ++count) {
        const unsigned long num(session.m_disabled_components.size());
 
        TLOG_DEBUG(6) <<  "before auto-disabling iteration " << count << " the number of disabled components is " << num ;
 
        TLOG_DEBUG(6) <<  "Session has " << rs_or.size() << " resourceSetORs";
        for (const auto& i : rs_or) {
          if (session.m_disabled_components.is_enabled(i)) {
            // check ANY child is disabled
            TLOG_DEBUG(6) << "ResourceSetOR " << i->UID() << " contains " << i->get_contains().size() << " resources";
            for (auto & i2 : i->get_contains()) {
              if (!session.m_disabled_components.is_enabled(i2)) {
                TLOG_DEBUG(6) <<  "disable resource-set-OR " << i->UID() << " because it's child " << i2 << " is disabled" ;
                session.m_disabled_components.disable(*i);
                session.m_disabled_components.disable_children(*i);
                break;
              }
            }
          }
        }
 
        TLOG_DEBUG(6) <<  "Session has " << rs_and.size() << " resourceSetANDs";
        for (const auto& j : rs_and) {
          if (session.m_disabled_components.is_enabled(j)) {
            const std::vector<const ResourceBase*> &resources = j->get_contains();
            TLOG_DEBUG(6) << "Checking " << resources.size() << " ResourceSetAND resources";
            if (!resources.empty()) {
              // check ANY child is enabled
              bool found_enabled = false;
              for (auto & j2 : resources) {
                if (session.m_disabled_components.is_enabled(j2)) {
                  found_enabled = true;
                  TLOG_DEBUG(6) << "Found enabled resource " << j2->UID();
                  break;
                }
              }
              if (found_enabled == false) {
                TLOG_DEBUG(6) <<  "disable resource-set-AND " << j->UID() << " because all it's children are disabled" ;
                session.m_disabled_components.disable(*j);
                session.m_disabled_components.disable_children(*j);
              }
            }
          }
        }
 
        if (session.m_disabled_components.size() == num) {
          TLOG_DEBUG(6) <<  "after " << count << " iteration(s) auto-disabling algorithm found no newly disabled sets, exiting loop ..." ;
          break;
        }
 
        unsigned int iLimit(1000);
        if (count > iLimit) {
          ers::error(ReadMaxAllowedIterations(ERS_HERE, iLimit));
          break;
        }
      }
    }
  }
 
  bool result(!session.m_disabled_components.is_enabled(this));
  TLOG_DEBUG( 6) <<  "disabled(" << this << ")  (UID=" << UID() << ") returns " << std::boolalpha << result  ;
  return result;
}

◆ disabled() [2/2]

bool dunedaq::confmodel::Component::disabled ( const dunedaq::confmodel::Session & session ) const

The algorithm checks if the segment / resource is disabled in the partition that uses it.

Parameters

partition partition object containing this resource or segment

◆ get() [1/4]

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

Definition at line 48 of file Component.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::Component::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.

◆ get() [3/4]

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

protected

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

protected

◆ get_parents() [1/2]

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

The algorithm calculates a vector of segments which are parents of given segment. If the segment has parents referenced by the partition object, then:

in case of C++ it fills the parents parameter; otherwise it throws NotFoundException exception

Definition at line 134 of file dalMethods.cpp.

{
  const ConfigObjectImpl * obj_impl = config_object().implementation();
 
  const bool is_segment = castable(dunedaq::confmodel::Segment::s_class_name);
 
  try {
    dunedaq::confmodel::TestCircularDependency cd_fuse("component parents", &session);
 
    // check session's segment
    check_segment(parents, session.get_segment(), obj_impl, is_segment,
                  cd_fuse);
 
 
    if (parents.empty()) {
      TLOG_DEBUG(1) <<  "cannot find segment/resource path(s) between Component " << this << " and session " << &session << " objects (check this object is linked with the session as a segment or a resource)" ;
    }
  }
  catch (ers::Issue & ex) {
    ers::error(CannotGetParents(ERS_HERE, full_name(), ex));
  }
}

◆ get_parents() [2/2]

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

The algorithm calculates a vector of segments which are parents of given segment. If the segment has parents referenced by the partition object, then:

in case of C++ it fills the parents parameter; otherwise it throws NotFoundException exception

◆ init() [1/2]

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

protectedvirtual

Initialize object (method generated by genconffwk)

Parameters

init_children if true, initialize referenced objects

Implements dunedaq::conffwk::DalObject.

Definition at line 37 of file Component.cpp.

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

◆ init() [2/2]

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

protectedvirtual

Initialize object (method generated by genconffwk)

Parameters

init_children if true, initialize referenced objects

Implements dunedaq::conffwk::DalObject.

◆ print() [1/2]

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

virtual

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

Definition at line 22 of file Component.cpp.

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

◆ print() [2/2]

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

virtual

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

Friends And Related Symbol Documentation

◆ conffwk::Configuration

conffwk::Configuration

friend

Definition at line 35 of file Component.hpp.

◆ conffwk::DalFactory

conffwk::DalFactory

friend

Definition at line 37 of file Component.hpp.

◆ conffwk::DalObject

conffwk::DalObject

friend

Definition at line 36 of file Component.hpp.

◆ conffwk::DalRegistry

conffwk::DalRegistry

friend

Definition at line 38 of file Component.hpp.

Member Data Documentation

◆ s_class_name

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

static

The name of the configuration class.

Definition at line 50 of file Component.hpp.

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

/github/workspace/dunedaq/build/confmodel/codegen/include/confmodel/Component.hpp
/github/workspace/dunedaq/build/confmodel/codegen/src/Component.hpp
/github/workspace/dunedaq/sourcecode/confmodel/src/dalMethods.cpp
/github/workspace/dunedaq/sourcecode/confmodel/src/disabled-components.cpp
/github/workspace/dunedaq/build/confmodel/codegen/src/Component.cpp

Public Member Functions

Static Public Attributes

Protected Member Functions

Friends

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ Component() [1/2]

◆ ~Component() [1/2]

◆ Component() [2/2]

◆ ~Component() [2/2]

Member Function Documentation

◆ disabled() [1/2]

◆ disabled() [2/2]

◆ get() [1/4]

◆ get() [2/4]

◆ get() [3/4]

◆ get() [4/4]

◆ get_parents() [1/2]

◆ get_parents() [2/2]

◆ 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