dbe::tool::graph::gtool Class Reference

#include <gtool.hpp>

Classes
struct	vertex_label

Public Types
typedef boost::adjacency_list< boost::vecS, boost::vecS, boost::bidirectionalS, vertex_label >	t_graph
typedef boost::graph_traits< t_graph >::edge_descriptor	t_edge
typedef boost::graph_traits< t_graph >::vertex_descriptor	t_vertex
typedef std::map< std::string, t_vertex >	t_registry
typedef std::pair< bool, boost::graph_traits< gtool::t_graph >::vertex_iterator >	t_lookup_ret

Public Member Functions
	gtool (std::string const &rl, dbinfo dbtype)
template<typename ALGO>
int	load_and_run (ALGO const &)
t_graph const &	getgraph () const

Static Public Member Functions
static t_vertex	add_object_and_friends (t_graph &, tref const &, t_registry &registry)
static t_vertex	add_object (t_graph &g, tref const &o, bool uniqueness=true)
static t_vertex	add_object (t_graph &g, tref const &o, t_registry &registry)
static t_lookup_ret	lookup (t_graph const &g, vertex_label const &l)

Private Types
typedef std::vector< tref >	t_objects

Private Member Functions
void	load_all ()
void	load_all_class_objects (std::string const &cname)
void	create_graph ()

Private Attributes
t_graph	this_graph
t_objects	this_all_objects
t_registry	already_processed
std::string	this_src

Detailed Description

Definition at line 35 of file gtool.hpp.

Member Typedef Documentation

t_edge

typedef boost::graph_traits<t_graph>::edge_descriptor dbe::tool::graph::gtool::t_edge

Definition at line 52 of file gtool.hpp.

t_graph

typedef boost::adjacency_list<boost::vecS, boost::vecS, boost::bidirectionalS, vertex_label> dbe::tool::graph::gtool::t_graph

Definition at line 50 of file gtool.hpp.

t_lookup_ret

typedef std::pair<bool, boost::graph_traits<gtool::t_graph>::vertex_iterator> dbe::tool::graph::gtool::t_lookup_ret

Definition at line 110 of file gtool.hpp.

t_objects

typedef std::vector<tref> dbe::tool::graph::gtool::t_objects

private

Definition at line 125 of file gtool.hpp.

t_registry

typedef std::map<std::string, t_vertex> dbe::tool::graph::gtool::t_registry

Definition at line 55 of file gtool.hpp.

t_vertex

typedef boost::graph_traits<t_graph>::vertex_descriptor dbe::tool::graph::gtool::t_vertex

Definition at line 53 of file gtool.hpp.

Constructor & Destructor Documentation

gtool()

dbe::tool::graph::gtool::gtool	(	std::string const &	rl,
		dbinfo	dbtype )

Construct gtool object from string a resource location and db information type Resulting object loads a database from the resource location of the designated type

Parameters

fn	is a string designating the resource location of the database
dbtype	is the type (dbinfo) of the database access method (e.g. oks, rdb ... )

Definition at line 34 of file gtool.cpp.

  : this_src(rl)
{
  QFileInfo DatabaseFile(QString::fromStdString(rl));
 
  if (DatabaseFile.exists()) {
    QString path_to_database = QString(DatabaseFile.absoluteFilePath());
    {
      confaccessor::setdbinfo(path_to_database, dbtype);
      INFO("Database location set", "Program execution control success");
 
      if (confaccessor::load()) {
        INFO("Database initialized", "User request");
      } else {
        ERROR("Could not load database", "OKS error ", " Actions : check environment variables e.g. DUNEDAQ_DB_PATH");
        throw std::string("Could not load database");
      }
    }
  } else {
    ERROR("Cannot open database", "File error", "for file", rl);
  }
}

Member Function Documentation

add_object() [1/2]

gtool::t_vertex dbe::tool::graph::gtool::add_object ( gtool::t_graph & g, tref const & o, bool uniqueness = true )

static

Add an object to a graph without its relations

Parameters

g	is a reference to the graph
o	is a reference to the object
uniqueness	only add the object if there is no vertex already abstracting it

Returns

the newly added vertex or an already existent vertex if uniqueness is set and the object has already been added as a vertex

Definition at line 108 of file gtool.cpp.

{
  vertex_label xl{ x.UID(), x.class_name(), x.full_name() };
 
  if (not uniqueness) {
    // Multiple vertices with the same properties can be added to this graph
    return boost::add_vertex(xl, g);
  } else {
    bool result;
    boost::graph_traits<t_graph>::vertex_iterator viter;
    std::tie(result, viter) = lookup(g, xl);
 
    if (result) {
      return *viter;
    } else {
      return boost::add_vertex(xl, g);
    }
  }
}

add_object() [2/2]

gtool::t_vertex dbe::tool::graph::gtool::add_object ( gtool::t_graph & g, tref const & o, t_registry & registry )

static

Add an object to a graph without its relations if it is not found in the provided registry

Parameters

g	is a reference to the graph
o	is a reference to the object
registry	is a set of tags already present , and implies adding the object only if its tag is not in the registry ( speed up lookups )

Returns

the newly added vertex or an already existent vertex if uniqueness is set and the object has already been added as a vertex

Definition at line 129 of file gtool.cpp.

{
  t_registry::iterator vat = registry.find(x.full_name());
 
  if (std::end(registry) == vat) {
    FULLDEBUG("Adding object", "Program execution control", x.full_name());
    // not in the registry implies it is not in the graph , i.e. its user responsibility
    t_registry::iterator v;
    std::tie(v, std::ignore) = registry.emplace(x.full_name(), add_object(g, x, false));
    return v->second;
  } else {
    return vat->second;
  }
}

add_object_and_friends()

gtool::t_vertex dbe::tool::graph::gtool::add_object_and_friends ( t_graph & g, tref const & o, t_registry & registry )

static

Add an object to a graph along with all connected objects through any relation

Parameters

a	reference to the graph
a	registry of tags of objects already present in the graph

Definition at line 145 of file gtool.cpp.

{
  DEBUG("Processing object", "Program execution control", o.full_name());
  t_vertex ov = add_object(g, o, registry);
 
  std::vector<tref> friends{ config::api::graph::linked::by::object<tref>(o) }; // get all neighbors
  DEBUG(
    "Processing object", "Program execution control", o.full_name(), " # friends: ", std::to_string(friends.size()));
 
  for (tref const& x : friends) {
    t_vertex xv = add_object(g, x, registry);
    boost::add_edge(ov, xv, g);
    FULLDEBUG("Add edge ", "Program excecution control", o.full_name(), "->", x.full_name());
  }
 
  return ov;
}

create_graph()

void dbe::tool::graph::gtool::create_graph ( )

private

Definition at line 95 of file gtool.cpp.

{
  INFO("Database graph generation initiated", "Program execution control");
  already_processed.clear();
 
  for (auto const& x : this_all_objects) {
    add_object_and_friends(this_graph, x, already_processed);
  }
 
  INFO("Graph generation completed successfully", "Program execution control success");
}

getgraph()

gtool::t_graph const & dbe::tool::graph::gtool::getgraph

(

)

const

Retrieve the graph as it currently is

Returns

a const reference to the t_graph

Definition at line 58 of file gtool.cpp.

{
  return this_graph;
}

load_all()

void dbe::tool::graph::gtool::load_all ( )

private

Definition at line 64 of file gtool.cpp.

{
  INFO("Start load objects into internal cache", "Program execution control");
 
  std::vector<std::string> all_classes = { config::api::info::onclass::allnames<std::vector<std::string>>() };
 
  for (auto const& x : all_classes) {
    load_all_class_objects(x);
  }
 
  INFO("All objects loaded into internal cache",
       "Program execution control success",
       "#objects:",
       std::to_string(this_all_objects.size()));
}

load_all_class_objects()

void dbe::tool::graph::gtool::load_all_class_objects ( std::string const & cname )

private

Definition at line 81 of file gtool.cpp.

{
  std::vector<dbe::tref> all_objects = config::api::info::onclass::objects<false>(cname, false);
 
  INFO("Class to load: ", "Program execution control", cname);
 
  for (dbe::tref const& x : all_objects) {
    this_all_objects.push_back(x);
  }
 
  INFO("Class load success: ", "Program execution control", cname, "#objects", std::to_string(all_objects.size()));
}

load_and_run()

template<typename ALGO>

int dbe::tool::graph::gtool::load_and_run ( ALGO const & algo )

inline

Definition at line 184 of file gtool.hpp.

{
  load_all();
  create_graph();
  return algo(static_cast<gtool const&>(*this));
}

lookup()

gtool::t_lookup_ret dbe::tool::graph::gtool::lookup ( t_graph const & g, vertex_label const & l )

static

Lookup a vector in the graph , runs in O(N) worst case

Parameters

g	is the graph
l	is the graph label

Returns

a pair <true, valid vertex iterator > if found , otherwise <false, end iter>

Definition at line 164 of file gtool.cpp.

{
  auto const& vertices = boost::vertices(g);
 
  for (auto v = vertices.first; v != vertices.second; ++v) {
    if (l.label == boost::get(&vertex_label::label, g, *v)) {
      return t_lookup_ret(true, v);
    }
  }
 
  return t_lookup_ret(false, vertices.second);
}

Member Data Documentation

already_processed

t_registry dbe::tool::graph::gtool::already_processed

private

Definition at line 129 of file gtool.hpp.

this_all_objects

t_objects dbe::tool::graph::gtool::this_all_objects

private

Definition at line 128 of file gtool.hpp.

this_graph

t_graph dbe::tool::graph::gtool::this_graph

private

Definition at line 127 of file gtool.hpp.

this_src

std::string dbe::tool::graph::gtool::this_src

private

Definition at line 131 of file gtool.hpp.

---

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

• /github/workspace/dunedaq/sourcecode/dbe/include/dbe/gtool.hpp
• /github/workspace/dunedaq/sourcecode/dbe/apps/graphtool/gtool.cpp