Logo ROOT  
Reference Guide
 
Loading...
Searching...
No Matches
RField.hxx
Go to the documentation of this file.
1/// \file ROOT/RField.hxx
2/// \ingroup NTuple
3/// \author Jakob Blomer <jblomer@cern.ch>
4/// \date 2018-10-09
5
6/*************************************************************************
7 * Copyright (C) 1995-2019, Rene Brun and Fons Rademakers. *
8 * All rights reserved. *
9 * *
10 * For the licensing terms see $ROOTSYS/LICENSE. *
11 * For the list of contributors see $ROOTSYS/README/CREDITS. *
12 *************************************************************************/
13
14#ifndef ROOT_RField
15#define ROOT_RField
16
17#include <ROOT/RError.hxx>
18#include <ROOT/RFieldBase.hxx>
19#include <ROOT/RFieldUtils.hxx>
21#include <ROOT/RNTupleTypes.hxx>
22#include <ROOT/RSpan.hxx>
23#include <string_view>
24#include <ROOT/TypeTraits.hxx>
25
26#include <TGenericClassInfo.h>
27
28#include <algorithm>
29#include <array>
30#include <cstddef>
31#include <iostream>
32#include <memory>
33#include <string>
34#include <type_traits>
35#include <typeinfo>
36#include <vector>
37
38class TClass;
39class TEnum;
40class TObject;
42
43namespace ROOT {
44
45class TSchemaRule;
46class RNTupleCollectionView;
47
48namespace Detail {
49class RFieldVisitor;
50} // namespace Detail
51
52class RFieldZero;
53namespace Internal {
54void SetAllowFieldSubstitutions(RFieldZero &fieldZero, bool val);
55}
56
57/// The container field for an ntuple model, which itself has no physical representation.
58/// Therefore, the zero field must not be connected to a page source or sink.
59class RFieldZero final : public RFieldBase {
61
62 /// If field substitutions are allowed, upon connecting to a page source the field hierarchy will replace created
63 /// fields by fields that match the on-disk schema. This happens for
64 /// - Vector fields (RVectorField, RRVecField) that connect to an on-disk fixed-size array
65 /// - Streamer fields that connect to an on-disk class field
66 /// Field substitutions must not be enabled when the field hierarchy already handed out RValue objects because
67 /// they would leave dangling field pointers to the replaced fields. This is used in cases when the field/model
68 /// is created by RNTuple (not imposed), before it is made available to the user.
69 /// This flag is reset on Clone().
71
72 std::unordered_set<std::string> fSubfieldNames; ///< Efficient detection of duplicate field names
73
74protected:
75 std::unique_ptr<RFieldBase> CloneImpl(std::string_view newName) const final;
76 void ConstructValue(void *) const final {}
77
78public:
79 RFieldZero();
80
81 /// A public version of the Attach method that allows piece-wise construction of the zero field.
82 /// Will throw on duplicate subfield names.
83 void Attach(std::unique_ptr<RFieldBase> child);
84 size_t GetValueSize() const final { return 0; }
85 size_t GetAlignment() const final { return 0; }
86
88
90 /// Moves all subfields into the returned vector.
91 std::vector<std::unique_ptr<RFieldBase>> ReleaseSubfields();
92};
93
94/// Used in RFieldBase::Check() to record field creation failures.
95/// Also used when deserializing a field that contains unknown values that may come from
96/// future RNTuple versions (e.g. an unknown Structure)
98public:
99 enum class ECategory {
100 /// Generic unrecoverable error
101 kGeneric,
102 /// The type given to RFieldBase::Create was invalid
104 /// The type given to RFieldBase::Create was unknown
106 /// The field could not be created because its descriptor had an unknown structural role
108 };
109
110private:
111 std::string fError;
113
114protected:
115 std::unique_ptr<RFieldBase> CloneImpl(std::string_view newName) const final
116 {
117 return std::make_unique<RInvalidField>(newName, GetTypeName(), fError, fCategory);
118 }
119 void ConstructValue(void *) const final {}
120
121public:
122 RInvalidField(std::string_view name, std::string_view type, std::string_view error, ECategory category)
123 : RFieldBase(name, type, ROOT::ENTupleStructure::kPlain, false /* isSimple */), fError(error), fCategory(category)
124 {
126 }
127
128 const std::string &GetError() const { return fError; }
129 ECategory GetCategory() const { return fCategory; }
130
131 size_t GetValueSize() const final { return 0; }
132 size_t GetAlignment() const final { return 0; }
133}; // RInvalidField
134
135/// The field for a class with dictionary
136class RClassField : public RFieldBase {
137private:
144 std::size_t fOffset;
145 };
146 // Information to read into the staging area a field that is used as an input to an I/O customization rule
148 /// The field used to read the on-disk data. The fields type may be different from the on-disk type as long
149 /// as the on-disk type can be converted to the fields type (through type cast / schema evolution).
150 std::unique_ptr<RFieldBase> fField;
151 std::size_t fOffset; ///< offset in fStagingArea
152 };
153 /// Prefix used in the subfield names generated for base classes
154 static constexpr const char *kPrefixInherited{":"};
155
156 class RClassDeleter : public RDeleter {
157 private:
159
160 public:
161 explicit RClassDeleter(TClass *cl) : fClass(cl) {}
162 void operator()(void *objPtr, bool dtorOnly) final;
163 };
164
166 /// Additional information kept for each entry in `fSubfields`
167 std::vector<RSubfieldInfo> fSubfieldsInfo;
168 std::size_t fMaxAlignment = 1;
169
170 /// The staging area stores inputs to I/O rules according to the offsets given by the streamer info of
171 /// "TypeName@@Version". The area is allocated depending on I/O rules resp. the source members of the I/O rules.
172 std::unique_ptr<unsigned char[]> fStagingArea;
173 /// The TClass instance that corresponds to the staging area.
174 /// The staging class exists as <class name>@@<on-disk version> if the on-disk version is different from the
175 /// current in-memory version, or it can be accessed by the first @@alloc streamer element of the current streamer
176 /// info.
178 std::unordered_map<std::string, RStagingItem> fStagingItems; ///< Lookup staging items by member name
179
180private:
181 RClassField(std::string_view fieldName, const RClassField &source); ///< Used by CloneImpl
182 RClassField(std::string_view fieldName, TClass *classp);
183 void Attach(std::unique_ptr<RFieldBase> child, RSubfieldInfo info);
184
185 /// Returns the id of member 'name' in the class field given by 'fieldId', or kInvalidDescriptorId if no such
186 /// member exist. Looks recursively in base classes.
189 /// Sets fStagingClass according to the given name and version
190 void SetStagingClass(const std::string &className, unsigned int classVersion);
191 /// If there are rules with inputs (source members), create the staging area according to the TClass instance
192 /// that corresponds to the on-disk field.
193 void PrepareStagingArea(const std::vector<const TSchemaRule *> &rules, const ROOT::RNTupleDescriptor &desc,
195 /// Register post-read callback corresponding to a ROOT I/O customization rules.
197 /// Given the on-disk information from the page source, find all the I/O customization rules that apply
198 /// to the class field at hand, to which the fieldDesc descriptor, if provided, must correspond.
199 /// Fields may not have an on-disk representation (e.g., when inserted by schema evolution), in which case the passed
200 /// field descriptor is nullptr.
201 std::vector<const TSchemaRule *> FindRules(const ROOT::RFieldDescriptor *fieldDesc);
202
203protected:
204 std::unique_ptr<RFieldBase> CloneImpl(std::string_view newName) const final;
205
206 void ConstructValue(void *where) const final;
207 std::unique_ptr<RDeleter> GetDeleter() const final { return std::make_unique<RClassDeleter>(fClass); }
208
209 std::size_t AppendImpl(const void *from) final;
210 void ReadGlobalImpl(ROOT::NTupleSize_t globalIndex, void *to) final;
211 void ReadInClusterImpl(RNTupleLocalIndex localIndex, void *to) final;
212
213 std::unique_ptr<RFieldBase> BeforeConnectPageSource(ROOT::Internal::RPageSource &pageSource) final;
214 void ReconcileOnDiskField(const RNTupleDescriptor &desc) final;
215
216public:
217 RClassField(std::string_view fieldName, std::string_view className);
220 ~RClassField() override;
221
222 std::vector<RValue> SplitValue(const RValue &value) const final;
223 size_t GetValueSize() const final;
225 std::uint32_t GetTypeVersion() const final;
226 std::uint32_t GetTypeChecksum() const final;
227 /// For polymorphic classes (that declare or inherit at least one virtual method), return the expected dynamic type
228 /// of any user object. If the class is not polymorphic, return nullptr.
230 /// Return the TClass instance backing this field.
231 const TClass *GetClass() const { return fClass; }
233};
234
235/// The field for a class using ROOT standard streaming
237private:
239 private:
241
242 public:
243 explicit RStreamerFieldDeleter(TClass *cl) : fClass(cl) {}
244 void operator()(void *objPtr, bool dtorOnly) final;
245 };
246
247 TClass *fClass = nullptr;
248 ROOT::Internal::RNTupleSerializer::StreamerInfoMap_t fStreamerInfos; ///< streamer info records seen during writing
249 ROOT::Internal::RColumnIndex fIndex; ///< number of bytes written in the current cluster
250
251private:
252 RStreamerField(std::string_view fieldName, TClass *classp);
253
254protected:
255 std::unique_ptr<RFieldBase> CloneImpl(std::string_view newName) const final;
256
258 void GenerateColumns() final;
260
261 void ConstructValue(void *where) const final;
262 std::unique_ptr<RDeleter> GetDeleter() const final { return std::make_unique<RStreamerFieldDeleter>(fClass); }
263
264 std::size_t AppendImpl(const void *from) final;
265 void ReadGlobalImpl(ROOT::NTupleSize_t globalIndex, void *to) final;
266
268
269 bool HasExtraTypeInfo() const final { return true; }
270 // Returns the list of seen streamer infos
272
273 std::unique_ptr<RFieldBase> BeforeConnectPageSource(ROOT::Internal::RPageSource &source) final;
275
276public:
277 RStreamerField(std::string_view fieldName, std::string_view className);
281
282 size_t GetValueSize() const final;
283 size_t GetAlignment() const final;
284 std::uint32_t GetTypeVersion() const final;
285 std::uint32_t GetTypeChecksum() const final;
286 TClass *GetClass() const { return fClass; }
288};
289
290/// The field for an unscoped or scoped enum with dictionary
291class REnumField : public RFieldBase {
292private:
293 REnumField(std::string_view fieldName, TEnum *enump);
294 REnumField(std::string_view fieldName, std::string_view enumName, std::unique_ptr<RFieldBase> intField);
295
296protected:
297 std::unique_ptr<RFieldBase> CloneImpl(std::string_view newName) const final;
298
299 void ConstructValue(void *where) const final { CallConstructValueOn(*fSubfields[0], where); }
300
301 std::size_t AppendImpl(const void *from) final { return CallAppendOn(*fSubfields[0], from); }
304
305 void ReconcileOnDiskField(const RNTupleDescriptor &desc) final;
306
307public:
308 REnumField(std::string_view fieldName, std::string_view enumName);
311 ~REnumField() override = default;
312
313 std::vector<RValue> SplitValue(const RValue &value) const final;
314 size_t GetValueSize() const final { return fSubfields[0]->GetValueSize(); }
315 size_t GetAlignment() const final { return fSubfields[0]->GetAlignment(); }
317};
318
319/// Classes with dictionaries that can be inspected by TClass
320template <typename T, typename = void>
321class RField final : public RClassField {
322public:
323 static std::string TypeName() { return ROOT::Internal::GetRenormalizedTypeName(typeid(T)); }
324 RField(std::string_view name) : RClassField(name, Internal::GetDemangledTypeName(typeid(T)))
325 {
326 static_assert(std::is_class_v<T>, "no I/O support for this basic C++ type");
327 }
328 RField(RField &&other) = default;
331};
332
335public:
336 static std::string TypeName() { return ROOT::Internal::GetRenormalizedTypeName(typeid(T)); }
337 RField(std::string_view name) : REnumField(name, TypeName()) {}
338 RField(RField &&other) = default;
339 RField &operator=(RField &&other) = default;
340 ~RField() final = default;
341};
342
343/// An artificial field that transforms an RNTuple column that contains the offset of collections into
344/// collection sizes. It is only used for reading, e.g. as projected field or as an artificial field that provides the
345/// "number of" RDF columns for collections (e.g. `R_rdf_sizeof_jets` for a collection named `jets`).
346/// It is used in the templated RField<RNTupleCardinality<SizeT>> form, which represents the collection sizes either
347/// as 32bit unsigned int (std::uint32_t) or as 64bit unsigned int (std::uint64_t).
349 friend class ROOT::RNTupleCollectionView; // to access GetCollectionInfo()
350
351private:
360
361protected:
362 RCardinalityField(std::string_view fieldName, std::string_view typeName)
363 : RFieldBase(fieldName, typeName, ROOT::ENTupleStructure::kPlain, false /* isSimple */)
364 {
365 }
366
367 const RColumnRepresentations &GetColumnRepresentations() const final;
368 // Field is only used for reading
369 void GenerateColumns() final { throw RException(R__FAIL("Cardinality fields must only be used for reading")); }
370 void GenerateColumns(const ROOT::RNTupleDescriptor &) final;
371
372 void ReconcileOnDiskField(const RNTupleDescriptor &desc) final;
373
374public:
377 ~RCardinalityField() override = default;
378
379 void AcceptVisitor(ROOT::Detail::RFieldVisitor &visitor) const final;
380
381 const RField<RNTupleCardinality<std::uint32_t>> *As32Bit() const;
382 const RField<RNTupleCardinality<std::uint64_t>> *As64Bit() const;
383};
384
385template <typename T>
386class RSimpleField : public RFieldBase {
387 void ReconcileIntegralField(const RNTupleDescriptor &desc);
388 void ReconcileFloatingPointField(const RNTupleDescriptor &desc);
389
390protected:
393
394 void ConstructValue(void *where) const final { new (where) T{0}; }
395
396 void ReconcileOnDiskField(const RNTupleDescriptor &desc) override
397 {
398 if constexpr (std::is_integral_v<T>) {
399 ReconcileIntegralField(desc);
400 } else if constexpr (std::is_floating_point_v<T>) {
401 ReconcileFloatingPointField(desc);
402 } else {
403 RFieldBase::ReconcileOnDiskField(desc);
404 }
405 }
406
407 RSimpleField(std::string_view name, std::string_view type)
408 : RFieldBase(name, type, ROOT::ENTupleStructure::kPlain, true /* isSimple */)
409 {
410 fTraits |= kTraitTrivialType;
411 }
412
413public:
416 ~RSimpleField() override = default;
417
418 T *Map(ROOT::NTupleSize_t globalIndex) { return fPrincipalColumn->Map<T>(globalIndex); }
419 T *Map(RNTupleLocalIndex localIndex) { return fPrincipalColumn->Map<T>(localIndex); }
421 {
422 return fPrincipalColumn->MapV<T>(globalIndex, nItems);
423 }
425 {
426 return fPrincipalColumn->MapV<T>(localIndex, nItems);
427 }
428
429 size_t GetValueSize() const final { return sizeof(T); }
430 size_t GetAlignment() const final { return alignof(T); }
431};
432
433////////////////////////////////////////////////////////////////////////////////
434/// Template specializations for concrete C++ types
435////////////////////////////////////////////////////////////////////////////////
436
437} // namespace ROOT
438
443#include "RField/RFieldSoA.hxx"
445
446namespace ROOT {
447
448template <typename SizeT>
451
452protected:
453 std::unique_ptr<ROOT::RFieldBase> CloneImpl(std::string_view newName) const final
454 {
455 return std::make_unique<RField>(newName);
456 }
457 void ConstructValue(void *where) const final { new (where) CardinalityType(0); }
458
459 /// Get the number of elements of the collection identified by globalIndex
467
468 /// Get the number of elements of the collection identified by clusterIndex
476
477 std::size_t ReadBulkImpl(const RBulkSpec &bulkSpec) final
478 {
482
483 auto typedValues = static_cast<CardinalityType *>(bulkSpec.fValues);
485
486 auto lastOffset = collectionStart.GetIndexInCluster() + collectionSize;
488 std::size_t nEntries = 1;
489 while (nRemainingEntries > 0) {
491 auto offsets =
493 std::size_t nBatch = std::min(nRemainingEntries, nItemsUntilPageEnd);
494 for (std::size_t i = 0; i < nBatch; ++i) {
495 typedValues[nEntries + i] = offsets[i] - lastOffset;
496 lastOffset = offsets[i];
497 }
499 nEntries += nBatch;
500 }
501 return RBulkSpec::kAllSet;
502 }
503
504public:
505 static std::string TypeName() { return "ROOT::RNTupleCardinality<" + RField<SizeT>::TypeName() + ">"; }
506 explicit RField(std::string_view name) : RCardinalityField(name, TypeName()) {}
507 RField(RField &&other) = default;
510
511 size_t GetValueSize() const final { return sizeof(CardinalityType); }
512 size_t GetAlignment() const final { return alignof(CardinalityType); }
513};
514
515/// TObject requires special handling of the fBits and fUniqueID members
516template <>
518 static std::size_t GetOffsetOfMember(const char *name);
519 static std::size_t GetOffsetUniqueID() { return GetOffsetOfMember("fUniqueID"); }
520 static std::size_t GetOffsetBits() { return GetOffsetOfMember("fBits"); }
521
522private:
523 RField(std::string_view fieldName, const RField<TObject> &source); ///< Used by CloneImpl()
524
525protected:
526 std::unique_ptr<RFieldBase> CloneImpl(std::string_view newName) const final;
527
528 void ConstructValue(void *where) const final;
529 std::unique_ptr<RDeleter> GetDeleter() const final { return std::make_unique<RTypedDeleter<TObject>>(); }
530
531 std::size_t AppendImpl(const void *from) final;
532 void ReadTObject(void *to, UInt_t uniqueID, UInt_t bits);
533 void ReadGlobalImpl(ROOT::NTupleSize_t globalIndex, void *to) final;
534 void ReadInClusterImpl(RNTupleLocalIndex localIndex, void *to) final;
535
536public:
537 static std::string TypeName() { return "TObject"; }
538
539 RField(std::string_view fieldName);
540 RField(RField &&other) = default;
543
545 size_t GetValueSize() const final;
546 size_t GetAlignment() const final;
547 std::uint32_t GetTypeVersion() const final;
548 std::uint32_t GetTypeChecksum() const final;
550};
551
552// Have to be implemented after the definition of all RField<T> types
553
554namespace Internal {
555
556/// Helper to check if a given type name is the one expected of Field<T>. Usually, this check can be done by
557/// type renormalization of the demangled type name T. The failure case, however, needs to additionally check for
558/// ROOT-specific special cases.
559template <class T>
560bool IsMatchingFieldType(const std::string &actualTypeName)
561{
563}
564
565} // namespace Internal
566
567template <typename T>
568std::unique_ptr<T, typename RFieldBase::RCreateObjectDeleter<T>::deleter> RFieldBase::CreateObject() const
569{
570 if (!Internal::IsMatchingFieldType<T>(GetTypeName())) {
571 throw RException(
572 R__FAIL("type mismatch for field " + GetFieldName() + ": " + GetTypeName() + " vs. " + RField<T>::TypeName()));
573 }
574 return std::unique_ptr<T>(static_cast<T *>(CreateObjectRawPtr()));
575}
576
577// The void type is specialized in RField.cxx
578
579template <>
584
585template <>
586std::unique_ptr<void, typename RFieldBase::RCreateObjectDeleter<void>::deleter>
587ROOT::RFieldBase::CreateObject<void>() const;
588
589} // namespace ROOT
590
591#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:300
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
TRObject operator()(const T1 &t1) const
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:283
CppT * MapV(const ROOT::NTupleSize_t globalIndex, ROOT::NTupleSize_t &nItems)
Definition RColumn.hxx:241
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:348
RCardinalityField(RCardinalityField &&other)=default
void GetCollectionInfo(ROOT::NTupleSize_t globalIndex, RNTupleLocalIndex *collectionStart, ROOT::NTupleSize_t *size)
Definition RField.hxx:352
RCardinalityField & operator=(RCardinalityField &&other)=default
void GetCollectionInfo(RNTupleLocalIndex localIndex, RNTupleLocalIndex *collectionStart, ROOT::NTupleSize_t *size)
Definition RField.hxx:356
~RCardinalityField() override=default
RCardinalityField(std::string_view fieldName, std::string_view typeName)
Definition RField.hxx:362
void operator()(void *objPtr, bool dtorOnly) final
The field for a class with dictionary.
Definition RField.hxx:136
const TClass * GetClass() const
Return the TClass instance backing this field.
Definition RField.hxx:231
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:177
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 fMaxAlignment
Definition RField.hxx:168
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:167
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:172
size_t GetAlignment() const final
As a rule of thumb, the alignment is equal to the size of the type.
Definition RField.hxx:224
RClassField & operator=(RClassField &&other)=default
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:165
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.
size_t GetValueSize() const final
The number of bytes taken by a value of the appropriate type.
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:207
std::unordered_map< std::string, RStagingItem > fStagingItems
Lookup staging items by member name.
Definition RField.hxx:178
static constexpr const char * kPrefixInherited
Prefix used in the subfield names generated for base classes.
Definition RField.hxx:154
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:291
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
The number of bytes taken by a value of the appropriate type.
Definition RField.hxx:314
size_t GetAlignment() const final
As a rule of thumb, the alignment is equal to the size of the type.
Definition RField.hxx:315
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:299
void ReadInClusterImpl(RNTupleLocalIndex localIndex, void *to) final
Definition RField.hxx:303
void ReadGlobalImpl(ROOT::NTupleSize_t globalIndex, void *to) final
Definition RField.hxx:302
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:301
Base class for all ROOT issued exceptions.
Definition RError.hxx:79
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:568
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:59
std::unordered_set< std::string > fSubfieldNames
Efficient detection of duplicate field names.
Definition RField.hxx:72
void AcceptVisitor(ROOT::Detail::RFieldVisitor &visitor) const final
Definition RField.cxx:74
size_t GetValueSize() const final
The number of bytes taken by a value of the appropriate type.
Definition RField.hxx:84
bool GetAllowFieldSubstitutions() const
Definition RField.hxx:89
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:76
std::unique_ptr< RFieldBase > CloneImpl(std::string_view newName) const final
Called by Clone(), which additionally copies the on-disk ID.
Definition RField.cxx:55
size_t GetAlignment() const final
As a rule of thumb, the alignment is equal to the size of the type.
Definition RField.hxx:85
std::vector< std::unique_ptr< RFieldBase > > ReleaseSubfields()
Moves all subfields into the returned vector.
Definition RField.cxx:65
bool fAllowFieldSubstitutions
If field substitutions are allowed, upon connecting to a page source the field hierarchy will replace...
Definition RField.hxx:70
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:41
void ReadGlobalImpl(ROOT::NTupleSize_t globalIndex, void *to) final
Get the number of elements of the collection identified by globalIndex.
Definition RField.hxx:460
RField & operator=(RField &&other)=default
std::size_t ReadBulkImpl(const RBulkSpec &bulkSpec) final
General implementation of bulk read.
Definition RField.hxx:477
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:457
void ReadInClusterImpl(RNTupleLocalIndex localIndex, void *to) final
Get the number of elements of the collection identified by clusterIndex.
Definition RField.hxx:469
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:453
size_t GetAlignment() const final
As a rule of thumb, the alignment is equal to the size of the type.
Definition RField.hxx:512
RField(RField &&other)=default
RField & operator=(RField &&other)=default
~RField() final=default
static std::string TypeName()
Definition RField.hxx:537
std::unique_ptr< RDeleter > GetDeleter() const final
Definition RField.hxx:529
static std::size_t GetOffsetBits()
Definition RField.hxx:520
static std::size_t GetOffsetUniqueID()
Definition RField.hxx:519
Classes with dictionaries that can be inspected by TClass.
Definition RField.hxx:321
~RField() final=default
RField(RField &&other)=default
RField & operator=(RField &&other)=default
static std::string TypeName()
Definition RField.hxx:323
RField(std::string_view name)
Definition RField.hxx:324
Used in RFieldBase::Check() to record field creation failures.
Definition RField.hxx:97
RInvalidField(std::string_view name, std::string_view type, std::string_view error, ECategory category)
Definition RField.hxx:122
@ 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:115
ECategory fCategory
Definition RField.hxx:112
size_t GetAlignment() const final
As a rule of thumb, the alignment is equal to the size of the type.
Definition RField.hxx:132
std::string fError
Definition RField.hxx:111
const std::string & GetError() const
Definition RField.hxx:128
ECategory GetCategory() const
Definition RField.hxx:129
size_t GetValueSize() const final
The number of bytes taken by a value of the appropriate type.
Definition RField.hxx:131
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:119
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:391
size_t GetAlignment() const final
As a rule of thumb, the alignment is equal to the size of the type.
Definition RField.hxx:430
RSimpleField & operator=(RSimpleField &&other)=default
RSimpleField(std::string_view name, std::string_view type)
Definition RField.hxx:407
T * Map(RNTupleLocalIndex localIndex)
Definition RField.hxx:419
~RSimpleField() override=default
T * Map(ROOT::NTupleSize_t globalIndex)
Definition RField.hxx:418
size_t GetValueSize() const final
The number of bytes taken by a value of the appropriate type.
Definition RField.hxx:429
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:396
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:394
T * MapV(ROOT::NTupleSize_t globalIndex, ROOT::NTupleSize_t &nItems)
Definition RField.hxx:420
void GenerateColumns(const ROOT::RNTupleDescriptor &desc) override
Implementations in derived classes should create the backing columns corresponding to the field type ...
Definition RField.hxx:392
T * MapV(RNTupleLocalIndex localIndex, ROOT::NTupleSize_t &nItems)
Definition RField.hxx:424
void operator()(void *objPtr, bool dtorOnly) final
The field for a class using ROOT standard streaming.
Definition RField.hxx:236
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:248
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:249
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:269
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:267
RStreamerField(std::string_view fieldName, TClass *classp)
size_t GetAlignment() const final
As a rule of thumb, the alignment is equal to the size of the type.
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:262
TClass * GetClass() const
Definition RField.hxx:286
size_t GetValueSize() const final
The number of bytes taken by a value of the appropriate type.
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:36
bool IsMatchingFieldType(const std::string &actualTypeName)
Helper to check if a given type name is the one expected of Field<T>.
Definition RField.hxx:560
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:151
std::unique_ptr< RFieldBase > fField
The field used to read the on-disk data.
Definition RField.hxx:150
Input parameter to RFieldBase::ReadBulk() and RFieldBase::ReadBulkImpl().
Helper types to present an offset column as array of collection sizes.