dunedaq::confmodel::DisabledComponents Class Reference

#include <disabled-components.hpp>

Inheritance diagram for dunedaq::confmodel::DisabledComponents:

Collaboration diagram for dunedaq::confmodel::DisabledComponents:

Classes
struct	SortStringPtr

Public Member Functions
	DisabledComponents (dunedaq::conffwk::Configuration &db, Session *session)
virtual	~DisabledComponents ()
void	notify (std::vector< dunedaq::conffwk::ConfigurationChange * > &) noexcept
	Call action on database changes.
void	load () noexcept
	Call action on database file(s) load.
void	unload () noexcept
	Call action on database file(s) unload.
void	update (const dunedaq::conffwk::ConfigObject &obj, const std::string &name) noexcept
	Call action on database object modification by user's code.
void	reset () noexcept
size_t	size () noexcept
void	disable (const dunedaq::confmodel::Component &c)
bool	is_enabled (const dunedaq::confmodel::Component *c)
void	disable_children (const dunedaq::confmodel::ResourceSet &)
void	disable_children (const dunedaq::confmodel::Segment &)
Public Member Functions inherited from dunedaq::conffwk::ConfigAction
virtual	~ConfigAction ()

Static Public Member Functions
static unsigned long	get_num_of_slr_resources (const dunedaq::confmodel::Session &p)

Private Member Functions
void	__clear () noexcept

Private Attributes
dunedaq::conffwk::Configuration &	m_db
Session *	m_session
unsigned long	m_num_of_slr_enabled_resources
unsigned long	m_num_of_slr_disabled_resources
std::set< const std::string *, SortStringPtr >	m_disabled
std::set< const dunedaq::confmodel::Component * >	m_user_disabled
std::set< const dunedaq::confmodel::Component * >	m_user_enabled

Friends
class	Session
class	Component

Detailed Description

Definition at line 18 of file disabled-components.hpp.

Constructor & Destructor Documentation

DisabledComponents()

DisabledComponents::DisabledComponents	(	dunedaq::conffwk::Configuration &	db,
		Session *	session )

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

                   :
  m_db(db),
  m_session(session),
  m_num_of_slr_enabled_resources(0),
  m_num_of_slr_disabled_resources(0)
{
  TLOG_DEBUG(2) <<  "construct the object " << (void *)this  ;
  m_db.add_action(this);
}

~DisabledComponents()

DisabledComponents::~DisabledComponents ( )

virtual

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

{
  TLOG_DEBUG(2) <<  "destroy the object " << (void *)this ;
  m_db.remove_action(this);
}

Member Function Documentation

__clear()

void dunedaq::confmodel::DisabledComponents::__clear ( )

inlineprivatenoexcept

Definition at line 46 of file disabled-components.hpp.

      {
        m_disabled.clear();
        m_user_disabled.clear();
        m_user_enabled.clear();
        m_num_of_slr_enabled_resources = 0;
        m_num_of_slr_disabled_resources = 0;
      }

disable()

void dunedaq::confmodel::DisabledComponents::disable ( const dunedaq::confmodel::Component & c )

inline

Definition at line 84 of file disabled-components.hpp.

      {
        m_disabled.insert(&c.UID());
      }

disable_children() [1/2]

void DisabledComponents::disable_children

(

const dunedaq::confmodel::ResourceSet &

rs

)

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

{
  for (auto & res : rs.get_contains()) {
    disable(*res);
    if (const auto * rs2 = res->cast<ResourceSet>()) {
      disable_children(*rs2);
    }
  }
}

disable_children() [2/2]

void DisabledComponents::disable_children

(

const dunedaq::confmodel::Segment &

segment

)

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

{
  for (auto & app : segment.get_applications()) {
    auto res = app->cast<Component>();
    if (res) {
      disable(*res);
    }
  }
  for (auto & seg : segment.get_segments()) {
    TLOG_DEBUG(6) <<  "disable segment " << seg << " because it's parent segment " << &segment << " is disabled" ;
    disable(*seg);
    disable_children(*seg);
  }
}

get_num_of_slr_resources()

unsigned long DisabledComponents::get_num_of_slr_resources ( const dunedaq::confmodel::Session & p )

static

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

{
  return (session.m_disabled_components.m_num_of_slr_enabled_resources + session.m_disabled_components.m_num_of_slr_disabled_resources);
}

is_enabled()

bool dunedaq::confmodel::DisabledComponents::is_enabled ( const dunedaq::confmodel::Component * c )

inline

Definition at line 90 of file disabled-components.hpp.

                                                     {
        return (m_disabled.find(&c->UID()) == m_disabled.end());
      }

load()

void DisabledComponents::load ( )

virtualnoexcept

Call action on database file(s) load.

Implements dunedaq::conffwk::ConfigAction.

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

{
  TLOG_DEBUG(2) <<  "reset session components because of configuration load on object " << (void *)this ;
  __clear();
}

notify()

void DisabledComponents::notify ( std::vector< dunedaq::conffwk::ConfigurationChange * > & changes )

virtualnoexcept

Call action on database changes.

Implements dunedaq::conffwk::ConfigAction.

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

{
  TLOG_DEBUG(2) <<  "reset session components because of notification callback on object " << (void *)this ;
  __clear();
}

reset()

void DisabledComponents::reset ( )

noexcept

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

{
  TLOG_DEBUG(2) <<  "reset disabled by explicit user call" ;
  m_disabled.clear(); // do not clear s_user_disabled && s_user_enabled !!!
}

size()

size_t dunedaq::confmodel::DisabledComponents::size ( )

inlinenoexcept

Definition at line 78 of file disabled-components.hpp.

      {
        return m_disabled.size();
      }

unload()

void DisabledComponents::unload ( )

virtualnoexcept

Call action on database file(s) unload.

Implements dunedaq::conffwk::ConfigAction.

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

{
  TLOG_DEBUG(2) <<  "reset session components because of configuration unload on object " << (void *)this ;
  __clear();
}

update()

void DisabledComponents::update ( const dunedaq::conffwk::ConfigObject & obj, const std::string & name )

virtualnoexcept

Call action on database object modification by user's code.

Implements dunedaq::conffwk::ConfigAction.

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

{
  TLOG_DEBUG(2) <<  "reset session components because of configuration update (obj = " << obj << ", name = \'" << name << "\') on object " << (void *)this ;
  __clear();
}

Friends And Related Symbol Documentation

Component

friend class Component

friend

Definition at line 22 of file disabled-components.hpp.

Session

friend class Session

friend

Definition at line 21 of file disabled-components.hpp.

Member Data Documentation

m_db

dunedaq::conffwk::Configuration& dunedaq::confmodel::DisabledComponents::m_db

private

Definition at line 35 of file disabled-components.hpp.

m_disabled

std::set<const std::string *, SortStringPtr> dunedaq::confmodel::DisabledComponents::m_disabled

private

Definition at line 41 of file disabled-components.hpp.

m_num_of_slr_disabled_resources

unsigned long dunedaq::confmodel::DisabledComponents::m_num_of_slr_disabled_resources

private

Definition at line 39 of file disabled-components.hpp.

m_num_of_slr_enabled_resources

unsigned long dunedaq::confmodel::DisabledComponents::m_num_of_slr_enabled_resources

private

Definition at line 38 of file disabled-components.hpp.

m_session

Session* dunedaq::confmodel::DisabledComponents::m_session

private

Definition at line 36 of file disabled-components.hpp.

m_user_disabled

std::set<const dunedaq::confmodel::Component *> dunedaq::confmodel::DisabledComponents::m_user_disabled

private

Definition at line 42 of file disabled-components.hpp.

m_user_enabled

std::set<const dunedaq::confmodel::Component *> dunedaq::confmodel::DisabledComponents::m_user_enabled

private

Definition at line 43 of file disabled-components.hpp.

---

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

• /github/workspace/dunedaq/sourcecode/confmodel/include/confmodel/disabled-components.hpp
• /github/workspace/dunedaq/sourcecode/confmodel/src/disabled-components.cpp