Logo ROOT  
Reference Guide
 
Loading...
Searching...
No Matches
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 unsigned int fFileCount;
32
33public:
34 RDFDescription(const std::string &briefDescription, const std::string &fullDescription);
35 RDFDescription(const std::string &briefDescription, const std::string &fullDescription, unsigned int filecount);
36
37 std::string AsString(bool shortFormat = false) const;
38
39 unsigned int GetNFiles() const { return fFileCount; }
40
41 void Print(bool shortFormat = false) const;
42
43 friend std::ostream &operator<<(std::ostream &os, const RDFDescription &description);
44};
45
46} // namespace RDF
47} // namespace ROOT
48
49/// Print an RDFDescription at the prompt
50namespace cling {
51std::string printValue(ROOT::RDF::RDFDescription *td);
52} // namespace cling
53
54#endif
A DFDescription contains useful information about a given RDataFrame computation graph.
unsigned int GetNFiles() const
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.