CbmQaReportFigure.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 "CbmQaReportElement.h"
#include "CbmQaReportEngine.h"
 
namespace cbm::qa::report
{
  class Figure : public Element {
   public:
    struct Plot {
      Plot() = default;
 
      Plot(std::string_view path, std::string_view caption, std::string_view label)
        : fsPath(path)
        , fsCaption(caption)
        , fsLabel(label)
      {
      }
 
      std::string fsPath    = "";
      std::string fsCaption = "";
      std::string fsLabel   = "";
    };
 
    Figure(std::string_view label, std::string_view title = "")
      : Element(std::string("fig:") + std::string(label), title)
    {
    }
 
    virtual ~Figure() = default;
 
    void AddPlot(std::string_view path, std::string_view caption = "", std::string_view label = "")
    {
      fvsPlots.emplace_back(path, caption, label);
    }
 
    std::string GetBody(const Engine& engine) const override { return engine.FigureBody(*this); }
 
    const std::string& GetCaption() const { return fsCaption; }
 
    const std::vector<size_t>& GetPlotGrid() const { return fvGrid; }
 
    const std::vector<Plot>& GetPlots() const { return fvsPlots; }
 
    void SetCaption(std::string_view caption) { fsCaption = caption; }
 
    void SetPlotGrid(size_t nX, size_t nY)
    {
      fvGrid.clear();
      fvGrid.resize(nY, nX);
    }
 
    void SetPlotGrid(const std::vector<size_t>& grid) { fvGrid = grid; }
 
   private:
    std::vector<Plot> fvsPlots{};  
    std::vector<size_t> fvGrid{};  
    std::string fsCaption{};       
  };
}  // namespace cbm::qa::report