Logo ROOT  
Reference Guide
RDFDescription.hxx
Go to the documentation of this file.
1// Author: Ivan Kabadzhov, Enrico Guiraud CERN 01/2022
2
3/*************************************************************************
4 * Copyright (C) 1995-2022, Rene Brun and Fons Rademakers. *
5 * All rights reserved. *
6 * *
7 * For the licensing terms see $ROOTSYS/LICENSE. *
8 * For the list of contributors see $ROOTSYS/README/CREDITS. *
9 *************************************************************************/
10
11#ifndef ROOT_RDFDescription
12#define ROOT_RDFDescription
13
14#include <string>
15
16namespace ROOT {
17namespace RDF {
18
19/**
20\class ROOT::RDF::RDFDescription
21\ingroup dataframe
22\brief A DFDescription contains useful information about a given RDataFrame computation graph.
23
24 A DFDescription is returned by the Describe() RDataFrame method.
25 Each DFDescription object can output either a brief or full description.
26*/
28
29 std::string fBriefDescription;
30 std::string fFullDescription;
31
32public:
33 RDFDescription(const std::string &briefDescription, const std::string &fullDescription);
34
35 std::string AsString(bool shortFormat = false) const;
36
37 void Print(bool shortFormat = false) const;
38
39 friend std::ostream &operator<<(std::ostream &os, const RDFDescription &description);
40};
41
42} // namespace RDF
43} // namespace ROOT
44
45/// Print an RDFDescription at the prompt
46namespace cling {
47std::string printValue(ROOT::RDF::RDFDescription *td);
48} // namespace cling
49
50#endif
A DFDescription contains useful information about a given RDataFrame computation graph.
RDFDescription(const std::string &briefDescription, const std::string &fullDescription)
std::string AsString(bool shortFormat=false) const
friend std::ostream & operator<<(std::ostream &os, const RDFDescription &description)
void Print(bool shortFormat=false) const
This file contains a specialised ROOT message handler to test for diagnostic in unit tests.