dunedaq::confmodel::DummyExcludableEntitySet Class Reference

#include <DummyExcludableEntitySet.hpp>

Inheritance diagram for dunedaq::confmodel::DummyExcludableEntitySet:

Collaboration diagram for dunedaq::confmodel::DummyExcludableEntitySet:

Public Member Functions
virtual void	print (unsigned int offset, bool print_header, std::ostream &s) const
	Print details of the DummyExcludableEntitySet 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_items () const
	Get "items" relationship value.
void	set_items (const std::vector< const dunedaq::confmodel::ExcludableEntity * > &value)
	Set "items" relationship value.
virtual std::vector< const ExcludableEntity * >	contained_excludable_entities () const
virtual void	print (unsigned int offset, bool print_header, std::ostream &s) const
	Print details of the DummyExcludableEntitySet 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_items () const
	Get "items" relationship value.
void	set_items (const std::vector< const dunedaq::confmodel::ExcludableEntity * > &value)
	Set "items" relationship value.
virtual std::vector< const ExcludableEntity * >	contained_excludable_entities () const
Public Member Functions inherited from dunedaq::confmodel::ExcludableEntity
void	parents (const dunedaq::confmodel::Session &session, std::list< std::vector< const dunedaq::confmodel::ExcludableEntity * > > &parents) const
bool	is_excluded (const dunedaq::confmodel::ExcludableEntityTree &session) const
virtual bool	compute_excluded_state (const std::set< std::string > &) const
void	parents (const dunedaq::confmodel::Session &session, std::list< std::vector< const dunedaq::confmodel::ExcludableEntity * > > &parents) const
bool	is_excluded (const dunedaq::confmodel::ExcludableEntityTree &session) const
virtual bool	compute_excluded_state (const std::set< std::string > &) 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_items_str () noexcept
static const std::string &	__get_items_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_items = "items"
Static Public Attributes inherited from dunedaq::confmodel::ExcludableEntitySet
static const std::string &	s_class_name
Static Public Attributes inherited from dunedaq::confmodel::ExcludableEntity
static const std::string &	s_class_name

Protected Member Functions
	DummyExcludableEntitySet (conffwk::DalRegistry &db, const conffwk::ConfigObject &obj) noexcept
virtual	~DummyExcludableEntitySet () 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
	DummyExcludableEntitySet (conffwk::DalRegistry &db, const conffwk::ConfigObject &obj) noexcept
virtual	~DummyExcludableEntitySet () 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::ExcludableEntitySet
	ExcludableEntitySet (conffwk::DalRegistry &db, const conffwk::ConfigObject &obj) noexcept
virtual	~ExcludableEntitySet () noexcept
bool	get (const std::string &name, std::vector< const dunedaq::conffwk::DalObject * > &vec, bool upcast_unregistered, bool first_call) const
	ExcludableEntitySet (conffwk::DalRegistry &db, const conffwk::ConfigObject &obj) noexcept
virtual	~ExcludableEntitySet () 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::ExcludableEntity
	ExcludableEntity (conffwk::DalRegistry &db, const conffwk::ConfigObject &obj) noexcept
virtual	~ExcludableEntity () noexcept
bool	get (const std::string &name, std::vector< const dunedaq::conffwk::DalObject * > &vec, bool upcast_unregistered, bool first_call) const
	ExcludableEntity (conffwk::DalRegistry &db, const conffwk::ConfigObject &obj) noexcept
virtual	~ExcludableEntity () 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::ExcludableEntity * >	m_items

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 23 of file DummyExcludableEntitySet.hpp.

Constructor & Destructor Documentation

DummyExcludableEntitySet() [1/2]

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

protectednoexcept

Definition at line 26 of file DummyExcludableEntitySet.cpp.

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

~DummyExcludableEntitySet() [1/2]

dunedaq::confmodel::DummyExcludableEntitySet::~DummyExcludableEntitySet ( )

protectedvirtualnoexcept

Definition at line 75 of file DummyExcludableEntitySet.cpp.

    {
    }

DummyExcludableEntitySet() [2/2]

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

protectednoexcept

~DummyExcludableEntitySet() [2/2]

virtual dunedaq::confmodel::DummyExcludableEntitySet::~DummyExcludableEntitySet ( )

protectedvirtualnoexcept

Member Function Documentation

__get_items_str() [1/2]

const std::string & dunedaq::confmodel::DummyExcludableEntitySet::__get_items_str ( )

inlinestaticnoexcept

Definition at line 83 of file DummyExcludableEntitySet.hpp.

{ return s_items; }

__get_items_str() [2/2]

const std::string & dunedaq::confmodel::DummyExcludableEntitySet::__get_items_str ( )

inlinestaticnoexcept

Definition at line 83 of file DummyExcludableEntitySet.hpp.

{ return s_items; }

contained_excludable_entities() [1/2]

std::vector< const ExcludableEntity * > dunedaq::confmodel::DummyExcludableEntitySet::contained_excludable_entities ( ) const

virtual

Virtual method to obtain the list of all contained ExcludableEntitys. Used internally by the core exclusion logic. Not intended to be used in application code as that should be using individual relationships of the derived classes.

Implements dunedaq::confmodel::ExcludableEntitySet.

Definition at line 117 of file DummyExcludableEntitySet.cpp.

    {
return to_resources(get_items());
    }

contained_excludable_entities() [2/2]

virtual std::vector< const ExcludableEntity * > dunedaq::confmodel::DummyExcludableEntitySet::contained_excludable_entities ( ) const

virtual

Virtual method to obtain the list of all contained ExcludableEntitys. Used internally by the core exclusion logic. Not intended to be used in application code as that should be using individual relationships of the derived classes.

Implements dunedaq::confmodel::ExcludableEntitySet.

get() [1/4]

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

Definition at line 79 of file DummyExcludableEntitySet.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::DummyExcludableEntitySet::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::ExcludableEntitySet.

get() [3/4]

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

protected

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

protected

get_items() [1/2]

const std::vector< const dunedaq::confmodel::ExcludableEntity * > & dunedaq::confmodel::DummyExcludableEntitySet::get_items ( ) const

inline

Get "items" relationship value.

Returns

the relationship value

Exceptions

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

Definition at line 93 of file DummyExcludableEntitySet.hpp.

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

get_items() [2/2]

const std::vector< const dunedaq::confmodel::ExcludableEntity * > & dunedaq::confmodel::DummyExcludableEntitySet::get_items ( ) const

inline

Get "items" relationship value.

Returns

the relationship value

Exceptions

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

Definition at line 93 of file DummyExcludableEntitySet.hpp.

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

init() [1/2]

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

protectedvirtual

Initialize object (method generated by genconffwk)

Parameters

init_children

if true, initialize referenced objects

Reimplemented from dunedaq::confmodel::ExcludableEntitySet.

Definition at line 61 of file DummyExcludableEntitySet.cpp.

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

init() [2/2]

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

protectedvirtual

Initialize object (method generated by genconffwk)

Parameters

init_children

if true, initialize referenced objects

Reimplemented from dunedaq::confmodel::ExcludableEntitySet.

print() [1/2]

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

virtual

Print details of the DummyExcludableEntitySet 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::ExcludableEntitySet.

Definition at line 35 of file DummyExcludableEntitySet.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::ExcludableEntitySet::print(indent, false, s);
 
 
          // print direct relationships
 
        dunedaq::conffwk::p_mv_rel(s, str, indent, s_items, m_items);
      }
      catch (dunedaq::conffwk::Exception & ex) {
        dunedaq::conffwk::DalObject::p_error(s, ex);
      }
    }

print() [2/2]

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

virtual

Print details of the DummyExcludableEntitySet 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::ExcludableEntitySet.

set_items() [1/2]

void dunedaq::confmodel::DummyExcludableEntitySet::set_items

(

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

value

)

Set "items" relationship value.

Parameters

value

new relationship value

Exceptions

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

Definition at line 110 of file DummyExcludableEntitySet.cpp.

    {
      _set_objects(s_items, value);
    }

set_items() [2/2]

void dunedaq::confmodel::DummyExcludableEntitySet::set_items

(

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

value

)

Set "items" 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 25 of file DummyExcludableEntitySet.hpp.

conffwk::DalFactory

conffwk::DalFactory

friend

Definition at line 27 of file DummyExcludableEntitySet.hpp.

conffwk::DalObject

conffwk::DalObject

friend

Definition at line 26 of file DummyExcludableEntitySet.hpp.

conffwk::DalRegistry

conffwk::DalRegistry

friend

Definition at line 28 of file DummyExcludableEntitySet.hpp.

Member Data Documentation

m_items

std::vector< const dunedaq::confmodel::ExcludableEntity * > dunedaq::confmodel::DummyExcludableEntitySet::m_items

private

Definition at line 74 of file DummyExcludableEntitySet.hpp.

s_class_name

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

static

The name of the configuration class.

Definition at line 40 of file DummyExcludableEntitySet.hpp.

s_items

const std::string dunedaq::confmodel::DummyExcludableEntitySet::s_items = "items"

inlinestatic

Definition at line 81 of file DummyExcludableEntitySet.hpp.

---

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

• /github/workspace/dunedaq/build/confmodel/codegen/include/confmodel/DummyExcludableEntitySet.hpp
• /github/workspace/dunedaq/build/confmodel/codegen/src/DummyExcludableEntitySet.hpp
• /github/workspace/dunedaq/build/confmodel/codegen/src/DummyExcludableEntitySet.cpp