dbe::config::api::info::onclass Class Reference

#include <config_api_info.hpp>

Static Public Member Functions
template<typename T>
static T	allnames ()
static dunedaq::conffwk::class_t	definition (std::string const &cn, bool direct_only)
template<bool SORTED = true>
static std::vector< dbe::inner::configobject::tref >	objects (std::string const &cname, bool const keep_inherited=true)
static bool	derived (std::string const &fromclass, std::string const &aclass)
template<>
std::vector< dbe::tref >	objects (std::string const &cname, bool const keep_inherited)
template<>
std::vector< dbe::tref >	objects (std::string const &cname, bool const keep_inherited)

Detailed Description

Definition at line 80 of file config_api_info.hpp.

Member Function Documentation

allnames()

template<typename T>

T dbe::config::api::info::onclass::allnames ( )

inlinestatic

Get a list of all classes defined in the database

Returns

Definition at line 35 of file config_api.hpp.

{
  typedef dunedaq::conffwk::fmap<dunedaq::conffwk::fset> type_cmap;
  type_cmap const& baseclasses = dbaccessor::dbptr()->superclasses();
 
  T config_class_list;
 
  std::transform(baseclasses.begin(),
                 baseclasses.end(),
                 std::back_inserter(config_class_list),
                 [](type_cmap::value_type const& element) { return element.first->c_str(); });
 
  if (not config_class_list.empty()) {
    std::sort(std::begin(config_class_list), std::end(config_class_list));
  }
 
  return config_class_list;
}

definition()

dunedaq::conffwk::class_t dbe::config::api::info::onclass::definition ( std::string const & cn, bool direct_only )

static

Get class information from class name

Parameters

cn	is the class name to retrieve information for
determines	if class information should include direct-only relation, attribute , sub-class and superclass information

Returns

a class information object

Definition at line 102 of file config_api_info.cpp.

{
  try {
    return dbaccessor::dbptr()->get_class_info(cn, direct_only);
  } catch (dunedaq::conffwk::NotFound const& Ex) {
    return dunedaq::conffwk::class_t();
  }
}

derived()

bool dbe::config::api::info::onclass::derived ( std::string const & fromclass, std::string const & aclass )

static

Determine if a class is derived from another

Parameters

fromclass	is the classname of the class the we want to see if a class is derived from
aclass	is the classname of the candidate class to be derived from inclass

Returns

true if aclass is derived fromclass

Definition at line 72 of file config_api_info.cpp.

{
  dunedaq::conffwk::class_t aclassdef{ dbe::config::api::info::onclass::definition(aclass, false) };
 
  for (std::string const& x : aclassdef.p_superclasses) {
    if (fromclass == x) {
      return true;
    }
  }
 
  return false;
}

objects() [1/3]

template<>

std::vector< dbe::tref > dbe::config::api::info::onclass::objects ( std::string const & cname, bool const keep_inherited )

static

Definition at line 48 of file config_api_info.cpp.

{
  std::vector<dbe::tref> objectrefs = inner::dbcontroller::gets(cname);
 
  if (not keep_inherited) {
    objectrefs.erase(std::remove_if(objectrefs.begin(),
                                    objectrefs.end(),
                                    [&cname](dbe::tref anobject) { return (anobject.class_name() != cname); }),
                     objectrefs.end());
  }
 
  return objectrefs;
}

objects() [2/3]

template<>

std::vector< dbe::tref > dbe::config::api::info::onclass::objects ( std::string const & cname, bool const keep_inherited )

static

Definition at line 1 of file config_api_info.cpp.

{
  std::vector<dbe::tref> objectrefs = inner::dbcontroller::gets(cname);
 
  if (not keep_inherited) {
    objectrefs.erase(std::remove_if(objectrefs.begin(),
                                    objectrefs.end(),
                                    [&cname](dbe::tref anobject) { return (anobject.class_name() != cname); }),
                     objectrefs.end());
  }
 
  std::sort(objectrefs.begin(), objectrefs.end(), SortObjects());
 
  return objectrefs;
}

objects() [3/3]

template<bool SORTED = true>

std::vector< dbe::inner::configobject::tref > dbe::config::api::info::onclass::objects ( std::string const & cname, bool const keep_inherited = true )

static

Retrieve references to config objects of a given class

Parameters

cname	is the class name to retrieve objects for
keep_inherited	if set to false filters out any objects inherited from this class

Returns

a vector of references

---

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

• /github/workspace/dunedaq/sourcecode/dbe/include/dbe/config_api_info.hpp
• /github/workspace/dunedaq/sourcecode/dbe/include/dbe/config_api.hpp
• /github/workspace/dunedaq/sourcecode/dbe/src/internal/config_api_info.cpp