Logo ROOT  
Reference Guide
ROOT::RDF::RDFDescription Class Reference

A DFDescription contains useful information about a given RDataFrame computation graph.

A DFDescription is returned by the Describe() RDataFrame method. Each DFDescription object can output either a brief or full description.

Definition at line 27 of file RDFDescription.hxx.

Public Member Functions

 RDFDescription (const std::string &briefDescription, const std::string &fullDescription)
 
std::string AsString (bool shortFormat=false) const
 
void Print (bool shortFormat=false) const
 

Private Attributes

std::string fBriefDescription
 
std::string fFullDescription
 

Friends

std::ostream & operator<< (std::ostream &os, const RDFDescription &description)
 

#include <ROOT/RDF/RDFDescription.hxx>

Constructor & Destructor Documentation

◆ RDFDescription()

ROOT::RDF::RDFDescription::RDFDescription ( const std::string &  briefDescription,
const std::string &  fullDescription 
)

Definition at line 17 of file RDFDescription.cxx.

Member Function Documentation

◆ AsString()

std::string ROOT::RDF::RDFDescription::AsString ( bool  shortFormat = false) const

Definition at line 20 of file RDFDescription.cxx.

◆ Print()

void ROOT::RDF::RDFDescription::Print ( bool  shortFormat = false) const

Definition at line 28 of file RDFDescription.cxx.

Friends And Related Function Documentation

◆ operator<<

std::ostream & operator<< ( std::ostream &  os,
const RDFDescription description 
)
friend

Definition at line 33 of file RDFDescription.cxx.

Member Data Documentation

◆ fBriefDescription

std::string ROOT::RDF::RDFDescription::fBriefDescription
private

Definition at line 29 of file RDFDescription.hxx.

◆ fFullDescription

std::string ROOT::RDF::RDFDescription::fFullDescription
private

Definition at line 30 of file RDFDescription.hxx.

Libraries for ROOT::RDF::RDFDescription:
[legend]

The documentation for this class was generated from the following files: