GraphDumper.h

Go to the documentation of this file.

/***********************************************************************************\
* (c) Copyright 1998-2026 CERN for the benefit of the LHCb and ATLAS collaborations *
*                                                                                   *
* This software is distributed under the terms of the Apache version 2 licence,     *
* copied verbatim in the file "LICENSE".                                            *
*                                                                                   *
* In applying this licence, CERN does not waive the privileges and immunities       *
* granted to it by virtue of its status as an Intergovernmental Organization        *
* or submit itself to any jurisdiction.                                             *
\***********************************************************************************/
#pragma once
 
#include <fstream>
#include <string>
#include <string_view>
 
namespace Gaudi::Hive {
 
  enum class FileType : short { UNKNOWN, DOT, MD, ML };

  class Graph {
 
  public:
    Graph( std::string_view fileName, FileType type = FileType::UNKNOWN );
 
    ~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:
    // Utilities to write file headers and trailers in case a format needs them
    void writeHeader();
    void writeTrailer();

    std::string m_fileName;
    std::ofstream m_stream;
    FileType m_type{ FileType::UNKNOWN };
  };
 
} // end namespace Gaudi::Hive