The base class for any generated DAL object. More...

#include <DalObject.hpp>

Collaboration diagram for dunedaq::conffwk::DalObject:

[legend]

Public Member Functions
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)

virtual std::vector< const DalObject * >	get (const std::string &name, bool upcast_unregistered=true) const =0

virtual void	print (unsigned int offset, bool print_header, std::ostream &s) const =0

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 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 Member Functions
	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

virtual void	init (bool init_children)=0

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.

Protected Attributes
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)

Private Member Functions
	DalObject (const DalObject &)=delete

DalObject &	operator= (const DalObject &)=delete

Friends
class	Configuration

class	DalFactoryFunctions

class	DalRegistry

std::ostream &	operator<< (std::ostream &s, const DalObject *obj)

Detailed Description

The base class for any generated DAL object.

The class provides common methods for any DAL object such as:

class_name() access object's database class name
UID() access object's unique identity
full_name() full object's name returned as string
config_object() provide access to the representation of object at conffwk layer

Several methods below are used to set state of the object and normally should only be used internally by generated DAL and algorithms:

unread() mark object as non-read to re-read values of attributes and relationships from conffwk object
remove() mark object as deleted
was_removed() return state of object's removal
set() assign conffwk object

Definition at line 44 of file DalObject.hpp.

Constructor & Destructor Documentation

◆ DalObject() [1/2]

dunedaq::conffwk::DalObject::DalObject	(	DalRegistry &	db,
		const ConfigObject &	o )

inlineprotectednoexcept

The constructor of DAL object.

Definition at line 60 of file DalObject.hpp.

                                                             :
    p_was_read(false), p_registry(db), p_obj(o), p_UID(p_obj.UID())
    {
      increment_created();
    }

◆ ~DalObject()

virtual dunedaq::conffwk::DalObject::~DalObject ( )

inlineprotectedvirtual

Definition at line 66 of file DalObject.hpp.

    {
      ;
    }

◆ DalObject() [2/2]

dunedaq::conffwk::DalObject::DalObject ( const DalObject & )

privatedelete

Member Function Documentation

◆ _set_object()

template<typename T >

void dunedaq::conffwk::DalObject::_set_object	(	const std::string &	name,
		const T *	value )

inlineprotected

Helper method for generated set single-value relationship methods.

Definition at line 417 of file DalObject.hpp.

    {
      std::lock_guard<std::mutex> scoped_lock(m_mutex);
      check();
      clear();
      p_obj.set_obj(name, (value ? &value->config_object() : (ConfigObject*) nullptr));
    }

◆ _set_objects()

template<typename T >

void dunedaq::conffwk::DalObject::_set_objects	(	const std::string &	name,
		const std::vector< const T * > &	value )

inlineprotected

Helper method for generated set multi-value relationship methods.

Definition at line 428 of file DalObject.hpp.

    {
      std::lock_guard<std::mutex> scoped_lock(m_mutex);
      check();
      clear();
      std::vector<const ConfigObject*> v;
      for (auto &i : value)
        v.push_back(&(i->config_object()));
      p_obj.set_objs(name, v);
    }

◆ cast()

template<class TARGET >

const TARGET * dunedaq::conffwk::DalObject::cast ( ) const

inlinenoexcept

Casts object to different class.

Try to cast object to an object of TARGET class. Returns nullptr if not successful. Do not use the normal dynamic_cast<T>() for database classes.

Returns: Return pointer to DAL object of required template or nullptr if the cast is not successful.

Definition at line 172 of file DalObject.hpp.

    {
      // std::lock_guard<std::mutex> scoped_lock(m_mutex);
      // return const_cast<Configuration&>(p_registry).cast<TARGET>(this);
      return dynamic_cast<const TARGET*>(this);
    }

◆ castable() [1/2]

bool dunedaq::conffwk::DalObject::castable ( const std::string & target ) const

inlinenoexcept

Check possibility to cast given object to a new class. The method returns true, if given object can be casted to target class (i.e. the target class is one of superclasses of given object)

Definition at line 148 of file DalObject.hpp.

    {
      return p_registry.configuration().is_superclass_of(target, *p_obj.m_impl->m_class_name);
    }

◆ castable() [2/2]

bool dunedaq::conffwk::DalObject::castable ( const std::string * target ) const

inlinenoexcept

Same as castable(const std::string& target), but uses pointers returned by the DalFactory (more efficient)

Definition at line 157 of file DalObject.hpp.

    {
      return p_registry.configuration().is_superclass_of(target, p_obj.m_impl->m_class_name);
    }

◆ check()

void dunedaq::conffwk::DalObject::check ( ) const

inlineprotected

The method checks state of object and throws exception if it was deleted.

Exceptions

dunedaq::conffwk::DeletedObject if object was deleted

Definition at line 87 of file DalObject.hpp.

    {
      p_obj.m_impl->throw_if_deleted();
    }

◆ check_init()

void dunedaq::conffwk::DalObject::check_init ( ) const

inlineprotected

Check and initialize object if necessary.

Definition at line 405 of file DalObject.hpp.

    {
      if(!p_was_read)
        {
          std::lock_guard<std::mutex> scoped_lock(this->p_registry.m_mutex);
          const_cast<DalObject*>(this)->init(false);
        }
    }

◆ class_name()

const std::string & dunedaq::conffwk::DalObject::class_name ( ) const

inlinenoexcept

Returns class name of the template object.

Definition at line 137 of file DalObject.hpp.

    {
      return p_obj.class_name();
    }

◆ clear()

void dunedaq::conffwk::DalObject::clear ( )

inlineprotectednoexcept

The method resets state of object. When accessed next time, it will be completely re-read from implementation.

Definition at line 76 of file DalObject.hpp.

    {
      p_obj._clear();
    }

◆ config_object()

const ConfigObject & dunedaq::conffwk::DalObject::config_object ( ) const

inline

Returns reference on the ConfigObject used by this template object.

Exceptions

dunedaq::conffwk::DeletedObject if object was deleted

Definition at line 199 of file DalObject.hpp.

    {
      std::lock_guard<std::mutex> scoped_lock(m_mutex);
      check();
      return p_obj;
    }

◆ configuration()

Configuration & dunedaq::conffwk::DalObject::configuration ( ) const

inlinenoexcept

Returns reference on the configuration object.

Definition at line 219 of file DalObject.hpp.

    {
      return p_registry.configuration();
    }

◆ full_name()

std::string dunedaq::conffwk::DalObject::full_name ( ) const

inlinenoexcept

Returns fullname of object in obj-id@class-name format.

Definition at line 185 of file DalObject.hpp.

    {
      std::lock_guard<std::mutex> scoped_lock(m_mutex);
      return (p_UID + '@' + class_name());
    }

◆ get()

virtual std::vector< const DalObject * > dunedaq::conffwk::DalObject::get	(	const std::string &	name,
		bool	upcast_unregistered = true ) const

pure virtual

◆ get_algo_objects()

bool dunedaq::conffwk::DalObject::get_algo_objects	(	const std::string &	name,
		std::vector< const DalObject * > &	objs ) const

protected

Run algorithm and return result as DAL objects using DAL factory.

Definition at line 25 of file DalObject.cpp.

{
    // FIXME: Remove
//   const std::string &suitable_dal_class = DalFactory::instance().class4algo(p_registry, class_name(), name);
 
//   TLOG_DEBUG(2) << "suitable class for algorithm " << name << " on object " << this << " is " << suitable_dal_class;
 
//   if (!suitable_dal_class.empty())
//     if (const DalObject *obj = p_registry.make_dal_object(const_cast<conffwk::ConfigObject&>(p_obj), UID(), suitable_dal_class))
//       {
//         obj->get(name, false).swap(objs);
//         return true;
//       }
 
  return false;
}

◆ get_rel_objects()

bool dunedaq::conffwk::DalObject::get_rel_objects	(	const std::string &	name,
		bool	upcast_unregistered,
		std::vector< const DalObject * > &	objs ) const

protected

Read relationship values as DAL objects using DAL factory.

Definition at line 8 of file DalObject.cpp.

{
  std::vector<conffwk::ConfigObject> c_objs;
 
  if (const_cast<conffwk::ConfigObject*>(&p_obj)->rel(name, c_objs))
    {
      // Fixme: what about the lock?
      // std::lock_guard<std::mutex> scoped_lock(p_registry.m_tmpl_mutex);
      p_registry.get(c_objs, upcast_unregistered).swap(objs);
      return true;
    }
 
  return false;
}

◆ increment_created()

void dunedaq::conffwk::DalObject::increment_created ( )

inlineprotectednoexcept

Increment counter of created template objects (is used by the configuration profiler)

Definition at line 343 of file DalObject.hpp.

    {
      // ++(p_registry.p_number_of_template_object_created);
    }

◆ increment_read()

void dunedaq::conffwk::DalObject::increment_read ( )

inlineprotectednoexcept

Increment counter of read template objects (is used by the configuration profiler)

Definition at line 352 of file DalObject.hpp.

    {
      // ++(p_registry.p_number_of_template_object_read);
    }

◆ init()

virtual void dunedaq::conffwk::DalObject::init ( bool init_children )

protectedpure virtual

Initialize object (method generated by genconffwk)

Parameters

init_children if true, initialize referenced objects

◆ is_deleted()

bool dunedaq::conffwk::DalObject::is_deleted ( ) const

inlineprotected

The method checks state of object and throws exception if it was deleted.

Exceptions

dunedaq::conffwk::Exception in case of problems

Definition at line 99 of file DalObject.hpp.

    {
      return (p_obj.m_impl->is_deleted());
    }

◆ is_null()

static bool dunedaq::conffwk::DalObject::is_null ( const DalObject * ref )

inlinestaticnoexcept

check a pointer on DAL object is null

Definition at line 328 of file DalObject.hpp.

    {
      return (ref == nullptr);
    }

◆ move()

void dunedaq::conffwk::DalObject::move ( const std::string & at )

inline

Move object to another file.

Parameters

at	new file name

Definition at line 256 of file DalObject.hpp.

    {
      p_obj.move(at);
    }

◆ operator=()

DalObject & dunedaq::conffwk::DalObject::operator= ( const DalObject & )

privatedelete

◆ p_error()

void dunedaq::conffwk::DalObject::p_error	(	std::ostream &	s,
		dunedaq::conffwk::Exception &	ex )

static

print error text

Definition at line 59 of file DalObject.cpp.

{
  s << "ERROR in generated DAL print method:\n\twas caused by: " << ex << std::endl;
}

◆ p_hdr()

void dunedaq::conffwk::DalObject::p_hdr	(	std::ostream &	s,
		unsigned int	indent,
		const std::string &	cl,
		const char *	nm = nullptr ) const

print object headers

Definition at line 65 of file DalObject.cpp.

{
  const std::string str(indent, ' ');
  s << str;
  if (nm)
    s << nm << ' ';
  s << cl << " object:\n" << str << "  id: \'" << UID() << "\', class name: \'" << DalObject::class_name() << "\'\n";
}

◆ p_null()

void dunedaq::conffwk::DalObject::p_null ( std::ostream & s )

static

print "(null)"

Definition at line 47 of file DalObject.cpp.

{
  s << "(null)";
}

◆ p_rm()

void dunedaq::conffwk::DalObject::p_rm ( std::ostream & s )

static

print "(deleted object)"

Definition at line 53 of file DalObject.cpp.

{
  s << "(deleted object)";
}

◆ print()

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

pure virtual

Print object details (method generated by genconffwk)

Parameters

offset	shift output
print_header	print header describing object (avoid when call this method for a base class from derived)
s	output stream

Exceptions

conffwk::Exception in case of problems (e.g. OKS schema / generated DAL mismatch)

◆ print_object()

std::ostream & dunedaq::conffwk::DalObject::print_object ( std::ostream & s ) const

inline

print object details

Definition at line 302 of file DalObject.hpp.

    {
      if(DalObject::is_null(this))
        {
          DalObject::p_null(s);
        }
      else if(p_obj.m_impl->m_state != dunedaq::conffwk::Valid)
        {
          DalObject::p_rm(s);
        }
      else
        {
          print(0, true, s);
        }
 
      return s;
    }

◆ registry()

DalRegistry & dunedaq::conffwk::DalObject::registry ( ) const

inlinenoexcept

Returns reference on the configuration object.

Definition at line 210 of file DalObject.hpp.

    {
      return p_registry;
    }

◆ rename()

void dunedaq::conffwk::DalObject::rename ( const std::string & new_id )

inline

Rename object.

Parameters

new_id new ID of object

Definition at line 266 of file DalObject.hpp.

    {
      p_obj.rename(new_id);
    }

◆ set()

void dunedaq::conffwk::DalObject::set ( const ConfigObject & o )

inlinenoexcept

Sets the ConfigObject to be used by this template object.

Parameters

o	the conffwk object

Definition at line 245 of file DalObject.hpp.

    {
      p_obj = o;
    }

◆ throw_get_ex()

void dunedaq::conffwk::DalObject::throw_get_ex	(	const std::string &	what,
		const std::string &	class_name,
		const DalObject *	obj )

static

throw exception in generated get method (i.e.

Exceptions

dunedaq::conffwk::Generic)

Definition at line 82 of file DalObject.cpp.

{
  std::ostringstream text;
  text << "cannot find relationship or algorithm \"" << what << "\" in c++ class \"" << class_name << "\" for object " << obj;
  throw dunedaq::conffwk::Generic(ERS_HERE, text.str().c_str());
}

◆ throw_init_ex()

void dunedaq::conffwk::DalObject::throw_init_ex ( dunedaq::conffwk::Exception & ex )

throw object initialisation exception (i.e.

Exceptions

dunedaq::conffwk::Generic)

Definition at line 74 of file DalObject.cpp.

{
  std::ostringstream text;
  text << "failed to init " << this << ":\n\twas caused by: " << ex << std::endl;
  p_was_read = false;
  throw dunedaq::conffwk::Generic (ERS_HERE, text.str().c_str());
}

◆ UID()

const std::string & dunedaq::conffwk::DalObject::UID ( ) const

inlinenoexcept

Returns template object ID.

Definition at line 128 of file DalObject.hpp.

    {
      return p_UID;
    }

◆ unread()

void dunedaq::conffwk::DalObject::unread ( )

inline

Is used to mark template object as non-read, i.e. it's attributes will be read from the implementation object during next access of an attribute

Exceptions

dunedaq::conffwk::DeletedObject if object was deleted

Definition at line 232 of file DalObject.hpp.

    {
      std::lock_guard<std::mutex> scoped_lock(m_mutex);
      check();
      p_was_read = false;
    }

Friends And Related Symbol Documentation

◆ Configuration

friend class Configuration

friend

Definition at line 47 of file DalObject.hpp.

◆ DalFactoryFunctions

friend class DalFactoryFunctions

friend

Definition at line 48 of file DalObject.hpp.

◆ DalRegistry

friend class DalRegistry

friend

Definition at line 49 of file DalObject.hpp.

◆ operator<<

std::ostream & operator<<	(	std::ostream &	s,
		const DalObject *	obj )

friend

Operator to print any template's object pointer in 'obj-id@class-name' format

Definition at line 90 of file DalObject.cpp.

{
  if (obj == nullptr)
    DalObject::p_null(s);
  else if (obj->is_deleted())
    s << "(deleted object " << obj->UID() << '@' << obj->class_name() << ')';
  else
    s << '\'' << obj->UID() << '@' << obj->class_name() << '\'';
 
  return s;
}

Member Data Documentation

◆ m_mutex

std::mutex dunedaq::conffwk::DalObject::m_mutex

mutableprotected

Used to protect changes of DAL object.

Definition at line 108 of file DalObject.hpp.

◆ p_obj

ConfigObject dunedaq::conffwk::DalObject::p_obj

protected

Config object used by given template object.

Definition at line 117 of file DalObject.hpp.

◆ p_registry

DalRegistry& dunedaq::conffwk::DalObject::p_registry

protected

Configuration object.

Definition at line 114 of file DalObject.hpp.

◆ p_UID

std::string dunedaq::conffwk::DalObject::p_UID

protected

Is used for template objects (see dqm_conffwk)

Definition at line 120 of file DalObject.hpp.

◆ p_was_read

bool dunedaq::conffwk::DalObject::p_was_read

protected

is true, if the object was read

Definition at line 111 of file DalObject.hpp.

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

/github/workspace/dunedaq/sourcecode/conffwk/include/conffwk/DalObject.hpp
/github/workspace/dunedaq/sourcecode/conffwk/src/DalObject.cpp

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Private Member Functions

Friends

Detailed Description

Constructor & Destructor Documentation

◆ DalObject() [1/2]

◆ ~DalObject()

◆ DalObject() [2/2]

Member Function Documentation

◆ _set_object()

◆ _set_objects()

◆ cast()

◆ castable() [1/2]

◆ castable() [2/2]

◆ check()

◆ check_init()

◆ class_name()

◆ clear()

◆ config_object()

◆ configuration()

◆ full_name()

◆ get()

◆ get_algo_objects()

◆ get_rel_objects()

◆ increment_created()

◆ increment_read()

◆ init()

◆ is_deleted()

◆ is_null()

◆ move()

◆ operator=()

◆ p_error()

◆ p_hdr()

◆ p_null()

◆ p_rm()

◆ print()

◆ print_object()

◆ registry()

◆ rename()

◆ set()

◆ throw_get_ex()

◆ throw_init_ex()

◆ UID()

◆ unread()

Friends And Related Symbol Documentation

◆ Configuration

◆ DalFactoryFunctions

◆ DalRegistry

◆ operator<<

Member Data Documentation

◆ m_mutex

◆ p_obj

◆ p_registry

◆ p_UID

◆ p_was_read