ROOT/RDF/RDFDescription.hxx

0001 // Author: Ivan Kabadzhov, Enrico Guiraud CERN  01/2022
0002
0003 /*************************************************************************
0004  * Copyright (C) 1995-2022, Rene Brun and Fons Rademakers.               *
0005  * All rights reserved.                                                  *
0006  *                                                                       *
0007  * For the licensing terms see $ROOTSYS/LICENSE.                         *
0008  * For the list of contributors see $ROOTSYS/README/CREDITS.             *
0009  *************************************************************************/
0010
0011 #ifndef ROOT_RDFDescription
0012 #define ROOT_RDFDescription
0013
0014 #include <string>
0015
0016 namespace ROOT {
0017 namespace RDF {
0018
0019 /**
0020 \class ROOT::RDF::RDFDescription
0021 \ingroup dataframe
0022 \brief A DFDescription contains useful information about a given RDataFrame computation graph.
0023
0024  A DFDescription is returned by the Describe() RDataFrame method.
0025  Each DFDescription object can output either a brief or full description.
0026 */
0027 class RDFDescription {
0028
0029    std::string fBriefDescription;
0030    std::string fFullDescription;
0031    unsigned int fFileCount;
0032
0033 public:
0034    RDFDescription(const std::string &briefDescription, const std::string &fullDescription);
0035    RDFDescription(const std::string &briefDescription, const std::string &fullDescription, unsigned int filecount);
0036
0037    std::string AsString(bool shortFormat = false) const;
0038
0039    unsigned int GetNFiles() const { return fFileCount; }
0040
0041    void Print(bool shortFormat = false) const;
0042
0043    friend std::ostream &operator<<(std::ostream &os, const RDFDescription &description);
0044 };
0045
0046 } // namespace RDF
0047 } // namespace ROOT
0048
0049 /// Print an RDFDescription at the prompt
0050 namespace cling {
0051 std::string printValue(ROOT::RDF::RDFDescription *td);
0052 } // namespace cling
0053
0054 #endif