dunedaq::confmodel::ExcludedEntities Class Reference

#include <ExcludedEntities.hpp>

Public Member Functions
	ExcludedEntities ()=default
	ExcludedEntities (const ExcludableEntitySet *root, std::vector< const ExcludableEntity * > initial_list)
	~ExcludedEntities ()=default
void	update (const ExcludableEntitySet *root, std::vector< const ExcludableEntity * > initial_list)
bool	is_included (const ExcludableEntity *component) const
bool	initialised () const

Private Member Functions
void	fill (const ExcludableEntitySet &rs, std::vector< const ExcludableEntitySet * > &all_resource_sets, std::set< const ExcludableEntity * > &simple_resources, TestCircularDependency &cd_fuse)
void	exclude (const ExcludableEntity &component)
void	exclude_children (const ExcludableEntitySet &)
size_t	size () noexcept

Private Attributes
std::set< std::string >	m_excluded
bool	m_initialised { false }

Friends
class	Session
class	ExcludableEntity

Detailed Description

Definition at line 15 of file ExcludedEntities.hpp.

Constructor & Destructor Documentation

ExcludedEntities() [1/2]

dunedaq::confmodel::ExcludedEntities::ExcludedEntities ( )

default

ExcludedEntities() [2/2]

ExcludedEntities::ExcludedEntities	(	const ExcludableEntitySet *	root,
		std::vector< const ExcludableEntity * >	initial_list )

Definition at line 18 of file ExcludedEntities.cpp.

{
  TLOG_DEBUG(2) << "construct the object from ExcludableEntity " << root->UID();
  update(root, initial_list);
}

~ExcludedEntities()

dunedaq::confmodel::ExcludedEntities::~ExcludedEntities ( )

default

Member Function Documentation

exclude()

void dunedaq::confmodel::ExcludedEntities::exclude ( const ExcludableEntity & component )

inlineprivate

Definition at line 29 of file ExcludedEntities.hpp.

{ m_excluded.insert(component.UID()); }

exclude_children()

void ExcludedEntities::exclude_children ( const ExcludableEntitySet & rs )

private

Definition at line 106 of file ExcludedEntities.cpp.

{
  TLOG_DEBUG(6) << "Excluding children of " << rs.UID();
  for (auto& res : rs.contained_excludable_entities()) {
    TLOG_DEBUG(6) << "Excluding child " << res->UID();
    exclude(*res);
    if (const auto* rs2 = res->cast<ExcludableEntitySet>()) {
      exclude_children(*rs2);
    }
  }
}

fill()

void ExcludedEntities::fill ( const ExcludableEntitySet & rs, std::vector< const ExcludableEntitySet * > & all_resource_sets, std::set< const ExcludableEntity * > & simple_resources, TestCircularDependency & cd_fuse )

private

Definition at line 84 of file ExcludedEntities.cpp.

{
  TLOG_DEBUG(6) << "es.UID=" << es.UID() << ", class=" << es.class_name();
  all_sets.push_back(&es);
  auto rptr = &es;
  if (rptr->cast<ExcludableEntity>() == nullptr) {
    throw(MissingConstructor(ERS_HERE, "ExcludableEntity", es.full_name()));
  }
  for (auto& res : es.contained_excludable_entities()) {
    AddTestOnCircularDependency add_fuse_test(cd_fuse, res);
    if (const ExcludableEntitySet* es2 = res->cast<ExcludableEntitySet>()) {
      fill(*es2, all_sets, simple_entities, cd_fuse);
    } else {
      simple_entities.insert(res);
    }
  }
}

initialised()

bool dunedaq::confmodel::ExcludedEntities::initialised ( ) const

inlinenodiscard

Definition at line 45 of file ExcludedEntities.hpp.

{ return m_initialised; }

is_included()

bool dunedaq::confmodel::ExcludedEntities::is_included ( const ExcludableEntity * component ) const

inline

Definition at line 43 of file ExcludedEntities.hpp.

{ return !m_excluded.contains(component->UID()); }

size()

size_t dunedaq::confmodel::ExcludedEntities::size ( )

inlineprivatenoexcept

Definition at line 33 of file ExcludedEntities.hpp.

{ return m_excluded.size(); }

update()

void ExcludedEntities::update	(	const ExcludableEntitySet *	root,
		std::vector< const ExcludableEntity * >	initial_list )

Definition at line 25 of file ExcludedEntities.cpp.

{
 
  m_excluded.clear();
 
  m_initialised = true;
 
  // get list of all root's entities-sets also test any
  // circular dependencies between segments and entity sets
  TestCircularDependency cd_fuse("component \'is-excluded\' status", root);
  std::vector<const ExcludableEntitySet*> sets;
  std::set<const ExcludableEntity*> simple_entities;
  fill(*root, sets, simple_entities, cd_fuse);
 
  for (auto& comp : initial_list) {
    exclude(*comp);
    TLOG_DEBUG(6) << comp->UID() << " is excluded in session";
    if (const ExcludableEntitySet* rs = comp->cast<ExcludableEntitySet>()) {
      exclude_children(*rs);
    }
  }
 
  for (unsigned long count = 1; true; ++count) {
    const unsigned long num(size()); // Remember current size
 
    TLOG_DEBUG(6) << "before auto-exclusion iteration " << count << " the number of excluded components is " << num;
    for (const auto& set : sets) {
      if (is_included(set)) {
        if (set->compute_excluded_state(m_excluded)) {
          TLOG_DEBUG(6) << "Exclude custom entity-set- " << set->UID() << " because children are excluded";
          exclude(*set);
          exclude_children(*set);
        }
      }
    }
 
    for (auto& en : simple_entities) {
      if (is_included(en) && en->compute_excluded_state(m_excluded)) {
        TLOG_DEBUG(6) << "Marking " << en->UID() << " as excluded\n";
        exclude(*en);
      }
    }
 
    if (size() == num) {
      TLOG_DEBUG(6) << "after " << count
                    << " iteration(s) auto-exclusion algorithm found no newly excluded sets, exiting loop ...";
      break;
    }
 
    unsigned int iLimit(1000);
    if (count > iLimit) {
      ers::error(ReadMaxAllowedIterations(ERS_HERE, iLimit));
      break;
    }
  }
}

Friends And Related Symbol Documentation

ExcludableEntity

friend class ExcludableEntity

friend

Definition at line 19 of file ExcludedEntities.hpp.

Session

friend class Session

friend

Definition at line 18 of file ExcludedEntities.hpp.

Member Data Documentation

m_excluded

std::set<std::string> dunedaq::confmodel::ExcludedEntities::m_excluded

private

Definition at line 22 of file ExcludedEntities.hpp.

m_initialised

bool dunedaq::confmodel::ExcludedEntities::m_initialised { false }

private

Definition at line 23 of file ExcludedEntities.hpp.

---

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

• /github/workspace/dunedaq/sourcecode/confmodel/include/confmodel/ExcludedEntities.hpp
• /github/workspace/dunedaq/sourcecode/confmodel/src/ExcludedEntities.cpp