Logo ROOT  
Reference Guide
 
Loading...
Searching...
No Matches
RFieldVisitor.hxx
Go to the documentation of this file.
1/// \file ROOT/RFieldVisitor.hxx
2/// \ingroup NTuple ROOT7
3/// \author Simon Leisibach <simon.satoshi.rene.leisibach@cern.ch>
4/// \date 2019-06-11
5/// \warning This is part of the ROOT 7 prototype! It will change without notice. It might trigger earthquakes. Feedback
6/// is welcome!
7
8/*************************************************************************
9 * Copyright (C) 1995-2019, Rene Brun and Fons Rademakers. *
10 * All rights reserved. *
11 * *
12 * For the licensing terms see $ROOTSYS/LICENSE. *
13 * For the list of contributors see $ROOTSYS/README/CREDITS. *
14 *************************************************************************/
15
16#ifndef ROOT7_RFieldVisitor
17#define ROOT7_RFieldVisitor
18
19#include <ROOT/RField.hxx>
20#include <ROOT/RNTupleUtil.hxx>
21
22#include <algorithm>
23#include <iostream>
24#include <sstream>
25#include <string>
26#include <vector>
27
28namespace ROOT {
29namespace Experimental {
30namespace Detail {
31
32
33// clang-format off
34/**
35\class ROOT::Experimental::Detail::RFieldVisitor
36\ingroup NTuple
37\brief Abstract base class for classes implementing the visitor design pattern.
38
39RFieldVisitor::VisitField() is invoked by RFieldBase::AcceptVisitor(). VisitField() is inherited for instance
40by the RPrintSchemaVisitor class. The RFieldBase class and classes which inherit from it will be visited.
41*/
42// clang-format on
44public:
45 virtual void VisitField(const RFieldBase &field) = 0;
46 virtual void VisitFieldZero(const RFieldZero &field) { VisitField(field); }
47 virtual void VisitArrayField(const RArrayField &field) { VisitField(field); }
48 virtual void VisitArrayAsRVecField(const RArrayAsRVecField &field) { VisitField(field); }
49 virtual void VisitAtomicField(const RAtomicField &field) { VisitField(field); }
50 virtual void VisitBitsetField(const RBitsetField &field) { VisitField(field); }
51 virtual void VisitBoolField(const RField<bool> &field) { VisitField(field); }
52 virtual void VisitClassField(const RClassField &field) { VisitField(field); }
53 virtual void VisitProxiedCollectionField(const RProxiedCollectionField &field) { VisitField(field); }
54 virtual void VisitRecordField(const RRecordField &field) { VisitField(field); }
55 virtual void VisitClusterSizeField(const RField<ClusterSize_t> &field) { VisitField(field); }
56 virtual void VisitCardinalityField(const RCardinalityField &field) { VisitField(field); }
57 virtual void VisitDoubleField(const RField<double> &field) { VisitField(field); }
58 virtual void VisitEnumField(const REnumField &field) { VisitField(field); }
59 virtual void VisitFloatField(const RField<float> &field) { VisitField(field); }
60 virtual void VisitByteField(const RField<std::byte> &field) { VisitField(field); }
61 virtual void VisitCharField(const RField<char> &field) { VisitField(field); }
62 virtual void VisitInt8Field(const RField<std::int8_t> &field) { VisitField(field); }
63 virtual void VisitInt16Field(const RField<std::int16_t> &field) { VisitField(field); }
64 virtual void VisitIntField(const RField<int> &field) { VisitField(field); }
65 virtual void VisitInt64Field(const RField<std::int64_t> &field) { VisitField(field); }
66 virtual void VisitNullableField(const RNullableField &field) { VisitField(field); }
67 virtual void VisitStringField(const RField<std::string> &field) { VisitField(field); }
68 virtual void VisitUInt16Field(const RField<std::uint16_t> &field) { VisitField(field); }
69 virtual void VisitUInt32Field(const RField<std::uint32_t> &field) { VisitField(field); }
70 virtual void VisitUInt64Field(const RField<std::uint64_t> &field) { VisitField(field); }
71 virtual void VisitUInt8Field(const RField<std::uint8_t> &field) { VisitField(field); }
72 virtual void VisitVectorField(const RVectorField &field) { VisitField(field); }
73 virtual void VisitVectorBoolField(const RField<std::vector<bool>> &field) { VisitField(field); }
74 virtual void VisitRVecField(const RRVecField &field) { VisitField(field); }
75}; // class RFieldVisitor
76
77} // namespace Detail
78
79
80// clang-format off
81/**
82\class ROOT::Experimental::RPrepareVisitor
83\ingroup NTuple
84\brief Visitor used for a pre-processing run to collect information needed by another visitor class.
85
86 Currently used for RPrintSchemaVisitor in RNTupleReader::Print() to collect information about levels, max depth etc.
87*/
88// clang-format on
90private:
91 unsigned int fDeepestLevel = 1;
92 unsigned int fNumFields = 1;
93
94public:
95 RPrepareVisitor() = default;
96 void VisitField(const RFieldBase &field) final;
97 void VisitFieldZero(const RFieldZero &field) final;
98
99 unsigned int GetDeepestLevel() const { return fDeepestLevel; }
100 unsigned int GetNumFields() const { return fNumFields; }
101};
102
103
104// clang-format off
105/**
106\class ROOT::Experimental::RPrintSchemaVisitor
107\ingroup NTuple
108\brief Contains settings for printing and prints a summary of an RField instance.
109
110This visitor is used by RNTupleReader::Print()
111*/
112// clang-format on
114private:
115 /// Where to write the printout to
116 std::ostream &fOutput;
117 /// To render the output, use an asterix (*) by default to draw table lines and boundaries
119 /// Indicates maximal number of allowed characters per line
125 int fFieldNo = 1;
126 std::string fTreePrefix;
127 std::string fFieldNoPrefix;
128
129public:
130 RPrintSchemaVisitor(std::ostream &out = std::cout, char frameSymbol = '*', int width = 80, int deepestLevel = 1,
131 int numFields = 1)
132 : fOutput{out}, fFrameSymbol{frameSymbol}, fWidth{width}, fDeepestLevel{deepestLevel}, fNumFields{numFields}
133 {
135 }
136 /// Prints summary of Field
137 void VisitField(const RFieldBase &field) final;
138 void VisitFieldZero(const RFieldZero &fieldZero) final;
139 void SetFrameSymbol(char s) { fFrameSymbol = s; }
140 void SetWidth(int w) { fWidth = w; }
141 void SetDeepestLevel(int d);
142 void SetNumFields(int n);
143 /// Computes how many characters should be placed between the frame symbol and ':' for left and right side of ':' for
144 /// visually pleasing output.
145 // E.g.
146 // * Field 1 : vpx (std::vector<float>) *
147 // * |__Field 1.1 : vpx/vpx (float) *
148 // int fAvailableSpaceKeyString (num characters on left side between "* " and " : ")
149 // deepestlevel here is 2 (1.1 is deepest and has 2 numbers).
150 // For every additional level an additional "|_" and ".1" (4 characters) is added, so the number of required
151 // additional characters is 4 * fDeepestLevel. For level 1, 8 characters are required ("Field 1 "), so an
152 // additional + 4 is added. To account for cases where the total number of fields is not a single digit number and
153 // more space is required to output big numbers, fNumFields is incorporated into the calculation. To make sure
154 // that there is still enough space for the right side of " : ", an std::min comparision with fWidth - 15 is done.
155 // int fAvailableSpaceValueString(num characters on right side between " : " and '*')
156 // The 6 subtracted characters are "* " (2) in the beginning, " : " (3) and '*' (1) on the far right.
158 {
160 std::min(4 * fDeepestLevel + 4 + static_cast<int>(std::to_string(fNumFields).size()), fWidth - 15);
162 }
163};
164
165
166// clang-format off
167/**
168\class ROOT::Experimental::RPrintValueVisitor
169\ingroup NTuple
170\brief Renders a JSON value corresponding to the field.
171*/
172// clang-format on
174public:
178
180 };
181
182private:
184 /// The output is directed to fOutput which may differ from std::cout.
185 std::ostream &fOutput;
186 unsigned int fLevel;
188
189 void PrintIndent();
190 void PrintName(const RFieldBase &field);
191 void PrintCollection(const RFieldBase &field);
192
193public:
194 RPrintValueVisitor(RFieldBase::RValue value, std::ostream &output, unsigned int level = 0,
195 RPrintOptions options = RPrintOptions())
196 : fValue(value), fOutput{output}, fLevel(level), fPrintOptions(options)
197 {
198 }
199
200 void VisitField(const RFieldBase &field) final;
201
202 void VisitBoolField(const RField<bool> &field) final;
203 void VisitDoubleField(const RField<double> &field) final;
204 void VisitFloatField(const RField<float> &field) final;
205 void VisitByteField(const RField<std::byte> &field) final;
206 void VisitCharField(const RField<char> &field) final;
207 void VisitInt8Field(const RField<std::int8_t> &field) final;
208 void VisitInt16Field(const RField<std::int16_t> &field) final;
209 void VisitIntField(const RField<int> &field) final;
210 void VisitInt64Field(const RField<std::int64_t> &field) final;
211 void VisitStringField(const RField<std::string> &field) final;
212 void VisitUInt8Field(const RField<std::uint8_t> &field) final;
213 void VisitUInt16Field(const RField<std::uint16_t> &field) final;
214 void VisitUInt32Field(const RField<std::uint32_t> &field) final;
215 void VisitUInt64Field(const RField<std::uint64_t> &field) final;
216
217 void VisitCardinalityField(const RCardinalityField &field) final;
218 void VisitArrayField(const RArrayField &field) final;
219 void VisitArrayAsRVecField(const RArrayAsRVecField &field) final;
220 void VisitClassField(const RClassField &field) final;
221 void VisitRecordField(const RRecordField &field) final;
223 void VisitVectorField(const RVectorField &field) final;
224 void VisitVectorBoolField(const RField<std::vector<bool>> &field) final;
225 void VisitRVecField(const RRVecField &field) final;
226 void VisitBitsetField(const RBitsetField &field) final;
227 void VisitNullableField(const RNullableField &field) final;
228 void VisitEnumField(const REnumField &field) final;
229 void VisitAtomicField(const RAtomicField &field) final;
230};
231
232
233// clang-format off
234/**
235\class ROOT::Experimental::RNTupleFormatter
236\ingroup NTuple
237\brief Contains helper functions for RNTupleReader::PrintInfo() and RPrintSchemaVisitor::VisitField()
238
239The functions in this class format strings which are displayed by RNTupleReader::PrintInfo() and RNTupleReader::Show().
240*/
241// clang-format on
243public:
244 // Can abbreviate long strings, e.g. ("ExampleString" , space= 8) => "Examp..."
245 static std::string FitString(const std::string &str, int availableSpace);
246};
247
248} // namespace Experimental
249} // namespace ROOT
250
251#endif
#define d(i)
Definition RSha256.hxx:102
size_t size(const MatrixT &matrix)
retrieve the size of a square matrix
Option_t Option_t TPoint TPoint const char GetTextMagnitude GetFillStyle GetLineColor GetLineWidth GetMarkerStyle GetTextAlign GetTextColor GetTextSize void value
Option_t Option_t width
Abstract base class for classes implementing the visitor design pattern.
virtual void VisitProxiedCollectionField(const RProxiedCollectionField &field)
virtual void VisitBoolField(const RField< bool > &field)
virtual void VisitBitsetField(const RBitsetField &field)
virtual void VisitNullableField(const RNullableField &field)
virtual void VisitVectorBoolField(const RField< std::vector< bool > > &field)
virtual void VisitFieldZero(const RFieldZero &field)
virtual void VisitRVecField(const RRVecField &field)
virtual void VisitInt8Field(const RField< std::int8_t > &field)
virtual void VisitByteField(const RField< std::byte > &field)
virtual void VisitCardinalityField(const RCardinalityField &field)
virtual void VisitEnumField(const REnumField &field)
virtual void VisitArrayAsRVecField(const RArrayAsRVecField &field)
virtual void VisitClusterSizeField(const RField< ClusterSize_t > &field)
virtual void VisitDoubleField(const RField< double > &field)
virtual void VisitStringField(const RField< std::string > &field)
virtual void VisitUInt32Field(const RField< std::uint32_t > &field)
virtual void VisitField(const RFieldBase &field)=0
virtual void VisitUInt64Field(const RField< std::uint64_t > &field)
virtual void VisitInt16Field(const RField< std::int16_t > &field)
virtual void VisitCharField(const RField< char > &field)
virtual void VisitArrayField(const RArrayField &field)
virtual void VisitClassField(const RClassField &field)
virtual void VisitIntField(const RField< int > &field)
virtual void VisitUInt16Field(const RField< std::uint16_t > &field)
virtual void VisitRecordField(const RRecordField &field)
virtual void VisitUInt8Field(const RField< std::uint8_t > &field)
virtual void VisitInt64Field(const RField< std::int64_t > &field)
virtual void VisitVectorField(const RVectorField &field)
virtual void VisitFloatField(const RField< float > &field)
virtual void VisitAtomicField(const RAtomicField &field)
A field for fixed-size arrays that are represented as RVecs in memory.
Definition RField.hxx:1200
The generic field for fixed size arrays, which do not need an offset column.
Definition RField.hxx:1148
The generic field an std::bitset<N>.
Definition RField.hxx:1243
An artificial field that transforms an RNTuple column that contains the offset of collections into co...
Definition RField.hxx:1678
The field for a class with dictionary.
Definition RField.hxx:723
The field for an unscoped or scoped enum with dictionary.
Definition RField.hxx:784
Points to an object with RNTuple I/O support and keeps a pointer to the corresponding field.
Definition RField.hxx:185
A field translates read and write calls from/to underlying columns to/from tree values.
Definition RField.hxx:93
The container field for an ntuple model, which itself has no physical representation.
Definition RField.hxx:705
Classes with dictionaries that can be inspected by TClass.
Definition RField.hxx:1469
Contains helper functions for RNTupleReader::PrintInfo() and RPrintSchemaVisitor::VisitField()
static std::string FitString(const std::string &str, int availableSpace)
The field for values that may or may not be present in an entry.
Definition RField.hxx:1374
Visitor used for a pre-processing run to collect information needed by another visitor class.
void VisitField(const RFieldBase &field) final
void VisitFieldZero(const RFieldZero &field) final
Contains settings for printing and prints a summary of an RField instance.
void VisitField(const RFieldBase &field) final
Prints summary of Field.
std::ostream & fOutput
Where to write the printout to.
int fWidth
Indicates maximal number of allowed characters per line.
RPrintSchemaVisitor(std::ostream &out=std::cout, char frameSymbol=' *', int width=80, int deepestLevel=1, int numFields=1)
void SetAvailableSpaceForStrings()
Computes how many characters should be placed between the frame symbol and ':' for left and right sid...
char fFrameSymbol
To render the output, use an asterix (*) by default to draw table lines and boundaries.
void VisitFieldZero(const RFieldZero &fieldZero) final
Renders a JSON value corresponding to the field.
void VisitVectorBoolField(const RField< std::vector< bool > > &field) final
void VisitDoubleField(const RField< double > &field) final
void VisitUInt16Field(const RField< std::uint16_t > &field) final
std::ostream & fOutput
The output is directed to fOutput which may differ from std::cout.
void VisitArrayField(const RArrayField &field) final
void VisitFloatField(const RField< float > &field) final
void VisitRecordField(const RRecordField &field) final
void VisitStringField(const RField< std::string > &field) final
void VisitInt8Field(const RField< std::int8_t > &field) final
RPrintValueVisitor(RFieldBase::RValue value, std::ostream &output, unsigned int level=0, RPrintOptions options=RPrintOptions())
void PrintName(const RFieldBase &field)
void VisitNullableField(const RNullableField &field) final
void VisitUInt8Field(const RField< std::uint8_t > &field) final
void VisitBitsetField(const RBitsetField &field) final
void VisitCardinalityField(const RCardinalityField &field) final
void VisitAtomicField(const RAtomicField &field) final
void VisitRVecField(const RRVecField &field) final
void VisitUInt64Field(const RField< std::uint64_t > &field) final
void VisitEnumField(const REnumField &field) final
void VisitBoolField(const RField< bool > &field) final
void VisitField(const RFieldBase &field) final
void VisitProxiedCollectionField(const RProxiedCollectionField &field) final
void VisitInt16Field(const RField< std::int16_t > &field) final
void VisitArrayAsRVecField(const RArrayAsRVecField &field) final
void VisitByteField(const RField< std::byte > &field) final
void PrintCollection(const RFieldBase &field)
void VisitVectorField(const RVectorField &field) final
void VisitCharField(const RField< char > &field) final
void VisitInt64Field(const RField< std::int64_t > &field) final
void VisitClassField(const RClassField &field) final
void VisitIntField(const RField< int > &field) final
void VisitUInt32Field(const RField< std::uint32_t > &field) final
The field for a class representing a collection of elements via TVirtualCollectionProxy.
Definition RField.hxx:821
The type-erased field for a RVec<Type>
Definition RField.hxx:1086
The field for an untyped record.
Definition RField.hxx:964
The generic field for a (nested) std::vector<Type> except for std::vector<bool>
Definition RField.hxx:1031
const Int_t n
Definition legend1.C:16
This file contains a specialised ROOT message handler to test for diagnostic in unit tests.
static void output()