Logo ROOT  
Reference Guide
 
Loading...
Searching...
No Matches
RField.hxx
Go to the documentation of this file.
1/// \file ROOT/RField.hxx
2/// \author Jakob Blomer <jblomer@cern.ch>
3/// \date 2018-10-09
4
5/*************************************************************************
6 * Copyright (C) 1995-2019, Rene Brun and Fons Rademakers. *
7 * All rights reserved. *
8 * *
9 * For the licensing terms see $ROOTSYS/LICENSE. *
10 * For the list of contributors see $ROOTSYS/README/CREDITS. *
11 *************************************************************************/
12
13#ifndef ROOT_RField
14#define ROOT_RField
15
16#include <ROOT/RError.hxx>
17#include <ROOT/RFieldBase.hxx>
18#include <ROOT/RFieldUtils.hxx>
20#include <ROOT/RNTupleTypes.hxx>
21#include <ROOT/RSpan.hxx>
22#include <string_view>
23#include <ROOT/TypeTraits.hxx>
24
25#include <TGenericClassInfo.h>
26
27#include <algorithm>
28#include <array>
29#include <cstddef>
30#include <iostream>
31#include <memory>
32#include <string>
33#include <type_traits>
34#include <typeinfo>
35#include <vector>
36
37class TClass;
38class TEnum;
39class TObject;
41
42namespace ROOT {
43
44class TSchemaRule;
45class RNTupleCollectionView;
46
47namespace Detail {
48class RFieldVisitor;
49} // namespace Detail
50
51class RFieldZero;
52namespace Internal {
53void SetAllowFieldSubstitutions(RFieldZero &fieldZero, bool val);
54}
55
56/// The container field for an ntuple model, which itself has no physical representation.
57/// Therefore, the zero field must not be connected to a page source or sink.
58class RFieldZero final : public RFieldBase {
60
61 /// If field substitutions are allowed, upon connecting to a page source the field hierarchy will replace created
62 /// fields by fields that match the on-disk schema. This happens for
63 /// - Vector fields (RVectorField, RRVecField) that connect to an on-disk fixed-size array
64 /// - Streamer fields that connect to an on-disk class field
65 /// Field substitutions must not be enabled when the field hierarchy already handed out RValue objects because
66 /// they would leave dangling field pointers to the replaced fields. This is used in cases when the field/model
67 /// is created by RNTuple (not imposed), before it is made available to the user.
68 /// This flag is reset on Clone().
70
71 std::unordered_set<std::string> fSubfieldNames; ///< Efficient detection of duplicate field names
72
73protected:
74 std::unique_ptr<RFieldBase> CloneImpl(std::string_view newName) const final;
75 void ConstructValue(void *) const final {}
76
77public:
78 RFieldZero();
79
80 /// A public version of the Attach method that allows piece-wise construction of the zero field.
81 /// Will throw on duplicate subfield names.
82 void Attach(std::unique_ptr<RFieldBase> child);
83 size_t GetValueSize() const final { return 0; }
84 size_t GetAlignment() const final { return 0; }
85
87
89 /// Moves all subfields into the returned vector.
90 std::vector<std::unique_ptr<RFieldBase>> ReleaseSubfields();
91};
92
93/// Used in RFieldBase::Check() to record field creation failures.
94/// Also used when deserializing a field that contains unknown values that may come from
95/// future RNTuple versions (e.g. an unknown Structure)
97public:
98 enum class ECategory {
99 /// Generic unrecoverable error
100 kGeneric,
101 /// The type given to RFieldBase::Create was invalid
103 /// The type given to RFieldBase::Create was unknown
105 /// The field could not be created because its descriptor had an unknown structural role
107 };
108
109private:
110 std::string fError;
112
113protected:
114 std::unique_ptr<RFieldBase> CloneImpl(std::string_view newName) const final
115 {
116 return std::make_unique<RInvalidField>(newName, GetTypeName(), fError, fCategory);
117 }
118 void ConstructValue(void *) const final {}
119
120public:
121 RInvalidField(std::string_view name, std::string_view type, std::string_view error, ECategory category)
122 : RFieldBase(name, type, ROOT::ENTupleStructure::kPlain, false /* isSimple */), fError(error), fCategory(category)
123 {
125 }
126
127 const std::string &GetError() const { return fError; }
128 ECategory GetCategory() const { return fCategory; }
129
130 size_t GetValueSize() const final { return 0; }
131 size_t GetAlignment() const final { return 0; }
132}; // RInvalidField
133
134/// The field for a class with dictionary
135class RClassField : public RFieldBase {
136private:
143 std::size_t fOffset;
144 };
145 // Information to read into the staging area a field that is used as an input to an I/O customization rule
147 /// The field used to read the on-disk data. The fields type may be different from the on-disk type as long
148 /// as the on-disk type can be converted to the fields type (through type cast / schema evolution).
149 std::unique_ptr<RFieldBase> fField;
150 std::size_t fOffset; ///< offset in fStagingArea
151 };
152 /// Prefix used in the subfield names generated for base classes
153 static constexpr const char *kPrefixInherited{":"};
154
155 class RClassDeleter : public RDeleter {
156 private:
158
159 public:
160 explicit RClassDeleter(TClass *cl);
161 void operator()(void *objPtr, bool dtorOnly) final;
162 };
163
165 /// Additional information kept for each entry in `fSubfields`
166 std::vector<RSubfieldInfo> fSubfieldsInfo;
167
168 /// The staging area stores inputs to I/O rules according to the offsets given by the streamer info of
169 /// "TypeName@@Version". The area is allocated depending on I/O rules resp. the source members of the I/O rules.
170 std::unique_ptr<unsigned char[]> fStagingArea;
171 /// The TClass instance that corresponds to the staging area.
172 /// The staging class exists as <class name>@@<on-disk version> if the on-disk version is different from the
173 /// current in-memory version, or it can be accessed by the first @@alloc streamer element of the current streamer
174 /// info.
176 std::unordered_map<std::string, RStagingItem> fStagingItems; ///< Lookup staging items by member name
177
178private:
179 RClassField(std::string_view fieldName, const RClassField &source); ///< Used by CloneImpl
180 RClassField(std::string_view fieldName, TClass *classp);
181 void Attach(std::unique_ptr<RFieldBase> child, RSubfieldInfo info);
182
183 /// Returns the id of member 'name' in the class field given by 'fieldId', or kInvalidDescriptorId if no such
184 /// member exist. Looks recursively in base classes.
187 /// Sets fStagingClass according to the given name and version
188 void SetStagingClass(const std::string &className, unsigned int classVersion);
189 /// If there are rules with inputs (source members), create the staging area according to the TClass instance
190 /// that corresponds to the on-disk field.
191 void PrepareStagingArea(const std::vector<const TSchemaRule *> &rules, const ROOT::RNTupleDescriptor &desc,
193 /// Register post-read callback corresponding to a ROOT I/O customization rules.
195 /// Given the on-disk information from the page source, find all the I/O customization rules that apply
196 /// to the class field at hand, to which the fieldDesc descriptor, if provided, must correspond.
197 /// Fields may not have an on-disk representation (e.g., when inserted by schema evolution), in which case the passed
198 /// field descriptor is nullptr.
199 std::vector<const TSchemaRule *> FindRules(const ROOT::RFieldDescriptor *fieldDesc);
200
201protected:
202 std::unique_ptr<RFieldBase> CloneImpl(std::string_view newName) const final;
203
204 void ConstructValue(void *where) const final;
205 std::unique_ptr<RDeleter> GetDeleter() const final { return std::make_unique<RClassDeleter>(fClass); }
206
207 std::size_t AppendImpl(const void *from) final;
208 void ReadGlobalImpl(ROOT::NTupleSize_t globalIndex, void *to) final;
209 void ReadInClusterImpl(RNTupleLocalIndex localIndex, void *to) final;
210
211 std::unique_ptr<RFieldBase> BeforeConnectPageSource(ROOT::Internal::RPageSource &pageSource) final;
212 void ReconcileOnDiskField(const RNTupleDescriptor &desc) final;
213
214public:
215 RClassField(std::string_view fieldName, std::string_view className);
218 ~RClassField() override;
219
220 std::vector<RValue> SplitValue(const RValue &value) const final;
221 std::size_t GetValueSize() const final;
222 std::size_t GetAlignment() const final;
223 std::uint32_t GetTypeVersion() const final;
224 std::uint32_t GetTypeChecksum() const final;
225 /// For polymorphic classes (that declare or inherit at least one virtual method), return the expected dynamic type
226 /// of any user object. If the class is not polymorphic, return nullptr.
228 /// Return the TClass instance backing this field.
229 const TClass *GetClass() const { return fClass; }
231};
232
233/// The field for a class using ROOT standard streaming
235private:
237 private:
239
240 public:
241 explicit RStreamerFieldDeleter(TClass *cl);
242 void operator()(void *objPtr, bool dtorOnly) final;
243 };
244
245 TClass *fClass = nullptr;
246 ROOT::Internal::RNTupleSerializer::StreamerInfoMap_t fStreamerInfos; ///< streamer info records seen during writing
247 ROOT::Internal::RColumnIndex fIndex; ///< number of bytes written in the current cluster
248
249private:
250 RStreamerField(std::string_view fieldName, TClass *classp);
251
252protected:
253 std::unique_ptr<RFieldBase> CloneImpl(std::string_view newName) const final;
254
256 void GenerateColumns() final;
258
259 void ConstructValue(void *where) const final;
260 std::unique_ptr<RDeleter> GetDeleter() const final { return std::make_unique<RStreamerFieldDeleter>(fClass); }
261
262 std::size_t AppendImpl(const void *from) final;
263 void ReadGlobalImpl(ROOT::NTupleSize_t globalIndex, void *to) final;
264
266
267 bool HasExtraTypeInfo() const final { return true; }
268 // Returns the list of seen streamer infos
270
271 std::unique_ptr<RFieldBase> BeforeConnectPageSource(ROOT::Internal::RPageSource &source) final;
273
274public:
275 RStreamerField(std::string_view fieldName, std::string_view className);
279
280 size_t GetValueSize() const final;
281 size_t GetAlignment() const final;
282 std::uint32_t GetTypeVersion() const final;
283 std::uint32_t GetTypeChecksum() const final;
284 TClass *GetClass() const { return fClass; }
286};
287
288/// The field for an unscoped or scoped enum with dictionary
289class REnumField : public RFieldBase {
290private:
291 REnumField(std::string_view fieldName, TEnum *enump);
292 REnumField(std::string_view fieldName, std::string_view enumName, std::unique_ptr<RFieldBase> intField);
293
294protected:
295 std::unique_ptr<RFieldBase> CloneImpl(std::string_view newName) const final;
296
297 void ConstructValue(void *where) const final { CallConstructValueOn(*fSubfields[0], where); }
298
299 std::size_t AppendImpl(const void *from) final { return CallAppendOn(*fSubfields[0], from); }
302
303 void ReconcileOnDiskField(const RNTupleDescriptor &desc) final;
304
305public:
306 REnumField(std::string_view fieldName, std::string_view enumName);
309 ~REnumField() override = default;
310
311 std::vector<RValue> SplitValue(const RValue &value) const final;
312 size_t GetValueSize() const final { return fSubfields[0]->GetValueSize(); }
313 size_t GetAlignment() const final { return fSubfields[0]->GetAlignment(); }
315};
316
317/// Classes with dictionaries that can be inspected by TClass
318template <typename T, typename = void>
319class RField final : public RClassField {
320public:
321 static std::string TypeName() { return ROOT::Internal::GetRenormalizedTypeName(typeid(T)); }
322 RField(std::string_view name) : RClassField(name, Internal::GetDemangledTypeName(typeid(T)))
323 {
324 static_assert(std::is_class_v<T>, "no I/O support for this basic C++ type");
325 }
326 RField(RField &&other) = default;
329};
330
333public:
334 static std::string TypeName() { return ROOT::Internal::GetRenormalizedTypeName(typeid(T)); }
335 RField(std::string_view name) : REnumField(name, TypeName()) {}
336 RField(RField &&other) = default;
337 RField &operator=(RField &&other) = default;
338 ~RField() final = default;
339};
340
341/// An artificial field that transforms an RNTuple column that contains the offset of collections into
342/// collection sizes. It is only used for reading, e.g. as projected field or as an artificial field that provides the
343/// "number of" RDF columns for collections (e.g. `R_rdf_sizeof_jets` for a collection named `jets`).
344/// It is used in the templated RField<RNTupleCardinality<SizeT>> form, which represents the collection sizes either
345/// as 32bit unsigned int (std::uint32_t) or as 64bit unsigned int (std::uint64_t).
347 friend class ROOT::RNTupleCollectionView; // to access GetCollectionInfo()
348
349private:
358
359protected:
360 RCardinalityField(std::string_view fieldName, std::string_view typeName)
361 : RFieldBase(fieldName, typeName, ROOT::ENTupleStructure::kPlain, false /* isSimple */)
362 {
363 }
364
365 const RColumnRepresentations &GetColumnRepresentations() const final;
366 // Field is only used for reading
367 void GenerateColumns() final { throw RException(R__FAIL("Cardinality fields must only be used for reading")); }
368 void GenerateColumns(const ROOT::RNTupleDescriptor &) final;
369
370 void ReconcileOnDiskField(const RNTupleDescriptor &desc) final;
371
372public:
375 ~RCardinalityField() override = default;
376
377 void AcceptVisitor(ROOT::Detail::RFieldVisitor &visitor) const final;
378
379 const RField<RNTupleCardinality<std::uint32_t>> *As32Bit() const;
380 const RField<RNTupleCardinality<std::uint64_t>> *As64Bit() const;
381};
382
383template <typename T>
384class RSimpleField : public RFieldBase {
385 void ReconcileIntegralField(const RNTupleDescriptor &desc);
386 void ReconcileFloatingPointField(const RNTupleDescriptor &desc);
387
388protected:
391
392 void ConstructValue(void *where) const final { new (where) T{0}; }
393
394 void ReconcileOnDiskField(const RNTupleDescriptor &desc) override
395 {
396 if constexpr (std::is_integral_v<T>) {
397 ReconcileIntegralField(desc);
398 } else if constexpr (std::is_floating_point_v<T>) {
399 ReconcileFloatingPointField(desc);
400 } else {
401 RFieldBase::ReconcileOnDiskField(desc);
402 }
403 }
404
405 RSimpleField(std::string_view name, std::string_view type)
406 : RFieldBase(name, type, ROOT::ENTupleStructure::kPlain, true /* isSimple */)
407 {
408 fTraits |= kTraitTrivialType;
409 }
410
411public:
414 ~RSimpleField() override = default;
415
416 T *Map(ROOT::NTupleSize_t globalIndex) { return fPrincipalColumn->Map<T>(globalIndex); }
417 T *Map(RNTupleLocalIndex localIndex) { return fPrincipalColumn->Map<T>(localIndex); }
419 {
420 return fPrincipalColumn->MapV<T>(globalIndex, nItems);
421 }
423 {
424 return fPrincipalColumn->MapV<T>(localIndex, nItems);
425 }
426
427 size_t GetValueSize() const final { return sizeof(T); }
428 size_t GetAlignment() const final { return alignof(T); }
429};
430
431////////////////////////////////////////////////////////////////////////////////
432/// Template specializations for concrete C++ types
433////////////////////////////////////////////////////////////////////////////////
434
435} // namespace ROOT
436
441#include "RField/RFieldSoA.hxx"
443
444namespace ROOT {
445
446template <typename SizeT>
449
450protected:
451 std::unique_ptr<ROOT::RFieldBase> CloneImpl(std::string_view newName) const final
452 {
453 return std::make_unique<RField>(newName);
454 }
455 void ConstructValue(void *where) const final { new (where) CardinalityType(0); }
456
457 /// Get the number of elements of the collection identified by globalIndex
465
466 /// Get the number of elements of the collection identified by clusterIndex
474
475 std::size_t ReadBulkImpl(const RBulkSpec &bulkSpec) final
476 {
480
481 auto typedValues = static_cast<CardinalityType *>(bulkSpec.fValues);
483
484 auto lastOffset = collectionStart.GetIndexInCluster() + collectionSize;
486 std::size_t nEntries = 1;
487 while (nRemainingEntries > 0) {
489 auto offsets =
491 std::size_t nBatch = std::min(nRemainingEntries, nItemsUntilPageEnd);
492 for (std::size_t i = 0; i < nBatch; ++i) {
493 typedValues[nEntries + i] = offsets[i] - lastOffset;
494 lastOffset = offsets[i];
495 }
497 nEntries += nBatch;
498 }
499 return RBulkSpec::kAllSet;
500 }
501
502public:
503 static std::string TypeName() { return "ROOT::RNTupleCardinality<" + RField<SizeT>::TypeName() + ">"; }
504 explicit RField(std::string_view name) : RCardinalityField(name, TypeName()) {}
505 RField(RField &&other) = default;
508
509 size_t GetValueSize() const final { return sizeof(CardinalityType); }
510 size_t GetAlignment() const final { return alignof(CardinalityType); }
511};
512
513/// TObject requires special handling of the fBits and fUniqueID members
514template <>
516 static std::size_t GetOffsetOfMember(const char *name);
517 static std::size_t GetOffsetUniqueID() { return GetOffsetOfMember("fUniqueID"); }
518 static std::size_t GetOffsetBits() { return GetOffsetOfMember("fBits"); }
519
520private:
521 RField(std::string_view fieldName, const RField<TObject> &source); ///< Used by CloneImpl()
522
523protected:
524 std::unique_ptr<RFieldBase> CloneImpl(std::string_view newName) const final;
525
526 void ConstructValue(void *where) const final;
527 std::unique_ptr<RDeleter> GetDeleter() const final { return std::make_unique<RTypedDeleter<TObject>>(); }
528
529 std::size_t AppendImpl(const void *from) final;
530 void ReadTObject(void *to, UInt_t uniqueID, UInt_t bits);
531 void ReadGlobalImpl(ROOT::NTupleSize_t globalIndex, void *to) final;
532 void ReadInClusterImpl(RNTupleLocalIndex localIndex, void *to) final;
533
534public:
535 static std::string TypeName() { return "TObject"; }
536
537 RField(std::string_view fieldName);
538 RField(RField &&other) = default;
541
543 size_t GetValueSize() const final;
544 size_t GetAlignment() const final;
545 std::uint32_t GetTypeVersion() const final;
546 std::uint32_t GetTypeChecksum() const final;
548};
549
550// Have to be implemented after the definition of all RField<T> types
551
552namespace Internal {
553
554/// Helper to check if a given type name is the one expected of Field<T>. Usually, this check can be done by
555/// type renormalization of the demangled type name T. The failure case, however, needs to additionally check for
556/// ROOT-specific special cases.
557template <class T>
558bool IsMatchingFieldType(const std::string &actualTypeName)
559{
561}
562
563} // namespace Internal
564
565template <typename T>
566std::unique_ptr<T, typename RFieldBase::RCreateObjectDeleter<T>::deleter> RFieldBase::CreateObject() const
567{
568 if (!Internal::IsMatchingFieldType<T>(GetTypeName())) {
569 throw RException(
570 R__FAIL("type mismatch for field " + GetFieldName() + ": " + GetTypeName() + " vs. " + RField<T>::TypeName()));
571 }
572 return std::unique_ptr<T>(static_cast<T *>(CreateObjectRawPtr()));
573}
574
575// The void type is specialized in RField.cxx
576
577template <>
580 void operator()(void *);
581};
582
583template <>
584std::unique_ptr<void, typename RFieldBase::RCreateObjectDeleter<void>::deleter>
585ROOT::RFieldBase::CreateObject<void>() const;
586
587} // namespace ROOT
588
589#endif
#define R__FAIL(msg)
Short-hand to return an RResult<T> in an error state; the RError is implicitly converted into RResult...
Definition RError.hxx:299
size_t size(const MatrixT &matrix)
retrieve the size of a square matrix
unsigned int UInt_t
Unsigned integer 4 bytes (unsigned int)
Definition RtypesCore.h:60
ROOT::Detail::TRangeCast< T, true > TRangeDynCast
TRangeDynCast is an adapter class that allows the typed iteration through a TCollection.
Option_t Option_t TPoint TPoint const char GetTextMagnitude GetFillStyle GetLineColor GetLineWidth GetMarkerStyle GetTextAlign GetTextColor GetTextSize void char Point_t Rectangle_t WindowAttributes_t Float_t Float_t Float_t Int_t Int_t UInt_t UInt_t Rectangle_t Int_t Int_t Window_t child
Option_t Option_t TPoint TPoint const char GetTextMagnitude GetFillStyle GetLineColor GetLineWidth GetMarkerStyle GetTextAlign GetTextColor GetTextSize void value
Option_t Option_t TPoint TPoint const char GetTextMagnitude GetFillStyle GetLineColor GetLineWidth GetMarkerStyle GetTextAlign GetTextColor GetTextSize void char Point_t Rectangle_t WindowAttributes_t Float_t Float_t Float_t Int_t Int_t UInt_t UInt_t Rectangle_t Int_t Int_t Window_t TString Int_t GCValues_t GetPrimarySelectionOwner GetDisplay GetScreen GetColormap GetNativeEvent const char const char dpyName wid window const char font_name cursor keysym reg const char only_if_exist regb h Point_t winding char text const char depth char const char Int_t count const char ColorStruct_t color const char Pixmap_t Pixmap_t PictureAttributes_t attr const char char ret_data h unsigned char height h Atom_t Int_t ULong_t ULong_t unsigned char prop_list Atom_t Atom_t Atom_t Time_t type
char name[80]
Definition TGX11.cxx:148
Abstract base class for classes implementing the visitor design pattern.
The in-memory representation of a 32bit or 64bit on-disk index column.
void GetCollectionInfo(const ROOT::NTupleSize_t globalIndex, RNTupleLocalIndex *collectionStart, ROOT::NTupleSize_t *collectionSize)
For offset columns only, look at the two adjacent values that define a collection's coordinates.
Definition RColumn.hxx:282
CppT * MapV(const ROOT::NTupleSize_t globalIndex, ROOT::NTupleSize_t &nItems)
Definition RColumn.hxx:240
std::map< Int_t, TVirtualStreamerInfo * > StreamerInfoMap_t
Abstract interface to read data from an ntuple.
An artificial field that transforms an RNTuple column that contains the offset of collections into co...
Definition RField.hxx:346
RCardinalityField(RCardinalityField &&other)=default
void GetCollectionInfo(ROOT::NTupleSize_t globalIndex, RNTupleLocalIndex *collectionStart, ROOT::NTupleSize_t *size)
Definition RField.hxx:350
RCardinalityField & operator=(RCardinalityField &&other)=default
void GetCollectionInfo(RNTupleLocalIndex localIndex, RNTupleLocalIndex *collectionStart, ROOT::NTupleSize_t *size)
Definition RField.hxx:354
~RCardinalityField() override=default
RCardinalityField(std::string_view fieldName, std::string_view typeName)
Definition RField.hxx:360
void operator()(void *objPtr, bool dtorOnly) final
The field for a class with dictionary.
Definition RField.hxx:135
const TClass * GetClass() const
Return the TClass instance backing this field.
Definition RField.hxx:229
std::unique_ptr< RFieldBase > BeforeConnectPageSource(ROOT::Internal::RPageSource &pageSource) final
Called by ConnectPageSource() before connecting; derived classes may override this as appropriate,...
void AddReadCallbacksFromIORule(const TSchemaRule *rule)
Register post-read callback corresponding to a ROOT I/O customization rules.
TClass * fStagingClass
The TClass instance that corresponds to the staging area.
Definition RField.hxx:175
std::size_t AppendImpl(const void *from) final
Operations on values of complex types, e.g.
std::unique_ptr< RFieldBase > CloneImpl(std::string_view newName) const final
Called by Clone(), which additionally copies the on-disk ID.
RClassField(RClassField &&other)=default
std::size_t GetAlignment() const final
What alignof(T) for this type returns.
void ReconcileOnDiskField(const RNTupleDescriptor &desc) final
For non-artificial fields, check compatibility of the in-memory field and the on-disk field.
std::vector< RSubfieldInfo > fSubfieldsInfo
Additional information kept for each entry in fSubfields
Definition RField.hxx:166
void Attach(std::unique_ptr< RFieldBase > child, RSubfieldInfo info)
std::unique_ptr< unsigned char[]> fStagingArea
The staging area stores inputs to I/O rules according to the offsets given by the streamer info of "T...
Definition RField.hxx:170
RClassField & operator=(RClassField &&other)=default
std::size_t GetValueSize() const final
What sizeof(T) for this type returns.
void ReadGlobalImpl(ROOT::NTupleSize_t globalIndex, void *to) final
void ConstructValue(void *where) const final
Constructs value in a given location of size at least GetValueSize(). Called by the base class' Creat...
void AcceptVisitor(ROOT::Detail::RFieldVisitor &visitor) const final
std::vector< const TSchemaRule * > FindRules(const ROOT::RFieldDescriptor *fieldDesc)
Given the on-disk information from the page source, find all the I/O customization rules that apply t...
ROOT::DescriptorId_t LookupMember(const ROOT::RNTupleDescriptor &desc, std::string_view memberName, ROOT::DescriptorId_t classFieldId)
Returns the id of member 'name' in the class field given by 'fieldId', or kInvalidDescriptorId if no ...
void ReadInClusterImpl(RNTupleLocalIndex localIndex, void *to) final
TClass * fClass
Definition RField.hxx:164
std::uint32_t GetTypeVersion() const final
Indicates an evolution of the C++ type itself.
RClassField(std::string_view fieldName, const RClassField &source)
Used by CloneImpl.
void PrepareStagingArea(const std::vector< const TSchemaRule * > &rules, const ROOT::RNTupleDescriptor &desc, const ROOT::RFieldDescriptor &classFieldId)
If there are rules with inputs (source members), create the staging area according to the TClass inst...
std::vector< RValue > SplitValue(const RValue &value) const final
Creates the list of direct child values given an existing value for this field.
const std::type_info * GetPolymorphicTypeInfo() const
For polymorphic classes (that declare or inherit at least one virtual method), return the expected dy...
~RClassField() override
std::uint32_t GetTypeChecksum() const final
Return the current TClass reported checksum of this class. Only valid if kTraitTypeChecksum is set.
std::unique_ptr< RDeleter > GetDeleter() const final
Definition RField.hxx:205
std::unordered_map< std::string, RStagingItem > fStagingItems
Lookup staging items by member name.
Definition RField.hxx:176
static constexpr const char * kPrefixInherited
Prefix used in the subfield names generated for base classes.
Definition RField.hxx:153
void SetStagingClass(const std::string &className, unsigned int classVersion)
Sets fStagingClass according to the given name and version.
The field for an unscoped or scoped enum with dictionary.
Definition RField.hxx:289
std::unique_ptr< RFieldBase > CloneImpl(std::string_view newName) const final
Called by Clone(), which additionally copies the on-disk ID.
size_t GetValueSize() const final
What sizeof(T) for this type returns.
Definition RField.hxx:312
size_t GetAlignment() const final
What alignof(T) for this type returns.
Definition RField.hxx:313
std::vector< RValue > SplitValue(const RValue &value) const final
Creates the list of direct child values given an existing value for this field.
void AcceptVisitor(ROOT::Detail::RFieldVisitor &visitor) const final
~REnumField() override=default
REnumField(REnumField &&other)=default
void ConstructValue(void *where) const final
Constructs value in a given location of size at least GetValueSize(). Called by the base class' Creat...
Definition RField.hxx:297
void ReadInClusterImpl(RNTupleLocalIndex localIndex, void *to) final
Definition RField.hxx:301
void ReadGlobalImpl(ROOT::NTupleSize_t globalIndex, void *to) final
Definition RField.hxx:300
REnumField & operator=(REnumField &&other)=default
REnumField(std::string_view fieldName, TEnum *enump)
void ReconcileOnDiskField(const RNTupleDescriptor &desc) final
For non-artificial fields, check compatibility of the in-memory field and the on-disk field.
std::size_t AppendImpl(const void *from) final
Operations on values of complex types, e.g.
Definition RField.hxx:299
Base class for all ROOT issued exceptions.
Definition RError.hxx:78
Field specific extra type information from the header / extenstion header.
The list of column representations a field can have.
A functor to release the memory acquired by CreateValue() (memory and constructor).
Points to an object with RNTuple I/O support and keeps a pointer to the corresponding field.
A field translates read and write calls from/to underlying columns to/from tree values.
ROOT::Internal::RColumn * fPrincipalColumn
All fields that have columns have a distinct main column.
std::vector< std::unique_ptr< RFieldBase > > fSubfields
Collections and classes own subfields.
std::unique_ptr< T, typename RCreateObjectDeleter< T >::deleter > CreateObject() const
Generates an object of the field type and allocates new initialized memory according to the type.
Definition RField.hxx:566
const std::string & GetFieldName() const
static std::size_t CallAppendOn(RFieldBase &other, const void *from)
Allow derived classes to call Append() and Read() on other (sub)fields.
std::uint32_t fTraits
Properties of the type that allow for optimizations of collections of that type.
@ kTraitInvalidField
This field is an instance of RInvalidField and can be safely static_cast to it.
const std::string & GetTypeName() const
static void CallReadOn(RFieldBase &other, RNTupleLocalIndex localIndex, void *to)
static void CallConstructValueOn(const RFieldBase &other, void *where)
Allow derived classes to call ConstructValue(void *) and GetDeleter() on other (sub)fields.
void * CreateObjectRawPtr() const
Factory method for the field's type. The caller owns the returned pointer.
Metadata stored for every field of an RNTuple.
The container field for an ntuple model, which itself has no physical representation.
Definition RField.hxx:58
std::unordered_set< std::string > fSubfieldNames
Efficient detection of duplicate field names.
Definition RField.hxx:71
void AcceptVisitor(ROOT::Detail::RFieldVisitor &visitor) const final
Definition RField.cxx:73
size_t GetValueSize() const final
What sizeof(T) for this type returns.
Definition RField.hxx:83
bool GetAllowFieldSubstitutions() const
Definition RField.hxx:88
void ConstructValue(void *) const final
Constructs value in a given location of size at least GetValueSize(). Called by the base class' Creat...
Definition RField.hxx:75
std::unique_ptr< RFieldBase > CloneImpl(std::string_view newName) const final
Called by Clone(), which additionally copies the on-disk ID.
Definition RField.cxx:54
size_t GetAlignment() const final
What alignof(T) for this type returns.
Definition RField.hxx:84
std::vector< std::unique_ptr< RFieldBase > > ReleaseSubfields()
Moves all subfields into the returned vector.
Definition RField.cxx:64
bool fAllowFieldSubstitutions
If field substitutions are allowed, upon connecting to a page source the field hierarchy will replace...
Definition RField.hxx:69
void Attach(std::unique_ptr< RFieldBase > child)
A public version of the Attach method that allows piece-wise construction of the zero field.
Definition RField.cxx:40
void ReadGlobalImpl(ROOT::NTupleSize_t globalIndex, void *to) final
Get the number of elements of the collection identified by globalIndex.
Definition RField.hxx:458
RField & operator=(RField &&other)=default
std::size_t ReadBulkImpl(const RBulkSpec &bulkSpec) final
General implementation of bulk read.
Definition RField.hxx:475
void ConstructValue(void *where) const final
Constructs value in a given location of size at least GetValueSize(). Called by the base class' Creat...
Definition RField.hxx:455
void ReadInClusterImpl(RNTupleLocalIndex localIndex, void *to) final
Get the number of elements of the collection identified by clusterIndex.
Definition RField.hxx:467
std::unique_ptr< ROOT::RFieldBase > CloneImpl(std::string_view newName) const final
Called by Clone(), which additionally copies the on-disk ID.
Definition RField.hxx:451
size_t GetAlignment() const final
What alignof(T) for this type returns.
Definition RField.hxx:510
RField(RField &&other)=default
RField & operator=(RField &&other)=default
~RField() final=default
static std::string TypeName()
Definition RField.hxx:535
std::unique_ptr< RDeleter > GetDeleter() const final
Definition RField.hxx:527
static std::size_t GetOffsetBits()
Definition RField.hxx:518
static std::size_t GetOffsetUniqueID()
Definition RField.hxx:517
Classes with dictionaries that can be inspected by TClass.
Definition RField.hxx:319
~RField() final=default
RField(RField &&other)=default
RField & operator=(RField &&other)=default
static std::string TypeName()
Definition RField.hxx:321
RField(std::string_view name)
Definition RField.hxx:322
Used in RFieldBase::Check() to record field creation failures.
Definition RField.hxx:96
RInvalidField(std::string_view name, std::string_view type, std::string_view error, ECategory category)
Definition RField.hxx:121
@ kGeneric
Generic unrecoverable error.
@ kUnknownType
The type given to RFieldBase::Create was unknown.
@ kTypeError
The type given to RFieldBase::Create was invalid.
@ kUnknownStructure
The field could not be created because its descriptor had an unknown structural role.
std::unique_ptr< RFieldBase > CloneImpl(std::string_view newName) const final
Called by Clone(), which additionally copies the on-disk ID.
Definition RField.hxx:114
ECategory fCategory
Definition RField.hxx:111
size_t GetAlignment() const final
What alignof(T) for this type returns.
Definition RField.hxx:131
std::string fError
Definition RField.hxx:110
const std::string & GetError() const
Definition RField.hxx:127
ECategory GetCategory() const
Definition RField.hxx:128
size_t GetValueSize() const final
What sizeof(T) for this type returns.
Definition RField.hxx:130
void ConstructValue(void *) const final
Constructs value in a given location of size at least GetValueSize(). Called by the base class' Creat...
Definition RField.hxx:118
A view for a collection, that can itself generate new ntuple views for its nested fields.
The on-storage metadata of an RNTuple.
Addresses a column element or field item relative to a particular cluster, instead of a global NTuple...
void GenerateColumns() override
Implementations in derived classes should create the backing columns corresponding to the field type ...
Definition RField.hxx:389
size_t GetAlignment() const final
What alignof(T) for this type returns.
Definition RField.hxx:428
RSimpleField & operator=(RSimpleField &&other)=default
RSimpleField(std::string_view name, std::string_view type)
Definition RField.hxx:405
T * Map(RNTupleLocalIndex localIndex)
Definition RField.hxx:417
~RSimpleField() override=default
T * Map(ROOT::NTupleSize_t globalIndex)
Definition RField.hxx:416
size_t GetValueSize() const final
What sizeof(T) for this type returns.
Definition RField.hxx:427
void ReconcileOnDiskField(const RNTupleDescriptor &desc) override
For non-artificial fields, check compatibility of the in-memory field and the on-disk field.
Definition RField.hxx:394
RSimpleField(RSimpleField &&other)=default
void ConstructValue(void *where) const final
Constructs value in a given location of size at least GetValueSize(). Called by the base class' Creat...
Definition RField.hxx:392
T * MapV(ROOT::NTupleSize_t globalIndex, ROOT::NTupleSize_t &nItems)
Definition RField.hxx:418
void GenerateColumns(const ROOT::RNTupleDescriptor &desc) override
Implementations in derived classes should create the backing columns corresponding to the field type ...
Definition RField.hxx:390
T * MapV(RNTupleLocalIndex localIndex, ROOT::NTupleSize_t &nItems)
Definition RField.hxx:422
void operator()(void *objPtr, bool dtorOnly) final
The field for a class using ROOT standard streaming.
Definition RField.hxx:234
ROOT::RExtraTypeInfoDescriptor GetExtraTypeInfo() const final
void ReadGlobalImpl(ROOT::NTupleSize_t globalIndex, void *to) final
ROOT::Internal::RNTupleSerializer::StreamerInfoMap_t fStreamerInfos
streamer info records seen during writing
Definition RField.hxx:246
void ReconcileOnDiskField(const RNTupleDescriptor &desc) final
For non-artificial fields, check compatibility of the in-memory field and the on-disk field.
std::uint32_t GetTypeVersion() const final
Indicates an evolution of the C++ type itself.
void GenerateColumns() final
Implementations in derived classes should create the backing columns corresponding to the field type ...
void ConstructValue(void *where) const final
Constructs value in a given location of size at least GetValueSize(). Called by the base class' Creat...
ROOT::Internal::RColumnIndex fIndex
number of bytes written in the current cluster
Definition RField.hxx:247
std::uint32_t GetTypeChecksum() const final
Return the current TClass reported checksum of this class. Only valid if kTraitTypeChecksum is set.
std::unique_ptr< RFieldBase > BeforeConnectPageSource(ROOT::Internal::RPageSource &source) final
Called by ConnectPageSource() before connecting; derived classes may override this as appropriate,...
std::unique_ptr< RFieldBase > CloneImpl(std::string_view newName) const final
Called by Clone(), which additionally copies the on-disk ID.
bool HasExtraTypeInfo() const final
Definition RField.hxx:267
std::size_t AppendImpl(const void *from) final
Operations on values of complex types, e.g.
void AcceptVisitor(ROOT::Detail::RFieldVisitor &visitor) const final
void CommitClusterImpl() final
Definition RField.hxx:265
RStreamerField(std::string_view fieldName, TClass *classp)
size_t GetAlignment() const final
What alignof(T) for this type returns.
const RColumnRepresentations & GetColumnRepresentations() const final
Implementations in derived classes should return a static RColumnRepresentations object.
std::unique_ptr< RDeleter > GetDeleter() const final
Definition RField.hxx:260
TClass * GetClass() const
Definition RField.hxx:284
size_t GetValueSize() const final
What sizeof(T) for this type returns.
TClass instances represent classes, structs and namespaces in the ROOT type system.
Definition TClass.h:84
The TEnum class implements the enum type.
Definition TEnum.h:33
Mother of all ROOT objects.
Definition TObject.h:42
Abstract Interface class describing Streamer information for one class.
void SetAllowFieldSubstitutions(RFieldZero &fieldZero, bool val)
Definition RField.cxx:35
bool IsMatchingFieldType(const std::string &actualTypeName)
Helper to check if a given type name is the one expected of Field<T>.
Definition RField.hxx:558
std::string GetRenormalizedTypeName(const std::string &metaNormalizedName)
Given a type name normalized by ROOT meta, renormalize it for RNTuple. E.g., insert std::prefix.
std::string GetDemangledTypeName(const std::type_info &t)
std::uint64_t DescriptorId_t
Distriniguishes elements of the same type within a descriptor, e.g. different fields.
std::uint64_t NTupleSize_t
Integer type long enough to hold the maximum number of entries in a column.
ENTupleStructure
The fields in the RNTuple data model tree can carry different structural information about the type s...
std::size_t fOffset
offset in fStagingArea
Definition RField.hxx:150
std::unique_ptr< RFieldBase > fField
The field used to read the on-disk data.
Definition RField.hxx:149
Input parameter to RFieldBase::ReadBulk() and RFieldBase::ReadBulkImpl().
Helper types to present an offset column as array of collection sizes.