CbmReport.h

Go to the documentation of this file.

/* Copyright (C) 2011-2020 GSI/JINR-LIT, Darmstadt/Dubna
   SPDX-License-Identifier: GPL-3.0-only
   Authors: Andrey Lebedev [committer], Florian Uhlig */
 
#ifndef CBMREPORT_H_
#define CBMREPORT_H_
 
#include <Rtypes.h>      // for THashConsistencyHolder, ClassDef
#include <RtypesCore.h>  // for Int_t, Option_t
#include <TObject.h>     // for TObject
 
#include <iostream>  // for string, ostream
#include <vector>    // for vector
 
class CbmReportElement;
class TCanvas;
 
enum ReportType
{
  kCoutReport,
  kHtmlReport,
  kLatexReport,
  kTextReport
};
 
class CbmReport : public TObject {
public:
  CbmReport();
 
  virtual ~CbmReport();
 
  const CbmReportElement* R() const { return fR; }
 
  std::ostream& Out() const { return *fOut; }
 
  /* Setters */
  void SetReportName(const std::string& name) { fReportName = name; }
  void SetReportTitle(const std::string& title) { fReportTitle = title; }
  void SetOutputDir(const std::string& outputDir) { fOutputDir = outputDir; }
 
  /* Accessors */
  const std::string& GetReportName() const { return fReportName; }
  const std::string& GetReportTitle() const { return fReportTitle; }
  const std::string& GetOutputDir() const { return fOutputDir; }
 
protected:
  virtual void Create() = 0;
 
  virtual void Draw() = 0;
 
  void Draw(Option_t*) { ; }
 
 
  void CreateReports();
 
  TCanvas* CreateCanvas(const char* name, const char* title, Int_t ww, Int_t wh);
 
  void SaveCanvasesAsImages() const;
 
  void WriteCanvases() const;
 
  void PrintCanvases() const;
 
private:
  void CreateReportElement(ReportType reportType);
 
  void DeleteReportElement();
 
  std::string fReportName;     // Name of report
  std::string fReportTitle;    // Title of report
  std::string fOutputDir;      // Output directory for the report files
  ReportType fReportType;      // Current report type
  CbmReportElement* fR;        // Report element tool
  mutable std::ostream* fOut;  // Output stream
 
  // Storage for TCanvas. All Canvases in this vector will be automatically saved
  // to image and printed in the report.
  // User can use CreateCanvas function which automatically push created canvas in this vector.
  std::vector<TCanvas*> fCanvases;
 
  //private:
 
  CbmReport(const CbmReport&);
  CbmReport& operator=(const CbmReport&);
 
  ClassDef(CbmReport, 1)
};
 
#endif /* CBMREPORT_H_ */