50#include <unordered_set>
72 " cannot be constructed from a class that's not at least Interpreted"));
78 if (
field.GetTypeName() ==
"TObject") {
83 "use RProxiedCollectionField instead"));
94 R__FAIL(
field.GetTypeName() +
" has streamer mode enforced, not supported as native RNTuple class"));
106 " with a custom streamer; not supported natively in RNTuple"));
126 for (
size_t i = 0; i <
itemFields.size(); ++i) {
170 for (
int i : {0, 1}) {
190 fSubfieldsInfo(
source.fSubfieldsInfo),
191 fMaxAlignment(
source.fMaxAlignment)
193 for (
const auto &
f :
source.GetConstSubfields()) {
230 " virtually inherits from " +
baseClass->GetName()));
253 std::string typeName{
dataMember->GetTrueTypeName()};
257 for (
int dim = 0,
n =
dataMember->GetArrayDim(); dim <
n; ++dim) {
258 typeName +=
"[" + std::to_string(
dataMember->GetMaxIndex(dim)) +
"]";
273 for (
const auto &[
_,
si] : fStagingItems) {
274 if (!(
si.fField->GetTraits() & kTraitTriviallyDestructible)) {
275 auto deleter = GetDeleterOf(*
si.fField);
276 deleter->operator()(fStagingArea.get() +
si.fOffset,
true );
284 fMaxAlignment = std::max(fMaxAlignment,
child->GetAlignment());
285 fSubfieldsInfo.push_back(
info);
316 std::size_t
nskip = 0;
323 <<
"ignoring I/O customization rule with unsupported type: " <<
rule->GetRuleType();
334 <<
"ignoring I/O customization rule due to conflicting source member type: " <<
itrSrc->second <<
" vs. "
346 if (
rule->GetTarget() ==
nullptr) {
367 for (
unsigned i = 0; i < fSubfields.size(); i++) {
368 nbytes += CallAppendOn(*fSubfields[i],
static_cast<const unsigned char *
>(from) + fSubfieldsInfo[i].fOffset);
375 for (
const auto &[
_,
si] : fStagingItems) {
378 for (
unsigned i = 0; i < fSubfields.size(); i++) {
379 CallReadOn(*fSubfields[i],
globalIndex,
static_cast<unsigned char *
>(to) + fSubfieldsInfo[i].fOffset);
385 for (
const auto &[
_,
si] : fStagingItems) {
386 CallReadOn(*
si.fField,
localIndex, fStagingArea.get() +
si.fOffset);
388 for (
unsigned i = 0; i < fSubfields.size(); i++) {
389 CallReadOn(*fSubfields[i],
localIndex,
static_cast<unsigned char *
>(to) + fSubfieldsInfo[i].fOffset);
415 if (
classVersion != GetTypeVersion() || className != GetTypeName()) {
417 if (!fStagingClass) {
444 throw RException(
R__FAIL(std::string(
"cannot find on disk rule source member ") + GetTypeName() +
"." +
451 auto fieldZero = std::make_unique<RFieldZero>();
469 for (
const auto &[
_,
si] : fStagingItems) {
471 if (!(
memberField.GetTraits() & kTraitTriviallyConstructible)) {
472 CallConstructValueOn(
memberField, fStagingArea.get() +
si.fOffset);
480 auto func =
rule->GetReadFunctionPointer();
481 if (func ==
nullptr) {
486 TVirtualObject onfileObj{nullptr};
496 std::vector<const TSchemaRule *>
rules;
506 rules = FindRules(
nullptr);
508 SetStagingClass(GetTypeName(), GetTypeVersion());
517 auto substitute = std::make_unique<RStreamerField>(GetFieldName(), GetTypeName());
539 throw RException(
R__FAIL(
"incompatible type name for field " + GetFieldName() +
": " + GetTypeName() +
544 if (!
rules.empty()) {
547 for (
auto &[
_,
si] : fStagingItems) {
554 if (!
rule->GetTarget())
565 AddReadCallbacksFromIORule(
rule);
570 for (
auto &
field : fSubfields) {
573 CallSetArtificialOn(*
field);
580 throw RException(
R__FAIL(std::string(
"incompatible number of base classes for field ") + GetFieldName() +
": " +
582 " base classes in memory "
593 EnsureMatchingOnDiskField(desc, kDiffTypeVersion | kDiffTypeName).ThrowOnError();
609 std::vector<RValue>
result;
612 result.reserve(fSubfields.size());
613 for (
unsigned i = 0; i < fSubfields.size(); i++) {
615 fSubfields[i]->BindValue(std::shared_ptr<void>(
valuePtr,
charPtr + fSubfieldsInfo[i].fOffset)));
622 return fClass->GetClassSize();
627 return fClass->GetClassVersion();
632 return fClass->GetCheckSum();
641 return fClass->GetTypeInfo();
646 visitor.VisitClassField(*
this);
653 fSoAClass(
source.fSoAClass),
654 fSoAMemberOffsets(
source.fSoAMemberOffsets),
655 fRecordMemberIndexes(
source.fRecordMemberIndexes),
656 fMaxAlignment(
source.fMaxAlignment)
673 static std::once_flag
once;
674 std::call_once(
once, []() {
682 " is not marked with the rntupleSoARecord "
683 "dictionary option; cannot create corresponding RSoAField."));
695 assert(!
f->GetFieldName().empty());
696 if (
f->GetFieldName()[0] ==
':') {
697 throw RException(
R__FAIL(
"SoA fields with inheritance are currently unsupported"));
707 " virtually inherits from " +
baseClass->GetName()));
710 throw RException(
R__FAIL(
"SoA fields with inheritance are currently unsupported"));
721 const std::string typeName{
dataMember->GetTrueTypeName()};
791 const std::size_t
nSoAMembers = fSoAMemberOffsets.size();
795 const void *
rvecPtr =
static_cast<const unsigned char *
>(from) + fSoAMemberOffsets[i];
801 if (
static_cast<std::size_t
>(*
sizePtr) !=
N) {
802 const auto f = fRecordMemberFields[i];
804 " vs. " + std::to_string(
N) +
" (expected)"));
812 const void *
rvecPtr =
static_cast<const unsigned char *
>(from) + fSoAMemberOffsets[i];
816 GetPrincipalColumnOf(*memberField)->AppendV(*
beginPtr,
N);
817 nbytes +=
N * GetPrincipalColumnOf(*memberField)->GetElement()->GetPackedSize();
819 for (std::size_t
j = 0;
j <
N; ++
j) {
827 fPrincipalColumn->Append(&fNWritten);
828 return nbytes + fPrincipalColumn->GetElement()->GetPackedSize();
838 fSoAClass->New(
where);
843 fSoAClass->Destructor(
objPtr,
true );
850 return std::vector<RValue>();
855 return fSoAClass->GetClassSize();
865 return fSoAClass->GetTypeInfo();
884 switch (
enump->GetUnderlyingType()) {
903 std::unique_ptr<RFieldBase>
intField)
912 auto newIntField = fSubfields[0]->Clone(fSubfields[0]->GetFieldName());
919 EnsureMatchingOnDiskField(desc, kDiffTypeName | kDiffTypeVersion).ThrowOnError();
924 std::vector<RValue>
result;
925 result.emplace_back(fSubfields[0]->BindValue(
value.GetPtr<
void>()));
964 std::array<std::unique_ptr<RFieldBase>, 2>
itemClones = {fSubfields[0]->Clone(fSubfields[0]->GetFieldName()),
965 fSubfields[1]->Clone(fSubfields[1]->GetFieldName())};
971 static const std::vector<std::string>
prefixes = {
"std::pair<",
"std::tuple<"};
973 EnsureMatchingOnDiskField(desc, kDiffTypeName).ThrowOnError();
974 EnsureMatchingTypePrefix(desc,
prefixes).ThrowOnError();
996 (
ifuncs.fNext !=
nullptr));
1005 if (!
classp->GetCollectionProxy())
1009 "std::set<",
"std::unordered_set<",
"std::multiset<",
"std::unordered_multiset<",
1010 "std::map<",
"std::unordered_map<",
"std::multimap<",
"std::unordered_multimap<"};
1026 fProxy.reset(
classp->GetCollectionProxy()->Generate());
1029 if (
fProxy->HasPointers())
1030 throw RException(
R__FAIL(
"collection proxies whose value type is a pointer are not supported"));
1041 throw RException(
R__FAIL(
"custom associative collection proxies not supported"));
1043 std::unique_ptr<ROOT::RFieldBase>
itemField;
1049 switch (
fProxy->GetType()) {
1075 clone->fItemSize = fItemSize;
1076 clone->Attach(fSubfields[0]->Clone(fSubfields[0]->GetFieldName()));
1086 (fCollectionType ==
kSTLvector ? fItemSize : 0U)}) {
1087 nbytes += CallAppendOn(*fSubfields[0], ptr);
1092 fPrincipalColumn->Append(&fNWritten);
1093 return nbytes + fPrincipalColumn->GetElement()->GetPackedSize();
1108 (fCollectionType ==
kSTLvector || obj != to ? fItemSize : 0U)}) {
1112 fProxy->Commit(obj);
1137 EnsureMatchingOnDiskField(desc, kDiffTypeName).ThrowOnError();
1149 return std::make_unique<RProxiedCollectionDeleter>(fProxy, GetDeleterOf(*fSubfields[0]),
itemSize);
1151 return std::make_unique<RProxiedCollectionDeleter>(fProxy);
1159 fItemDeleter->operator()(ptr,
true );
1162 fProxy->Destructor(
objPtr,
true );
1168 std::vector<RValue>
result;
1172 (fCollectionType ==
kSTLvector ? fItemSize : 0U)}) {
1173 result.emplace_back(fSubfields[0]->BindValue(std::shared_ptr<void>(
value.GetPtr<
void>(), ptr)));
1180 visitor.VisitProxiedCollectionField(*
this);
1201 return std::make_unique<RMapField>(
newName, fMapType, fSubfields[0]->Clone(fSubfields[0]->GetFieldName()));
1206 static const std::vector<std::string>
prefixesRegular = {
"std::map<",
"std::unordered_map<"};
1208 EnsureMatchingOnDiskField(desc, kDiffTypeName).ThrowOnError();
1211 case EMapType::kMap:
1212 case EMapType::kUnorderedMap: EnsureMatchingTypePrefix(desc,
prefixesRegular).ThrowOnError();
break;
1236 return std::make_unique<RSetField>(
newName, fSetType, fSubfields[0]->Clone(fSubfields[0]->GetFieldName()));
1241 static const std::vector<std::string>
prefixesRegular = {
"std::set<",
"std::unordered_set<",
"std::map<",
1242 "std::unordered_map<"};
1244 EnsureMatchingOnDiskField(desc, kDiffTypeName).ThrowOnError();
1247 case ESetType::kSet:
1248 case ESetType::kUnorderedSet: EnsureMatchingTypePrefix(desc,
prefixesRegular).ThrowOnError();
break;
1265 RCallbackStreamerInfo fCallbackStreamerInfo;
1311 fClass->Streamer(
const_cast<void *
>(from), buffer);
1313 auto nbytes = buffer.Length();
1314 fAuxiliaryColumn->AppendV(buffer.Buffer(), buffer.Length());
1316 fPrincipalColumn->Append(&fIndex);
1317 return nbytes + fPrincipalColumn->GetElement()->GetPackedSize();
1328 fClass->Streamer(to, buffer);
1353 source.RegisterStreamerInfos();
1359 EnsureMatchingOnDiskField(desc, kDiffTypeName | kDiffTypeVersion).ThrowOnError();
1377 .TypeVersion(GetTypeVersion())
1378 .TypeName(GetTypeName())
1385 return std::min(
alignof(std::max_align_t), GetValueSize());
1390 return fClass->GetClassSize();
1395 return fClass->GetClassVersion();
1400 return fClass->GetCheckSum();
1405 visitor.VisitStreamerField(*
this);
1422 Attach(
source.GetConstSubfields()[0]->Clone(
"fUniqueID"));
1445 auto *obj =
static_cast<const TObject *
>(from);
1451 nbytes += CallAppendOn(*fSubfields[0],
reinterpret_cast<const unsigned char *
>(from) + GetOffsetUniqueID());
1453 UInt_t bits = *
reinterpret_cast<const UInt_t *
>(
reinterpret_cast<const unsigned char *
>(from) + GetOffsetBits());
1455 nbytes += CallAppendOn(*fSubfields[1], &bits);
1464 auto *obj =
static_cast<TObject *
>(to);
1469 *
reinterpret_cast<UInt_t *
>(
reinterpret_cast<unsigned char *
>(to) + GetOffsetUniqueID()) =
uniqueID;
1473 *
reinterpret_cast<UInt_t *
>(
reinterpret_cast<unsigned char *
>(to) + GetOffsetBits()) = bits;
1488 CallReadOn(*fSubfields[1],
localIndex, &bits);
1509 std::vector<RValue>
result;
1512 auto charPtr =
static_cast<unsigned char *
>(ptr.get());
1513 result.emplace_back(fSubfields[0]->BindValue(std::shared_ptr<void>(ptr,
charPtr + GetOffsetUniqueID())));
1514 result.emplace_back(fSubfields[1]->BindValue(std::shared_ptr<void>(ptr,
charPtr + GetOffsetBits())));
1530 visitor.VisitTObjectField(*
this);
1554 for (
unsigned i = 0; i <
fSubfields.size(); ++i) {
1555 std::string
memberName(
"_" + std::to_string(i));
1565 std::vector<std::unique_ptr<RFieldBase>>
itemClones;
1567 for (
const auto &
f : fSubfields) {
1575 static const std::vector<std::string>
prefixes = {
"std::pair<",
"std::tuple<"};
1577 EnsureMatchingOnDiskField(desc, kDiffTypeName).ThrowOnError();
1578 EnsureMatchingTypePrefix(desc,
prefixes).ThrowOnError();
1598 std::variant<char> t;
1599 constexpr auto sizeOfT =
sizeof(t);
1601 static_assert(
sizeOfT == 2 ||
sizeOfT == 8,
"unsupported std::variant layout");
1605template <std::
size_t VariantSizeT>
1607 using ValueType_t =
typename std::conditional_t<
VariantSizeT == 1, std::uint8_t,
1608 typename std::conditional_t<VariantSizeT == 4, std::uint32_t, void>>;
1615 fMaxItemSize(
source.fMaxItemSize),
1616 fMaxAlignment(
source.fMaxAlignment),
1617 fTagOffset(
source.fTagOffset),
1618 fVariantOffset(
source.fVariantOffset),
1621 for (
const auto &
f :
source.GetConstSubfields())
1622 Attach(
f->Clone(
f->GetFieldName()));
1642 for (
unsigned int i = 0; i <
nFields; ++i) {
1671 return (tag ==
TagType_t(-1)) ? 0 : tag + 1;
1683 auto tag = GetTag(from, fTagOffset);
1687 nbytes += CallAppendOn(*fSubfields[tag - 1],
reinterpret_cast<const unsigned char *
>(from) + fVariantOffset);
1688 index = fNWritten[tag - 1]++;
1706 void *
varPtr =
reinterpret_cast<unsigned char *
>(to) + fVariantOffset;
1707 CallConstructValueOn(*fSubfields[tag - 1],
varPtr);
1710 SetTag(to, fTagOffset, tag);
1731 static const std::vector<std::string>
prefixes = {
"std::variant<"};
1733 EnsureMatchingOnDiskField(desc, kDiffTypeName).ThrowOnError();
1734 EnsureMatchingTypePrefix(desc,
prefixes).ThrowOnError();
1737 if (fSubfields.size() !=
fieldDesc.GetLinkIds().size()) {
1738 throw RException(
R__FAIL(
"number of variants on-disk do not match for " + GetQualifiedFieldName() +
"\n" +
1746 CallConstructValueOn(*fSubfields[0],
reinterpret_cast<unsigned char *
>(
where) + fVariantOffset);
1747 SetTag(
where, fTagOffset, 1);
1752 auto tag = GetTag(
objPtr, fTagOffset);
1754 fItemDeleters[tag - 1]->operator()(
reinterpret_cast<unsigned char *
>(
objPtr) + fVariantOffset,
true );
1763 for (
const auto &
f : fSubfields) {
1766 return std::make_unique<RVariantDeleter>(fTagOffset, fVariantOffset, std::move(
itemDeleters));
1771 return std::max(fMaxAlignment,
alignof(RVariantTag<
GetVariantTagSize()>::ValueType_t));
1784 std::fill(fNWritten.begin(), fNWritten.end(), 0);
#define R__FAIL(msg)
Short-hand to return an RResult<T> in an error state; the RError is implicitly converted into RResult...
#define R__LOG_WARNING(...)
size_t size(const MatrixT &matrix)
retrieve the size of a square matrix
ROOT::Detail::TRangeCast< T, true > TRangeDynCast
TRangeDynCast is an adapter class that allows the typed iteration through a TCollection.
#define R__ASSERT(e)
Checks condition e and reports a fatal error if it's false.
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 target
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 result
Option_t Option_t TPoint TPoint const char GetTextMagnitude GetFillStyle GetLineColor GetLineWidth GetMarkerStyle GetTextAlign GetTextColor GetTextSize void char Point_t Rectangle_t WindowAttributes_t index
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 mode
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
Abstract base class for classes implementing the visitor design pattern.
void operator()(void *objPtr, bool dtorOnly) final
The SoA field provides I/O for an in-memory SoA layout linked to an on-disk collection of the underly...
void ConstructValue(void *where) const final
Constructs value in a given location of size at least GetValueSize(). Called by the base class' Creat...
void ReadGlobalImpl(ROOT::NTupleSize_t globalIndex, void *to) final
std::vector< std::size_t > fSoAMemberOffsets
The offset of the RVec members in the SoA type.
const std::type_info * GetPolymorphicTypeInfo() const
For polymorphic classes (that declare or inherit at least one virtual method), return the expected dy...
std::vector< RValue > SplitValue(const RValue &value) const final
Creates the list of direct child values given an existing value for this field.
std::vector< RFieldBase * > fRecordMemberFields
Direct access to the member fields of the underlying record.
RSoAField(std::string_view fieldName, const RSoAField &source)
Used by CloneImpl.
std::size_t fMaxAlignment
std::vector< std::size_t > fRecordMemberIndexes
Maps the SoA members to the members of the underlying record.
const RColumnRepresentations & GetColumnRepresentations() const final
Implementations in derived classes should return a static RColumnRepresentations object.
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.
void GenerateColumns() final
Implementations in derived classes should create the backing columns corresponding to the field type ...
size_t GetValueSize() const final
The number of bytes taken by a value of the appropriate type.
Holds the index and the tag of a kSwitch column.
static std::string SerializeStreamerInfos(const StreamerInfoMap_t &infos)
Abstract interface to read data from an ntuple.
void operator()(void *objPtr, bool dtorOnly) final
The field for a class with dictionary.
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.
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.
void ReconcileOnDiskField(const RNTupleDescriptor &desc) final
For non-artificial fields, check compatibility of the in-memory field and the on-disk field.
void Attach(std::unique_ptr< RFieldBase > child, RSubfieldInfo info)
size_t GetAlignment() const final
As a rule of thumb, the alignment is equal to the size of the type.
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
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...
std::uint32_t GetTypeChecksum() const final
Return the current TClass reported checksum of this class. Only valid if kTraitTypeChecksum is set.
static constexpr const char * kPrefixInherited
Prefix used in the subfield names generated for base classes.
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.
std::unique_ptr< RFieldBase > CloneImpl(std::string_view newName) const final
Called by Clone(), which additionally copies the on-disk ID.
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(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.
Base class for all ROOT issued exceptions.
The list of column representations a field can have.
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.
void Attach(std::unique_ptr< RFieldBase > child, std::string_view expectedChildName="")
Add a new subfield to the list of nested fields.
std::vector< std::unique_ptr< RFieldBase > > fSubfields
Collections and classes own subfields.
@ kTraitTriviallyDestructible
The type is cleaned up just by freeing its memory. I.e. the destructor performs a no-op.
@ kTraitTriviallyConstructible
No constructor needs to be called, i.e.
@ kTraitSoACollection
The field represents a collection in SoA layout.
@ kTraitTypeChecksum
The TClass checksum is set and valid.
std::uint32_t fTraits
Properties of the type that allow for optimizations of collections of that type.
static RResult< std::unique_ptr< RFieldBase > > Create(const std::string &fieldName, const std::string &typeName, const ROOT::RCreateFieldOptions &options, const ROOT::RNTupleDescriptor *desc, ROOT::DescriptorId_t fieldId)
Factory method to resurrect a field from the stored on-disk type information.
std::string fTypeAlias
A typedef or using name that was used when creating the field.
const std::string & GetTypeName() const
Metadata stored for every field of an RNTuple.
The container field for an ntuple model, which itself has no physical representation.
std::vector< std::unique_ptr< RFieldBase > > ReleaseSubfields()
Moves all subfields into the returned vector.
Classes with dictionaries that can be inspected by TClass.
RField(std::string_view name)
RMapField(std::string_view fieldName, EMapType mapType, std::unique_ptr< RFieldBase > itemField)
void ReconcileOnDiskField(const RNTupleDescriptor &desc) final
For non-artificial fields, check compatibility of the in-memory field and the on-disk field.
std::unique_ptr< RFieldBase > CloneImpl(std::string_view newName) const final
Called by Clone(), which additionally copies the on-disk ID.
The on-storage metadata of an RNTuple.
RFieldDescriptorIterable GetFieldIterable(const RFieldDescriptor &fieldDesc) const
const RFieldDescriptor & GetFieldDescriptor(ROOT::DescriptorId_t fieldId) const
std::string GetTypeNameForComparison(const RFieldDescriptor &fieldDesc) const
Adjust the type name of the passed RFieldDescriptor for comparison with another renormalized type nam...
ROOT::DescriptorId_t FindFieldId(std::string_view fieldName, ROOT::DescriptorId_t parentId) const
Addresses a column element or field item relative to a particular cluster, instead of a global NTuple...
Template specializations for C++ std::pair.
void ReconcileOnDiskField(const RNTupleDescriptor &desc) final
For non-artificial fields, check compatibility of the in-memory field and the on-disk field.
RPairField(std::string_view fieldName, std::array< std::unique_ptr< RFieldBase >, 2 > itemFields)
std::unique_ptr< RFieldBase > CloneImpl(std::string_view newName) const final
Called by Clone(), which additionally copies the on-disk ID.
Allows for iterating over the elements of a proxied collection.
static RIteratorFuncs GetIteratorFuncs(TVirtualCollectionProxy *proxy, bool readFromDisk)
void operator()(void *objPtr, bool dtorOnly) final
The field for a class representing a collection of elements via TVirtualCollectionProxy.
void GenerateColumns() final
Implementations in derived classes should create the backing columns corresponding to the field type ...
std::unique_ptr< RFieldBase > CloneImpl(std::string_view newName) const override
Called by Clone(), which additionally copies the on-disk ID.
const RColumnRepresentations & GetColumnRepresentations() const final
Implementations in derived classes should return a static RColumnRepresentations object.
void ConstructValue(void *where) const final
Constructs value in a given location of size at least GetValueSize(). Called by the base class' Creat...
RProxiedCollectionField(std::string_view fieldName, TClass *classp)
Constructor used when the value type of the collection is not known in advance, i....
RCollectionIterableOnce::RIteratorFuncs fIFuncsWrite
void AcceptVisitor(ROOT::Detail::RFieldVisitor &visitor) const final
RCollectionIterableOnce::RIteratorFuncs fIFuncsRead
Two sets of functions to operate on iterators, to be used depending on the access type.
std::shared_ptr< TVirtualCollectionProxy > fProxy
The collection proxy is needed by the deleters and thus defined as a shared pointer.
void ReadGlobalImpl(ROOT::NTupleSize_t globalIndex, void *to) final
std::size_t AppendImpl(const void *from) final
Operations on values of complex types, e.g.
std::unique_ptr< RDeleter > GetDeleter() const final
void ReconcileOnDiskField(const RNTupleDescriptor &desc) override
For non-artificial fields, check compatibility of the in-memory field and the on-disk field.
std::vector< RValue > SplitValue(const RValue &value) const final
Creates the list of direct child values given an existing value for this field.
Template specializations for ROOT's RVec.
const_iterator begin() const
const_iterator end() const
The field for an untyped record.
void AttachItemFields(ContainerT &&itemFields)
std::vector< std::size_t > fOffsets
void ReconcileOnDiskField(const RNTupleDescriptor &desc) final
For non-artificial fields, check compatibility of the in-memory field and the on-disk field.
std::unique_ptr< RFieldBase > CloneImpl(std::string_view newName) const final
Called by Clone(), which additionally copies the on-disk ID.
RSetField(std::string_view fieldName, ESetType setType, std::unique_ptr< RFieldBase > itemField)
void operator()(void *objPtr, bool dtorOnly) final
The field for a class using ROOT standard streaming.
ROOT::RExtraTypeInfoDescriptor GetExtraTypeInfo() const final
void ReadGlobalImpl(ROOT::NTupleSize_t globalIndex, void *to) final
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...
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.
std::size_t AppendImpl(const void *from) final
Operations on values of complex types, e.g.
void AcceptVisitor(ROOT::Detail::RFieldVisitor &visitor) const final
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.
size_t GetValueSize() const final
The number of bytes taken by a value of the appropriate type.
Template specializations for C++ std::tuple.
void ReconcileOnDiskField(const RNTupleDescriptor &desc) final
For non-artificial fields, check compatibility of the in-memory field and the on-disk field.
RTupleField(std::string_view fieldName, std::vector< std::unique_ptr< RFieldBase > > itemFields)
std::unique_ptr< RFieldBase > CloneImpl(std::string_view newName) const final
Called by Clone(), which additionally copies the on-disk ID.
void operator()(void *objPtr, bool dtorOnly) final
Template specializations for C++ std::variant.
std::size_t AppendImpl(const void *from) final
Operations on values of complex types, e.g.
size_t GetAlignment() const final
As a rule of thumb, the alignment is equal to the size of the type.
static constexpr std::size_t kMaxVariants
std::vector< ROOT::Internal::RColumnIndex::ValueType > fNWritten
static std::uint8_t GetTag(const void *variantPtr, std::size_t tagOffset)
Extracts the index from an std::variant and transforms it into the 1-based index used for the switch ...
void GenerateColumns() final
Implementations in derived classes should create the backing columns corresponding to the field type ...
size_t fVariantOffset
In the std::variant memory layout, the actual union of types may start at an offset > 0.
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.
std::unique_ptr< RDeleter > GetDeleter() const final
void ReconcileOnDiskField(const RNTupleDescriptor &desc) final
For non-artificial fields, check compatibility of the in-memory field and the on-disk field.
const RColumnRepresentations & GetColumnRepresentations() const final
Implementations in derived classes should return a static RColumnRepresentations object.
void ConstructValue(void *where) const final
Constructs value in a given location of size at least GetValueSize(). Called by the base class' Creat...
size_t fTagOffset
In the std::variant memory layout, at which byte number is the index stored.
RVariantField(std::string_view name, const RVariantField &source)
void ReadGlobalImpl(ROOT::NTupleSize_t globalIndex, void *to) final
static void SetTag(void *variantPtr, std::size_t tagOffset, std::uint8_t tag)
void CommitClusterImpl() final
The concrete implementation of TBuffer for writing/reading to/from a ROOT file or socket.
TClass instances represent classes, structs and namespaces in the ROOT type system.
Bool_t CanSplit() const
Return true if the data member of this TClass can be saved separately.
void BuildRealData(void *pointer=nullptr, Bool_t isTransient=kFALSE)
Build a full list of persistent data members.
TList * GetListOfDataMembers(Bool_t load=kTRUE)
Return list containing the TDataMembers of a class.
TList * GetListOfRealData() const
Int_t Size() const
Return size of object of this class.
TList * GetListOfBases()
Return list containing the TBaseClass(es) of a class.
TVirtualCollectionProxy * GetCollectionProxy() const
Return the proxy describing the collection (if any).
Long_t ClassProperty() const
Return the C++ property of this class, eg.
Long_t Property() const override
Returns the properties of the TClass as a bit field stored as a Long_t value.
static TClass * GetClass(const char *name, Bool_t load=kTRUE, Bool_t silent=kFALSE)
Static method returning pointer to TClass of the specified class name.
All ROOT classes may have RTTI (run time type identification) support added.
The TEnum class implements the enum type.
static TEnum * GetEnum(const std::type_info &ti, ESearchAction sa=kALoadAndInterpLookup)
TObject * First() const override
Return the first object in the list. Returns 0 when list is empty.
const char * GetName() const override
Returns name of object.
Mother of all ROOT objects.
@ kIsOnHeap
object is on heap
@ kNotDeleted
object has not been deleted
@ kIsReferenced
if object is referenced by a TRef or TRefArray
The TRealData class manages the effective list of all data members for a given class.
RAII helper class that ensures that PushProxy() / PopProxy() are called when entering / leaving a C++...
Defines a common interface to inspect/change the contents of an object that represents a collection.
@ kNeedDelete
The collection contains directly or indirectly (via other collection) some pointers that need explici...
Abstract Interface class describing Streamer information for one class.
TRangeCast< T, false > TRangeStaticCast
TRangeStaticCast is an adapter class that allows the typed iteration through a TCollection.
void SetAllowFieldSubstitutions(RFieldZero &fieldZero, bool val)
std::tuple< unsigned char **, std::int32_t *, std::int32_t * > GetRVecDataMembers(void *rvecPtr)
Retrieve the addresses of the data members of a generic RVec from a pointer to the beginning of the R...
ROOT::RLogChannel & NTupleLog()
Log channel for RNTuple diagnostics.
void CallConnectPageSourceOnField(RFieldBase &, ROOT::Internal::RPageSource &)
std::string GetRNTupleSoARecord(const TClass *cl)
Checks if the "rntuple.SoARecord" class attribute is set in the dictionary.
bool NeedsMetaNameAsAlias(const std::string &metaNormalizedName, std::string &renormalizedAlias, bool isArgInTemplatedUserClass=false)
Checks if the meta normalized name is different from the RNTuple normalized name in a way that would ...
std::string GetTypeTraceReport(const RFieldBase &field, const RNTupleDescriptor &desc)
Prints the hierarchy of types with their field names and field IDs for the given in-memory field and ...
ERNTupleSerializationMode GetRNTupleSerializationMode(const TClass *cl)
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::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.
constexpr DescriptorId_t kInvalidDescriptorId
ENTupleStructure
The fields in the RNTuple data model tree can carry different structural information about the type s...
void GetNormalizedName(std::string &norm_name, std::string_view name)
Return the normalized name.