CbmQaReportBuilder.h

Go to the documentation of this file.

/* Copyright (C) 2024 GSI Helmholtzzentrum fuer Schwerionenforschung, Darmstadt
   SPDX-License-Identifier: GPL-3.0-only
   Authors: Sergei Zharko [committer] */
 
 
#pragma once
 
#include "CbmQaReportDefines.h"
#include "CbmQaReportEngine.h"
#include "CbmQaReportHeader.h"
#include "CbmQaReportSection.h"
#include "CbmQaReportTail.h"
 
class TCanvas;
 
namespace cbm::qa::report
{
  class Builder {
   public:
    Builder(std::string_view title, fs::path outPath);
 
    virtual ~Builder() = default;
 
    void AddSection(std::shared_ptr<Section> pSection) { fvpSections.push_back(pSection); }
 
    std::shared_ptr<Header> GetHeader() { return fpHeader; }
 
    std::shared_ptr<Tail> GetTail() { return fpTail; }
 
    void CreateScript(Engine& engine, bool bCompile = true);
 
    std::string PathInSource(fs::path path) const { return fs::relative(path, fScriptsPath).string(); }
 
    std::string AbsFigurePath(fs::path relPath) const { return (fFiguresPath / relPath).string(); }
 
    std::string SaveCanvas(const TCanvas* canv, const std::string& relPath) const;
 
    void SetFigureExtention(std::string_view figExtention) { fsFigureExtention = figExtention; }
 
   private:
    static constexpr std::string_view ksSourceName = "source";  
 
    std::vector<std::shared_ptr<Section>> fvpSections;  
    std::string fsFigureExtention = "pdf";              
    fs::path fScriptsPath;                              
    fs::path fFiguresPath;                              
    std::shared_ptr<Header> fpHeader = nullptr;         
    std::shared_ptr<Tail> fpTail     = nullptr;         
  };
}  // namespace cbm::qa::report