dbe::config_object_description< S > Class Template Reference

#include <confobject_desc.hpp>

Inheritance diagram for dbe::config_object_description< S >:

Collaboration diagram for dbe::config_object_description< S >:

Public Member Functions
	config_object_description (dbe::inner::configobject::tref const &o) noexcept(false)
	config_object_description (config_object_description const &other)
config_object_description	operator= (config_object_description other)
S	UID () const
S	class_name () const
S	contained_in () const
bool	is_valid () const
inner::configobject::tref	ref () const

Private Attributes
inner::configobject::tref	this_referenced_object
S	this_file
Private Attributes inherited from dbe::config_object_key< std::string >
std::string	this_name
std::string	this_class

Friends
void	transfer (config_object_description &one, config_object_description &another) noexcept

Additional Inherited Members
Private Member Functions inherited from dbe::config_object_key< std::string >
	config_object_key (std::string const &oname, std::string const &cname)

Detailed Description

template<typename S = std::string>
class dbe::config_object_description< S >

Provides a shallow copy holder , copies name, class and file only

Permits to create an identical object and populate with new information

An reference to the object is held internally, but this may be in an inconsistent state with respect to the information held inside this descriptor

Definition at line 36 of file confobject_desc.hpp.

Constructor & Destructor Documentation

config_object_description() [1/2]

template<typename S = std::string>

dbe::config_object_description< S >::config_object_description ( dbe::inner::configobject::tref const & o )

inline

Definition at line 51 of file confobject_desc.hpp.

    : config_object_key<S>{ o.UID(), o.class_name() }
    , this_referenced_object(o)
    , this_file(o.contained_in())
  {
  }

config_object_description() [2/2]

template<typename S = std::string>

dbe::config_object_description< S >::config_object_description ( config_object_description< S > const & other )

inline

Definition at line 58 of file confobject_desc.hpp.

    : config_object_key<S>{ other.this_name, other.this_class }
    , this_referenced_object{ other.this_referenced_object }
    , this_file(other.this_file)
  {
  }

Member Function Documentation

class_name()

template<typename S = std::string>

S dbe::config_object_description< S >::class_name ( ) const

inline

Definition at line 73 of file confobject_desc.hpp.

{ return this->this_class; }

contained_in()

template<typename S = std::string>

S dbe::config_object_description< S >::contained_in ( ) const

inline

Definition at line 75 of file confobject_desc.hpp.

{ return this->this_file; }

is_valid()

template<typename S = std::string>

bool dbe::config_object_description< S >::is_valid ( ) const

inline

Definition at line 77 of file confobject_desc.hpp.

{ return not this_referenced_object.is_null(); }

operator=()

template<typename S = std::string>

config_object_description dbe::config_object_description< S >::operator= ( config_object_description< S > other )

inline

Definition at line 65 of file confobject_desc.hpp.

  {
    transfer(*this, other);
    return *this;
  }

ref()

template<typename S>

inner::configobject::tref dbe::config_object_description< S >::ref

(

)

const

Returns an always valid reference to the underlying object

If the object cannot be found in the database , an appropriate exception will be thrown from the underlyin dbcontroller::get() lookup , and should be handled by caller, accordingly.

Returns

a transaction reference (tref) to the underlying object

Definition at line 459 of file dbcontroller.cpp.

{
  if (this_referenced_object.is_null()) {
    this_referenced_object = dbe::inner::dbcontroller::get({ this->this_name, this->this_class });
  }
  return this_referenced_object;
}

UID()

template<typename S = std::string>

S dbe::config_object_description< S >::UID ( ) const

inline

Definition at line 71 of file confobject_desc.hpp.

{ return this->this_name; }

Friends And Related Symbol Documentation

transfer

template<typename S = std::string>

void transfer ( config_object_description< S > & one, config_object_description< S > & another )

friend

Definition at line 42 of file confobject_desc.hpp.

  {
    std::swap(one.this_referenced_object, another.this_referenced_object);
    std::swap(one.this_class, another.this_class);
    std::swap(one.this_name, another.this_name);
    std::swap(one.this_file, another.this_file);
  }

Member Data Documentation

this_file

template<typename S = std::string>

S dbe::config_object_description< S >::this_file

private

Definition at line 40 of file confobject_desc.hpp.

this_referenced_object

template<typename S = std::string>

inner::configobject::tref dbe::config_object_description< S >::this_referenced_object

mutableprivate

Definition at line 39 of file confobject_desc.hpp.

---

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

• /github/workspace/dunedaq/sourcecode/dbe/include/dbe/confobject_desc.hpp
• /github/workspace/dunedaq/sourcecode/dbe/src/internal/dbcontroller.cpp