dbe::inner::configobject::ref_interface< T > Class Template Reference

#include <config_reference.hpp>

Public Member Functions
bool	is_null () const
std::string	UID () const
std::string	class_name () const
std::string	full_name () const
std::string	contained_in () const
template<typename U >
U	get (std::string const &key)
template<typename U >
void	get (std::string const &key, U &val)
std::vector< T >	referenced_by (std::string const &name="*", bool check_composite_only=true) const
void	set_obj_null (std::string const &name, bool is_simple, bool skip_non_null_check=false)
void	set_obj (std::string const &name, T const &other, bool skip_non_null_check=false)
void	set_objs (std::string const &name, std::vector< T > const &others, bool skip_non_null_check=false)
template<typename U >
void	set_by_val (std::string const &name, U val)
template<typename U >
void	set_by_ref (std::string const &name, U &val)
void	set_enum (std::string const &name, std::string const &val)
void	set_class (std::string const &name, std::string const &val)
void	set_date (std::string const &name, std::string const &val)
void	set_time (std::string const &name, std::string const &val)
void	set_enum (std::string const &name, const std::vector< std::string > &value)
void	set_class (std::string const &name, const std::vector< std::string > &value)
void	set_date (std::string const &name, const std::vector< std::string > &value)
void	set_time (std::string const &name, const std::vector< std::string > &value)
void	move (std::string const &at)
void	print_ref (std::ostream &s, dunedaq::conffwk::Configuration &conf, const std::string &prefix="", bool show_contained_in=false) const
	Print details of object's attributes and relationships.

Protected Member Functions
template<typename U >
U	getdirect (std::string const &key) const

Private Member Functions
	operator dunedaq::conffwk::ConfigObject & () noexcept
	operator dunedaq::conffwk::ConfigObject & () const noexcept

Friends
template<typename X , typename U >
class	authorized_getter
class	dbe::inner::configobject::tref
class	dbe::inner::configobject::vref
class	dbe::inner::configobject::aref< T >
std::ostream &	operator<< (std::ostream &os, dbe::inner::configobject::tref const &atref)

Detailed Description

template<typename T>
class dbe::inner::configobject::ref_interface< T >

Definition at line 148 of file config_reference.hpp.

Member Function Documentation

class_name()

template<typename T >

std::string dbe::inner::configobject::ref_interface< T >::class_name ( ) const

inline

Definition at line 196 of file config_reference.hpp.

        {
            return static_cast<dunedaq::conffwk::ConfigObject &>(*this).class_name();
        }

contained_in()

template<typename T >

std::string dbe::inner::configobject::ref_interface< T >::contained_in ( ) const

inline

Definition at line 206 of file config_reference.hpp.

        {
            return static_cast<dunedaq::conffwk::ConfigObject &>(*this).contained_in();
        }

full_name()

template<typename T >

std::string dbe::inner::configobject::ref_interface< T >::full_name ( ) const

inline

Definition at line 201 of file config_reference.hpp.

        {
            return static_cast<dunedaq::conffwk::ConfigObject &>(*this).full_name();
        }

get() [1/2]

template<typename T >

template<typename U >

U dbe::inner::configobject::ref_interface< T >::get ( std::string const & key )

inline

Retrieve values of type U referred by the given key

Parameters

key	is the attribute name

Returns

the value of type U referred by the named attribute

Definition at line 217 of file config_reference.hpp.

        {
            authorized_getter<T, U> guard(this);
            return guard(key);
        }

get() [2/2]

template<typename T >

template<typename U >

void dbe::inner::configobject::ref_interface< T >::get ( std::string const & key, U & val )

inline

Compatibility interface to support ConfigObject style queries

Parameters

key	a string of what to look for
val	is a reference to the object where the value of matching type will be placed

Definition at line 229 of file config_reference.hpp.

        {
            val = get<U>(key);
        }

getdirect()

template<typename T >

template<typename U >

U dbe::inner::configobject::ref_interface< T >::getdirect ( std::string const & key ) const

inlineprotected

Retrieve values of type U referred by the given key

Parameters

key	is the attribute name

Returns

the value of type U referred by the named attribute

Definition at line 168 of file config_reference.hpp.

        {
            U value;
            try
            {
                static_cast<dunedaq::conffwk::ConfigObject &>(*const_cast<ref_interface<T>*>(this)).get(key, value);
            }
            catch (dunedaq::conffwk::Exception const & e)
            {
                // TODO handle retrieval errors here
            }
            return value;
        }

is_null()

template<typename T >

bool dbe::inner::configobject::ref_interface< T >::is_null ( ) const

inline

Definition at line 186 of file config_reference.hpp.

        {
            return static_cast<dunedaq::conffwk::ConfigObject &>(static_cast<T const *>(this)->ref(false)).is_deleted();
        }

move()

template<typename T >

void dbe::inner::configobject::ref_interface< T >::move ( std::string const & at )

inline

Definition at line 327 of file config_reference.hpp.

        {
            static_cast<dunedaq::conffwk::ConfigObject &>(*this).move(at);
        }

operator dunedaq::conffwk::ConfigObject &() [1/2]

template<typename T >

dbe::inner::configobject::ref_interface< T >::operator dunedaq::conffwk::ConfigObject & ( ) const

inlineexplicitprivatenoexcept

Definition at line 156 of file config_reference.hpp.

        {
            return static_cast<T const *>(this)->ref();
        }

operator dunedaq::conffwk::ConfigObject &() [2/2]

template<typename T >

dbe::inner::configobject::ref_interface< T >::operator dunedaq::conffwk::ConfigObject & ( )

inlineexplicitprivatenoexcept

Definition at line 151 of file config_reference.hpp.

        {
            return static_cast<T*>(this)->ref();
        }

print_ref()

template<typename T >

void dbe::inner::configobject::ref_interface< T >::print_ref ( std::ostream & s, dunedaq::conffwk::Configuration & conf, const std::string & prefix = "", bool show_contained_in = false ) const

inline

Print details of object's attributes and relationships.

Parameters

s	the output stream
conf	the configuration object (required to read schema description)
prefix	optional shift output using prefix
show_contained_in	optional print out info about object database file

Definition at line 336 of file config_reference.hpp.

        {
            static_cast<dunedaq::conffwk::ConfigObject &>(*this).print_ref(s, conf, prefix, show_contained_in);
        }

referenced_by()

template<typename T >

template std::vector< tref > dbe::inner::configobject::ref_interface< T >::referenced_by	(	std::string const &	name = "*",
		bool	check_composite_only = true ) const

New method to retrieve reference to this object through some relation

Parameters

name	of of the relation to check references through to this object
check_composite_only	enables checking of only composite parent objects

Returns

a list of objects referencing this

Definition at line 30 of file dbcontroller.cpp.

{
  std::vector<ConfigObject> referees;
  std::vector<tref> result;
 
  static_cast<ConfigObject &>(*this).referenced_by(referees, name, check_composite_only);
 
  for (ConfigObject const & x : referees)
  {
    try
    {
      result.push_back(inner::dbcontroller::get(
                         { x.UID(), x.class_name() }));
    }
    catch (daq::dbe::config_object_retrieval_result_is_null const & e)
    {
      // Nothing needed to do here, this is normal, just the query has resulted in null
    }
  }
 
  return result;
}

set_by_ref()

template<typename T >

template<typename U >

void dbe::inner::configobject::ref_interface< T >::set_by_ref ( std::string const & name, U & val )

inline

Definition at line 282 of file config_reference.hpp.

        {
            static_cast<dunedaq::conffwk::ConfigObject &>(*this).set_by_ref(name, val);
        }

set_by_val()

template<typename T >

template<typename U >

void dbe::inner::configobject::ref_interface< T >::set_by_val ( std::string const & name, U val )

inline

Definition at line 277 of file config_reference.hpp.

        {
            static_cast<dunedaq::conffwk::ConfigObject &>(*this).set_by_val(name, val);
        }

set_class() [1/2]

template<typename T >

void dbe::inner::configobject::ref_interface< T >::set_class ( std::string const & name, const std::vector< std::string > & value )

inline

Definition at line 312 of file config_reference.hpp.

        {
            static_cast<dunedaq::conffwk::ConfigObject &>(*this).set_class(name, value);
        }

set_class() [2/2]

template<typename T >

void dbe::inner::configobject::ref_interface< T >::set_class ( std::string const & name, std::string const & val )

inline

Definition at line 292 of file config_reference.hpp.

        {
            static_cast<dunedaq::conffwk::ConfigObject &>(*this).set_class(name, val);
        }

set_date() [1/2]

template<typename T >

void dbe::inner::configobject::ref_interface< T >::set_date ( std::string const & name, const std::vector< std::string > & value )

inline

Definition at line 317 of file config_reference.hpp.

        {
            static_cast<dunedaq::conffwk::ConfigObject &>(*this).set_date(name, value);
        }

set_date() [2/2]

template<typename T >

void dbe::inner::configobject::ref_interface< T >::set_date ( std::string const & name, std::string const & val )

inline

Definition at line 297 of file config_reference.hpp.

        {
            static_cast<dunedaq::conffwk::ConfigObject &>(*this).set_date(name, val);
        }

set_enum() [1/2]

template<typename T >

void dbe::inner::configobject::ref_interface< T >::set_enum ( std::string const & name, const std::vector< std::string > & value )

inline

Definition at line 307 of file config_reference.hpp.

        {
            static_cast<dunedaq::conffwk::ConfigObject &>(*this).set_enum(name, value);
        }

set_enum() [2/2]

template<typename T >

void dbe::inner::configobject::ref_interface< T >::set_enum ( std::string const & name, std::string const & val )

inline

Definition at line 287 of file config_reference.hpp.

        {
            static_cast<dunedaq::conffwk::ConfigObject &>(*this).set_enum(name, val);
        }

set_obj()

template<typename T >

void dbe::inner::configobject::ref_interface< T >::set_obj ( std::string const & name, T const & other, bool skip_non_null_check = false )

inline

Definition at line 255 of file config_reference.hpp.

        {
    static_cast<dunedaq::conffwk::ConfigObject &> ( *this ).set_obj ( name,
                                                    &static_cast<dunedaq::conffwk::ConfigObject &> ( other ),
                                                                                                    skip_non_null_check);
        }

set_obj_null()

template<typename T >

void dbe::inner::configobject::ref_interface< T >::set_obj_null ( std::string const & name, bool is_simple, bool skip_non_null_check = false )

inline

Definition at line 244 of file config_reference.hpp.

        {
            if(is_simple)
            {
              static_cast<dunedaq::conffwk::ConfigObject &>(*this).set_obj(name, nullptr, skip_non_null_check);
            } else
            {
              static_cast<dunedaq::conffwk::ConfigObject &>(*this).set_objs(name, {}, skip_non_null_check);
            }
        }

set_objs()

template<typename T >

void dbe::inner::configobject::ref_interface< T >::set_objs ( std::string const & name, std::vector< T > const & others, bool skip_non_null_check = false )

inline

Definition at line 263 of file config_reference.hpp.

        {
            std::vector<dunedaq::conffwk::ConfigObject const *> configobjects;
 
            std::transform(std::begin(others), std::end(others),
                                            std::back_inserter(configobjects), [](T const & aref )
    {
      return &static_cast<dunedaq::conffwk::ConfigObject const &> ( aref );
    } );
 
            static_cast<dunedaq::conffwk::ConfigObject &>(*this).set_objs(name, configobjects, skip_non_null_check);
        }

set_time() [1/2]

template<typename T >

void dbe::inner::configobject::ref_interface< T >::set_time ( std::string const & name, const std::vector< std::string > & value )

inline

Definition at line 322 of file config_reference.hpp.

        {
            static_cast<dunedaq::conffwk::ConfigObject &>(*this).set_time(name, value);
        }

set_time() [2/2]

template<typename T >

void dbe::inner::configobject::ref_interface< T >::set_time ( std::string const & name, std::string const & val )

inline

Definition at line 302 of file config_reference.hpp.

        {
            static_cast<dunedaq::conffwk::ConfigObject &>(*this).set_time(name, val);
        }

UID()

template<typename T >

std::string dbe::inner::configobject::ref_interface< T >::UID ( ) const

inline

Definition at line 191 of file config_reference.hpp.

        {
            return static_cast<dunedaq::conffwk::ConfigObject &>(*this).UID();
        }

Friends And Related Symbol Documentation

authorized_getter

template<typename T >

template<typename X , typename U >

friend class authorized_getter

friend

Definition at line 182 of file config_reference.hpp.

dbe::inner::configobject::aref< T >

template<typename T >

friend class dbe::inner::configobject::aref< T >

friend

Definition at line 350 of file config_reference.hpp.

dbe::inner::configobject::tref

template<typename T >

friend class dbe::inner::configobject::tref

friend

Definition at line 349 of file config_reference.hpp.

dbe::inner::configobject::vref

template<typename T >

friend class dbe::inner::configobject::vref

friend

Definition at line 350 of file config_reference.hpp.

operator<<

template<typename T >

std::ostream & operator<< ( std::ostream & os, dbe::inner::configobject::tref const & atref )

friend

---

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

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