Gaudi::Hive::Graph Class Reference

utilities to dump graphs in different formats More...

#include </builds/gaudi/Gaudi/GaudiHive/src/GraphDumper.h>

Collaboration diagram for Gaudi::Hive::Graph:

Public Member Functions
	Graph (std::string_view fileName, FileType type=FileType::UNKNOWN)
	Creates a graph with given type and given file name.
	~Graph ()
std::string const &	fileName ()
void	addNode (std::string_view id, std::string_view name)
void	addEdge (std::string_view srcId, std::string_view tgtId, std::string_view label="")

Private Member Functions
void	writeHeader ()
void	writeTrailer ()

Private Attributes
std::string	m_fileName
	name of the filed used for storing the graph
std::ofstream	m_stream
	stream to the graph file
FileType	m_type { FileType::UNKNOWN }
	type of file used

Detailed Description

utilities to dump graphs in different formats

supported right now : .dot, mermaid and graphml

Usage :

• create a Graph calling the constructor with type and name of the output file
• use then addNode and addEdge to specify the graph
• on destruction, the Graph will be written to file

Definition at line 30 of file GraphDumper.h.

Constructor & Destructor Documentation

Graph()

Gaudi::Hive::Graph::Graph	(	std::string_view	fileName,
		FileType	type = FileType::UNKNOWN )

Creates a graph with given type and given file name.

by default (and if UNKNOWN is provided) type is deduced from the file extension in case extension is not recognized, dot format is used and filename gets an extra ".dot" at the end

Definition at line 45 of file GraphDumper.cpp.

                                                       : m_fileName{ fileName }, m_type{ type } {
    // find out type of file if not given
    if ( type == FileType::UNKNOWN ) {
      // Check file extension
      if ( m_fileName.ends_with( ".dot" ) ) {
        m_type = FileType::DOT;
      } else if ( m_fileName.ends_with( ".md" ) ) {
        m_type = FileType::MD;
      } else if ( m_fileName.ends_with( ".graphml" ) ) {
        m_type = FileType::ML;
      } else {
        m_type = FileType::DOT;
        m_fileName += ".dot";
      }
    }
    // open file
    m_stream = std::ofstream{ m_fileName, std::ofstream::out };
    writeHeader();
  }

~Graph()

Gaudi::Hive::Graph::~Graph

(

)

Definition at line 65 of file GraphDumper.cpp.

                {
    writeTrailer();
    m_stream.close();
  }

Member Function Documentation

addEdge()

void Gaudi::Hive::Graph::addEdge	(	std::string_view	srcId,
		std::string_view	tgtId,
		std::string_view	label = "" )

Definition at line 93 of file GraphDumper.cpp.

                                                                                        {
    switch ( m_type ) {
    case FileType::DOT:
      m_stream << "  " << srcId << " -> " << tgtId;
      if ( label != "" ) m_stream << " [label=\"" << label << "\"]";
      m_stream << ";\n";
      break;
    case FileType::MD:
      m_stream << "  " << srcId << " --> " << tgtId;
      if ( label != "" ) m_stream << " : " << label;
      m_stream << "\n";
      break;
    case FileType::ML:
      if ( label != "" ) {
        m_stream << "    <edge source=\"" << srcId << "\" target=\"" << tgtId
                 << "\">\n"
                    "      <data key=\"d1\">"
                 << escapeSpecialCharactersForMl( label )
                 << "</data>\n"
                    "    </edge>\n";
      } else {
        m_stream << "    <edge source=\"" << srcId << "\" target=\"" << tgtId << "\"/>\n";
      }
      break;
    case FileType::UNKNOWN:
      break;
    }
  };

addNode()

void Gaudi::Hive::Graph::addNode	(	std::string_view	id,
		std::string_view	name )

Definition at line 72 of file GraphDumper.cpp.

                                                              {
    switch ( m_type ) {
    case FileType::DOT:
      m_stream << "  " << id << " [label=\"" << name << "\";shape=box];\n";
      break;
    case FileType::MD:
      m_stream << "  " << id << "{{" << name << "}}\n";
      break;
    case FileType::ML:
      m_stream << "    <node id=\"" << id
               << "\">\n"
                  "      <data key=\"d0\">"
               << escapeSpecialCharactersForMl( name )
               << "</data>\n"
                  "    </node>\n";
      break;
    case FileType::UNKNOWN:
      break;
    }
  };

fileName()

std::string const & Gaudi::Hive::Graph::fileName

(

)

Definition at line 70 of file GraphDumper.cpp.

{ return m_fileName; }

writeHeader()

void Gaudi::Hive::Graph::writeHeader ( )

private

Definition at line 124 of file GraphDumper.cpp.

                          {
    switch ( m_type ) {
    case FileType::DOT:
      m_stream << "digraph datadeps {\n  rankdir=\"LR\";\n";
      break;
    case FileType::MD:
      m_stream << "```mermaid\ngraph LR;\n\n";
      break;
    case FileType::ML:
      m_stream << "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n"
                  "<graphml xmlns=\"http://graphml.graphdrawing.org/xmlns\"\n"
                  "         xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\"\n"
                  "         xsi:schemaLocation=\"http://graphml.graphdrawing.org/xmlns "
                  "http://graphml.graphdrawing.org/xmlns/1.0/graphml.xsd\">\n"
                  "  <key id=\"d1\" for=\"edge\" attr.name=\"label\" attr.type=\"string\"/>\n"
                  "  <key id=\"d0\" for=\"node\" attr.name=\"label\" attr.type=\"string\"/>\n"
                  "  <graph id=\"Dependencies\" edgedefault=\"directed\">\n";
      break;
    case FileType::UNKNOWN:
      break;
    }
  }

writeTrailer()

void Gaudi::Hive::Graph::writeTrailer ( )

private

Definition at line 147 of file GraphDumper.cpp.

                           {
    switch ( m_type ) {
    case FileType::DOT:
      m_stream << "}\n";
      break;
    case FileType::MD:
      m_stream << "```\n";
      break;
    case FileType::ML:
      m_stream << "  </graph>\n</graphml>";
      break;
    case FileType::UNKNOWN:
      break;
    }
  }

Member Data Documentation

m_fileName

std::string Gaudi::Hive::Graph::m_fileName

private

name of the filed used for storing the graph

Definition at line 56 of file GraphDumper.h.

m_stream

std::ofstream Gaudi::Hive::Graph::m_stream

private

stream to the graph file

Definition at line 58 of file GraphDumper.h.

m_type

FileType Gaudi::Hive::Graph::m_type { FileType::UNKNOWN }

private

type of file used

Definition at line 60 of file GraphDumper.h.

{ FileType::UNKNOWN };

---

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

• GaudiHive/src/GraphDumper.h
• GaudiHive/src/GraphDumper.cpp