dunedaq::confmodel::ExcludableEntityTree Class Reference

#include <ExcludableEntityTree.hpp>

Inheritance diagram for dunedaq::confmodel::ExcludableEntityTree:

Collaboration diagram for dunedaq::confmodel::ExcludableEntityTree:

Public Member Functions
virtual void	print (unsigned int offset, bool print_header, std::ostream &s) const
	Print details of the ExcludableEntityTree 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::ExcludableEntity * > &	get_excluded () const
	Get "excluded" relationship value. ExcludableEntitys that should not participate in the current run.
void	set_excluded (const std::vector< const dunedaq::confmodel::ExcludableEntity * > &value)
	Set "excluded" relationship value. ExcludableEntitys that should not participate in the current run.
const dunedaq::confmodel::ExcludedEntities &	excluded_entities () const
virtual const ExcludableEntitySet *	root_entity () const =0
void	exclude (const ExcludableEntity *)
void	include (const ExcludableEntity *)
virtual void	print (unsigned int offset, bool print_header, std::ostream &s) const
	Print details of the ExcludableEntityTree 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::ExcludableEntity * > &	get_excluded () const
	Get "excluded" relationship value. ExcludableEntitys that should not participate in the current run.
void	set_excluded (const std::vector< const dunedaq::confmodel::ExcludableEntity * > &value)
	Set "excluded" relationship value. ExcludableEntitys that should not participate in the current run.
const dunedaq::confmodel::ExcludedEntities &	excluded_entities () const
virtual const ExcludableEntitySet *	root_entity () const =0
void	exclude (const ExcludableEntity *)
void	include (const ExcludableEntity *)
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_excluded_str () noexcept
static const std::string &	__get_excluded_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_excluded = "excluded"

Protected Member Functions
	ExcludableEntityTree (conffwk::DalRegistry &db, const conffwk::ConfigObject &obj) noexcept
virtual	~ExcludableEntityTree () 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
	ExcludableEntityTree (conffwk::DalRegistry &db, const conffwk::ConfigObject &obj) noexcept
virtual	~ExcludableEntityTree () 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.

Private Attributes
std::vector< const dunedaq::confmodel::ExcludableEntity * >	m_excluded
ExcludedEntities	m_excluded_entities

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 35 of file ExcludableEntityTree.hpp.

Constructor & Destructor Documentation

ExcludableEntityTree() [1/2]

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

protectednoexcept

Definition at line 20 of file ExcludableEntityTree.cpp.

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

~ExcludableEntityTree() [1/2]

dunedaq::confmodel::ExcludableEntityTree::~ExcludableEntityTree ( )

protectedvirtualnoexcept

Definition at line 62 of file ExcludableEntityTree.cpp.

    {
    }

ExcludableEntityTree() [2/2]

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

protectednoexcept

~ExcludableEntityTree() [2/2]

virtual dunedaq::confmodel::ExcludableEntityTree::~ExcludableEntityTree ( )

protectedvirtualnoexcept

Member Function Documentation

__get_excluded_str() [1/2]

const std::string & dunedaq::confmodel::ExcludableEntityTree::__get_excluded_str ( )

inlinestaticnoexcept

Definition at line 98 of file ExcludableEntityTree.hpp.

{ return s_excluded; }

__get_excluded_str() [2/2]

const std::string & dunedaq::confmodel::ExcludableEntityTree::__get_excluded_str ( )

inlinestaticnoexcept

Definition at line 98 of file ExcludableEntityTree.hpp.

{ return s_excluded; }

exclude() [1/2]

void dunedaq::confmodel::ExcludableEntityTree::exclude

(

const ExcludableEntity *

res

)

Add a component to the excluded relationship and recalculate the exclusion tree

Definition at line 368 of file dalMethods.cpp.

{
  auto excluded_vec = get_excluded();
  for (auto excluded_resource : excluded_vec) {
    if (excluded_resource == res) {
      return;
    }
  }
  excluded_vec.push_back(res);
 
  set_excluded(excluded_vec);
  configuration().update<ExcludableEntityTree>({ UID() }, {}, {});
 
  m_excluded_entities.update(root_entity(), excluded_vec);
}

exclude() [2/2]

void dunedaq::confmodel::ExcludableEntityTree::exclude

(

const ExcludableEntity *

)

Add a component to the excluded relationship and recalculate the exclusion tree

excluded_entities() [1/2]

const dunedaq::confmodel::ExcludedEntities & dunedaq::confmodel::ExcludableEntityTree::excluded_entities

(

)

const

Get a reference to the ExcludedEntities object of this ExcludableEntityTree, initialising it if it has not already been initialised.

Definition at line 106 of file ExcludableEntityTree.cpp.

    {
if (!m_excluded_entities.initialised()) {
 m_excluded_entities.update(root_entity(),get_excluded());
}
return m_excluded_entities;
    }

excluded_entities() [2/2]

const dunedaq::confmodel::ExcludedEntities & dunedaq::confmodel::ExcludableEntityTree::excluded_entities

(

)

const

Get a reference to the ExcludedEntities object of this ExcludableEntityTree, initialising it if it has not already been initialised.

get() [1/4]

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

Reimplemented in dunedaq::confmodel::Session, and dunedaq::confmodel::Session.

Definition at line 66 of file ExcludableEntityTree.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::ExcludableEntityTree::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.

Reimplemented in dunedaq::confmodel::Session, and dunedaq::confmodel::Session.

get() [3/4]

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

protected

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

protected

get_excluded() [1/2]

const std::vector< const dunedaq::confmodel::ExcludableEntity * > & dunedaq::confmodel::ExcludableEntityTree::get_excluded ( ) const

inline

Get "excluded" relationship value. ExcludableEntitys that should not participate in the current run.

Returns

the relationship value

Exceptions

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

Definition at line 109 of file ExcludableEntityTree.hpp.

        {
          std::lock_guard scoped_lock(m_mutex);
          check();
          check_init();
          return m_excluded;
        }

get_excluded() [2/2]

const std::vector< const dunedaq::confmodel::ExcludableEntity * > & dunedaq::confmodel::ExcludableEntityTree::get_excluded ( ) const

inline

Get "excluded" relationship value. ExcludableEntitys that should not participate in the current run.

Returns

the relationship value

Exceptions

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

Definition at line 109 of file ExcludableEntityTree.hpp.

        {
          std::lock_guard scoped_lock(m_mutex);
          check();
          check_init();
          return m_excluded;
        }

include() [1/2]

void dunedaq::confmodel::ExcludableEntityTree::include

(

const ExcludableEntity *

res

)

Definition at line 384 of file dalMethods.cpp.

{
  auto excluded_vec = get_excluded();
  auto count = std::erase(excluded_vec, res);
  if (count == 0) {
    return;
  }
  set_excluded(excluded_vec);
  configuration().update<ExcludableEntityTree>({ UID() }, {}, {});
 
  m_excluded_entities.update(root_entity(), excluded_vec);
}

include() [2/2]

void dunedaq::confmodel::ExcludableEntityTree::include

(

const ExcludableEntity *

)

init() [1/2]

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

protectedvirtual

Initialize object (method generated by genconffwk)

Parameters

init_children

if true, initialize referenced objects

Implements dunedaq::conffwk::DalObject.

Reimplemented in dunedaq::confmodel::Session, and dunedaq::confmodel::Session.

Definition at line 48 of file ExcludableEntityTree.cpp.

    {
      p_was_read = true;
      increment_read();
      TLOG_DEBUG(5) << "read object " << this << " (class " << s_class_name << ')';
 
      try {
        p_registry._ref<dunedaq::confmodel::ExcludableEntity>(p_obj, s_excluded, m_excluded, init_children);
      }
      catch (dunedaq::conffwk::Exception & ex) {
        throw_init_ex(ex);
      }
    }

init() [2/2]

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

protectedvirtual

Initialize object (method generated by genconffwk)

Parameters

init_children

if true, initialize referenced objects

Implements dunedaq::conffwk::DalObject.

Reimplemented in dunedaq::confmodel::Session, and dunedaq::confmodel::Session.

print() [1/2]

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

virtual

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

Reimplemented in dunedaq::confmodel::Session, and dunedaq::confmodel::Session.

Definition at line 27 of file ExcludableEntityTree.cpp.

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

print() [2/2]

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

virtual

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

Reimplemented in dunedaq::confmodel::Session, and dunedaq::confmodel::Session.

root_entity() [1/2]

virtual const ExcludableEntitySet * dunedaq::confmodel::ExcludableEntityTree::root_entity ( ) const

pure virtual

Pure virtual method to get the ExcludableEntitySet at the root of the ExcludableEntityTree.

Implemented in dunedaq::confmodel::Session, and dunedaq::confmodel::Session.

root_entity() [2/2]

virtual const ExcludableEntitySet * dunedaq::confmodel::ExcludableEntityTree::root_entity ( ) const

pure virtual

Pure virtual method to get the ExcludableEntitySet at the root of the ExcludableEntityTree.

Implemented in dunedaq::confmodel::Session, and dunedaq::confmodel::Session.

set_excluded() [1/2]

void dunedaq::confmodel::ExcludableEntityTree::set_excluded

(

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

value

)

Set "excluded" relationship value. ExcludableEntitys that should not participate in the current run.

Parameters

value

new relationship value

Exceptions

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

Definition at line 95 of file ExcludableEntityTree.cpp.

    {
      _set_objects(s_excluded, value);
    }

set_excluded() [2/2]

void dunedaq::confmodel::ExcludableEntityTree::set_excluded

(

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

value

)

Set "excluded" relationship value. ExcludableEntitys that should not participate in the current run.

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 37 of file ExcludableEntityTree.hpp.

conffwk::DalFactory

conffwk::DalFactory

friend

Definition at line 39 of file ExcludableEntityTree.hpp.

conffwk::DalObject

conffwk::DalObject

friend

Definition at line 38 of file ExcludableEntityTree.hpp.

conffwk::DalRegistry

conffwk::DalRegistry

friend

Definition at line 40 of file ExcludableEntityTree.hpp.

Member Data Documentation

m_excluded

std::vector< const dunedaq::confmodel::ExcludableEntity * > dunedaq::confmodel::ExcludableEntityTree::m_excluded

private

Definition at line 86 of file ExcludableEntityTree.hpp.

m_excluded_entities

ExcludedEntities dunedaq::confmodel::ExcludableEntityTree::m_excluded_entities

mutableprivate

Definition at line 89 of file ExcludableEntityTree.hpp.

s_class_name

const std::string & dunedaq::confmodel::ExcludableEntityTree::s_class_name

static

The name of the configuration class.

Definition at line 52 of file ExcludableEntityTree.hpp.

s_excluded

const std::string dunedaq::confmodel::ExcludableEntityTree::s_excluded = "excluded"

inlinestatic

Definition at line 96 of file ExcludableEntityTree.hpp.

---

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

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