Logo ROOT  

Reference Guide
 
Loading...
Searching...
No Matches
List of all members | Classes | Public Member Functions | Static Public Attributes | Private Member Functions | Private Attributes | Friends | List of all members
ROOT::RNTupleDescriptor Class Referencefinal
RNTuple-related classes

The on-storage metadata of an RNTuple.

Represents the on-disk (on storage) information about an RNTuple. The metadata consists of a header, a footer, and potentially multiple page lists. The header carries the RNTuple schema, i.e. the fields and the associated columns and their relationships. The footer carries information about one or several cluster groups and links to their page lists. For every cluster group, a page list envelope stores cluster summaries and page locations. For every cluster, it stores for every column the range of element indexes as well as a list of pages and page locations.

The descriptor provides machine-independent (de-)serialization of headers and footers, and it provides lookup routines for RNTuple objects (pages, clusters, ...). It is supposed to be usable by all RPageStorage implementations.

The serialization does not use standard ROOT streamers in order to not let it depend on libCore. The serialization uses the concept of envelopes and frames: header, footer, and page list envelopes have a preamble with a type ID and length. Substructures are serialized in frames and have a size and number of items (for list frames). This allows for forward and backward compatibility when the metadata evolves.

Definition at line 701 of file RNTupleDescriptor.hxx.

Classes

class  RClusterDescriptorIterable
 Used to loop over all the clusters of an RNTuple (in unspecified order) More...
 
class  RClusterGroupDescriptorIterable
 Used to loop over all the cluster groups of an RNTuple (in unspecified order) More...
 
class  RColumnDescriptorIterable
 Used to loop over a field's associated columns. More...
 
struct  RCreateModelOptions
 Modifiers passed to CreateModel() More...
 
class  RExtraTypeInfoDescriptorIterable
 Used to loop over all the extra type info record of an RNTuple (in unspecified order) More...
 
class  RFieldDescriptorIterable
 Used to loop over a field's child fields. More...
 
class  RHeaderExtension
 Summarizes information about fields and the corresponding columns that were added after the header has been serialized. More...
 

Public Member Functions

 RNTupleDescriptor ()=default
 
 RNTupleDescriptor (const RNTupleDescriptor &other)=delete
 
 RNTupleDescriptor (RNTupleDescriptor &&other)=default
 
RResult< void > AddClusterGroupDetails (ROOT::DescriptorId_t clusterGroupId, std::vector< RClusterDescriptor > &clusterDescs)
 Methods to load and drop cluster group details (cluster IDs and page locations)
 
RNTupleDescriptor Clone () const
 
std::unique_ptr< ROOT::RNTupleModel > CreateModel (const RCreateModelOptions &options=RCreateModelOptions()) const
 Re-create the C++ model from the stored metadata.
 
RResult< void > DropClusterGroupDetails (ROOT::DescriptorId_t clusterGroupId)
 
ROOT::DescriptorId_t FindClusterId (ROOT::DescriptorId_t physicalColumnId, ROOT::NTupleSize_t index) const
 
ROOT::DescriptorId_t FindFieldId (std::string_view fieldName) const
 Searches for a top-level field.
 
ROOT::DescriptorId_t FindFieldId (std::string_view fieldName, ROOT::DescriptorId_t parentId) const
 
ROOT::DescriptorId_t FindLogicalColumnId (ROOT::DescriptorId_t fieldId, std::uint32_t columnIndex, std::uint16_t representationIndex) const
 
ROOT::DescriptorId_t FindNextClusterId (ROOT::DescriptorId_t clusterId) const
 
ROOT::DescriptorId_t FindPhysicalColumnId (ROOT::DescriptorId_t fieldId, std::uint32_t columnIndex, std::uint16_t representationIndex) const
 
ROOT::DescriptorId_t FindPrevClusterId (ROOT::DescriptorId_t clusterId) const
 
ROOT::Experimental::RNTupleAttrSetDescriptorIterable GetAttrSetIterable () const
 
const RClusterDescriptor & GetClusterDescriptor (ROOT::DescriptorId_t clusterId) const
 
const RClusterGroupDescriptor & GetClusterGroupDescriptor (ROOT::DescriptorId_t clusterGroupId) const
 
RClusterGroupDescriptorIterable GetClusterGroupIterable () const
 
RClusterDescriptorIterable GetClusterIterable () const
 
const RColumnDescriptor & GetColumnDescriptor (ROOT::DescriptorId_t columnId) const
 
RColumnDescriptorIterable GetColumnIterable () const
 
RColumnDescriptorIterable GetColumnIterable (const RFieldDescriptor &fieldDesc) const
 
RColumnDescriptorIterable GetColumnIterable (ROOT::DescriptorId_t fieldId) const
 
const std::string & GetDescription () const
 
RExtraTypeInfoDescriptorIterable GetExtraTypeInfoIterable () const
 
std::vector< std::uint64_t > GetFeatureFlags () const
 
const RFieldDescriptor & GetFieldDescriptor (ROOT::DescriptorId_t fieldId) const
 
RFieldDescriptorIterable GetFieldIterable (const RFieldDescriptor &fieldDesc) const
 
RFieldDescriptorIterable GetFieldIterable (const RFieldDescriptor &fieldDesc, const std::function< bool(ROOT::DescriptorId_t, ROOT::DescriptorId_t)> &comparator) const
 
RFieldDescriptorIterable GetFieldIterable (ROOT::DescriptorId_t fieldId) const
 
RFieldDescriptorIterable GetFieldIterable (ROOT::DescriptorId_t fieldId, const std::function< bool(ROOT::DescriptorId_t, ROOT::DescriptorId_t)> &comparator) const
 
const RFieldDescriptor & GetFieldZero () const
 
ROOT::DescriptorId_t GetFieldZeroId () const
 Returns the logical parent of all top-level RNTuple data fields.
 
std::uint64_t GetGeneration () const
 
const RHeaderExtension * GetHeaderExtension () const
 Return header extension information; if the descriptor does not have a header extension, return nullptr
 
std::size_t GetNActiveClusters () const
 
const std::string & GetName () const
 
std::size_t GetNAttributeSets () const
 
std::size_t GetNClusterGroups () const
 
std::size_t GetNClusters () const
 
ROOT::NTupleSize_t GetNElements (ROOT::DescriptorId_t physicalColumnId) const
 
ROOT::NTupleSize_t GetNEntries () const
 We know the number of entries from adding the cluster summaries.
 
std::size_t GetNExtraTypeInfos () const
 
std::size_t GetNFields () const
 
std::size_t GetNLogicalColumns () const
 
std::size_t GetNPhysicalColumns () const
 
std::uint64_t GetOnDiskFooterSize () const
 
std::uint64_t GetOnDiskHeaderSize () const
 
std::uint64_t GetOnDiskHeaderXxHash3 () const
 
std::string GetQualifiedFieldName (ROOT::DescriptorId_t fieldId) const
 Walks up the parents of the field ID and returns a field name of the form a.b.c.d In case of invalid field ID, an empty string is returned.
 
RFieldDescriptorIterable GetTopLevelFields () const
 
RFieldDescriptorIterable GetTopLevelFields (const std::function< bool(ROOT::DescriptorId_t, ROOT::DescriptorId_t)> &comparator) const
 
std::string GetTypeNameForComparison (const RFieldDescriptor &fieldDesc) const
 Adjust the type name of the passed RFieldDescriptor for comparison with another renormalized type name.
 
bool HasFeature (unsigned int flag) const
 
void IncGeneration ()
 
RNTupleDescriptor & operator= (const RNTupleDescriptor &other)=delete
 
RNTupleDescriptor & operator= (RNTupleDescriptor &&other)=default
 
bool operator== (const RNTupleDescriptor &other) const
 
void PrintInfo (std::ostream &output) const
 

Static Public Attributes

static constexpr unsigned int kFeatureFlagTest = 137
 

Private Member Functions

RNTupleDescriptor CloneSchema () const
 Creates a descriptor containing only the schema information about this RNTuple, i.e.
 
ROOT::DescriptorId_t FindClusterId (ROOT::NTupleSize_t entryIdx) const
 

Private Attributes

std::vector< Experimental::RNTupleAttrSetDescriptor > fAttributeSets
 List of AttributeSets linked to this RNTuple.
 
std::unordered_map< ROOT::DescriptorId_t, RClusterDescriptor > fClusterDescriptors
 Potentially a subset of all the available clusters.
 
std::unordered_map< ROOT::DescriptorId_t, RClusterGroupDescriptor > fClusterGroupDescriptors
 
std::unordered_map< ROOT::DescriptorId_t, RColumnDescriptor > fColumnDescriptors
 
std::string fDescription
 Free text from the user.
 
std::vector< RExtraTypeInfoDescriptor > fExtraTypeInfoDescriptors
 
std::set< unsigned int > fFeatureFlags
 
std::unordered_map< ROOT::DescriptorId_t, RFieldDescriptor > fFieldDescriptors
 
ROOT::DescriptorId_t fFieldZeroId = ROOT::kInvalidDescriptorId
 Set by the descriptor builder.
 
std::uint64_t fGeneration = 0
 The generation of the descriptor.
 
std::unique_ptr< RHeaderExtension > fHeaderExtension
 
std::string fName
 The RNTuple name needs to be unique in a given storage location (file)
 
std::uint64_t fNClusters = 0
 Updated by the descriptor builder when the cluster groups are added.
 
std::uint64_t fNEntries = 0
 Updated by the descriptor builder when the cluster groups are added.
 
std::uint64_t fNPhysicalColumns = 0
 Updated by the descriptor builder when columns are added.
 
std::uint64_t fOnDiskFooterSize = 0
 Like fOnDiskHeaderSize, contains both cluster summaries and page locations.
 
std::uint64_t fOnDiskHeaderSize = 0
 Set by the descriptor builder when deserialized.
 
std::uint64_t fOnDiskHeaderXxHash3 = 0
 Set by the descriptor builder when deserialized.
 
std::vector< ROOT::DescriptorId_t > fSortedClusterGroupIds
 References cluster groups sorted by entry range and thus allows for binary search.
 
std::uint16_t fVersionEpoch = 0
 Set by the descriptor builder when deserialized.
 
std::uint16_t fVersionMajor = 0
 Set by the descriptor builder when deserialized.
 
std::uint16_t fVersionMinor = 0
 Set by the descriptor builder when deserialized.
 
std::uint16_t fVersionPatch = 0
 Set by the descriptor builder when deserialized.
 

Friends

class Experimental::RNTupleAttrSetDescriptorIterable
 
DescriptorId_t Internal::CallFindClusterIdOn (const RNTupleDescriptor &desc, NTupleSize_t entryIdx)
 
RNTupleDescriptor Internal::CloneDescriptorSchema (const RNTupleDescriptor &desc)
 
class Internal::RNTupleDescriptorBuilder
 

#include <ROOT/RNTupleDescriptor.hxx>

Constructor & Destructor Documentation

◆ RNTupleDescriptor() [1/3]

ROOT::RNTupleDescriptor::RNTupleDescriptor ( )
default

◆ RNTupleDescriptor() [2/3]

ROOT::RNTupleDescriptor::RNTupleDescriptor ( const RNTupleDescriptor & other)
delete

◆ RNTupleDescriptor() [3/3]

ROOT::RNTupleDescriptor::RNTupleDescriptor ( RNTupleDescriptor && other)
default

Member Function Documentation

◆ AddClusterGroupDetails()

ROOT::RResult< void > ROOT::RNTupleDescriptor::AddClusterGroupDetails ( ROOT::DescriptorId_t clusterGroupId,
std::vector< RClusterDescriptor > & clusterDescs )

Methods to load and drop cluster group details (cluster IDs and page locations)

Definition at line 658 of file RNTupleDescriptor.cxx.

◆ Clone()

ROOT::RNTupleDescriptor ROOT::RNTupleDescriptor::Clone ( ) const

Definition at line 794 of file RNTupleDescriptor.cxx.

◆ CloneSchema()

ROOT::RNTupleDescriptor ROOT::RNTupleDescriptor::CloneSchema ( ) const
private

Creates a descriptor containing only the schema information about this RNTuple, i.e.

all the information needed to create a new RNTuple with the same schema as this one but not necessarily the same clustering. This is used when merging two RNTuples.

Definition at line 769 of file RNTupleDescriptor.cxx.

◆ CreateModel()

std::unique_ptr< ROOT::RNTupleModel > ROOT::RNTupleDescriptor::CreateModel ( const RCreateModelOptions & options = RCreateModelOptions()) const

Re-create the C++ model from the stored metadata.

Definition at line 700 of file RNTupleDescriptor.cxx.

◆ DropClusterGroupDetails()

ROOT::RResult< void > ROOT::RNTupleDescriptor::DropClusterGroupDetails ( ROOT::DescriptorId_t clusterGroupId)

Definition at line 686 of file RNTupleDescriptor.cxx.

◆ FindClusterId() [1/2]

ROOT::DescriptorId_t ROOT::RNTupleDescriptor::FindClusterId ( ROOT::DescriptorId_t physicalColumnId,
ROOT::NTupleSize_t index ) const

Definition at line 465 of file RNTupleDescriptor.cxx.

◆ FindClusterId() [2/2]

ROOT::DescriptorId_t ROOT::RNTupleDescriptor::FindClusterId ( ROOT::NTupleSize_t entryIdx) const
private

Definition at line 527 of file RNTupleDescriptor.cxx.

◆ FindFieldId() [1/2]

ROOT::DescriptorId_t ROOT::RNTupleDescriptor::FindFieldId ( std::string_view fieldName) const

Searches for a top-level field.

Definition at line 434 of file RNTupleDescriptor.cxx.

◆ FindFieldId() [2/2]

ROOT::DescriptorId_t ROOT::RNTupleDescriptor::FindFieldId ( std::string_view fieldName,
ROOT::DescriptorId_t parentId ) const

Definition at line 390 of file RNTupleDescriptor.cxx.

◆ FindLogicalColumnId()

ROOT::DescriptorId_t ROOT::RNTupleDescriptor::FindLogicalColumnId ( ROOT::DescriptorId_t fieldId,
std::uint32_t columnIndex,
std::uint16_t representationIndex ) const

Definition at line 439 of file RNTupleDescriptor.cxx.

◆ FindNextClusterId()

ROOT::DescriptorId_t ROOT::RNTupleDescriptor::FindNextClusterId ( ROOT::DescriptorId_t clusterId) const

Definition at line 579 of file RNTupleDescriptor.cxx.

◆ FindPhysicalColumnId()

ROOT::DescriptorId_t ROOT::RNTupleDescriptor::FindPhysicalColumnId ( ROOT::DescriptorId_t fieldId,
std::uint32_t columnIndex,
std::uint16_t representationIndex ) const

Definition at line 454 of file RNTupleDescriptor.cxx.

◆ FindPrevClusterId()

ROOT::DescriptorId_t ROOT::RNTupleDescriptor::FindPrevClusterId ( ROOT::DescriptorId_t clusterId) const

Definition at line 590 of file RNTupleDescriptor.cxx.

◆ GetAttrSetIterable()

ROOT::Experimental::RNTupleAttrSetDescriptorIterable ROOT::RNTupleDescriptor::GetAttrSetIterable ( ) const

Definition at line 1494 of file RNTupleDescriptor.cxx.

◆ GetClusterDescriptor()

const RClusterDescriptor & ROOT::RNTupleDescriptor::GetClusterDescriptor ( ROOT::DescriptorId_t clusterId) const
inline

Definition at line 837 of file RNTupleDescriptor.hxx.

◆ GetClusterGroupDescriptor()

const RClusterGroupDescriptor & ROOT::RNTupleDescriptor::GetClusterGroupDescriptor ( ROOT::DescriptorId_t clusterGroupId) const
inline

Definition at line 833 of file RNTupleDescriptor.hxx.

◆ GetClusterGroupIterable()

ROOT::RNTupleDescriptor::RClusterGroupDescriptorIterable ROOT::RNTupleDescriptor::GetClusterGroupIterable ( ) const

Definition at line 1479 of file RNTupleDescriptor.cxx.

◆ GetClusterIterable()

ROOT::RNTupleDescriptor::RClusterDescriptorIterable ROOT::RNTupleDescriptor::GetClusterIterable ( ) const

Definition at line 1484 of file RNTupleDescriptor.cxx.

◆ GetColumnDescriptor()

const RColumnDescriptor & ROOT::RNTupleDescriptor::GetColumnDescriptor ( ROOT::DescriptorId_t columnId) const
inline

Definition at line 829 of file RNTupleDescriptor.hxx.

◆ GetColumnIterable() [1/3]

ROOT::RNTupleDescriptor::RColumnDescriptorIterable ROOT::RNTupleDescriptor::GetColumnIterable ( ) const

Definition at line 1462 of file RNTupleDescriptor.cxx.

◆ GetColumnIterable() [2/3]

ROOT::RNTupleDescriptor::RColumnDescriptorIterable ROOT::RNTupleDescriptor::GetColumnIterable ( const RFieldDescriptor & fieldDesc) const

Definition at line 1468 of file RNTupleDescriptor.cxx.

◆ GetColumnIterable() [3/3]

ROOT::RNTupleDescriptor::RColumnDescriptorIterable ROOT::RNTupleDescriptor::GetColumnIterable ( ROOT::DescriptorId_t fieldId) const

Definition at line 1474 of file RNTupleDescriptor.cxx.

◆ GetDescription()

const std::string & ROOT::RNTupleDescriptor::GetDescription ( ) const
inline

Definition at line 868 of file RNTupleDescriptor.hxx.

◆ GetExtraTypeInfoIterable()

ROOT::RNTupleDescriptor::RExtraTypeInfoDescriptorIterable ROOT::RNTupleDescriptor::GetExtraTypeInfoIterable ( ) const

Definition at line 1489 of file RNTupleDescriptor.cxx.

◆ GetFeatureFlags()

std::vector< std::uint64_t > ROOT::RNTupleDescriptor::GetFeatureFlags ( ) const

Definition at line 638 of file RNTupleDescriptor.cxx.

◆ GetFieldDescriptor()

const RFieldDescriptor & ROOT::RNTupleDescriptor::GetFieldDescriptor ( ROOT::DescriptorId_t fieldId) const
inline

Definition at line 825 of file RNTupleDescriptor.hxx.

◆ GetFieldIterable() [1/4]

ROOT::RNTupleDescriptor::RFieldDescriptorIterable ROOT::RNTupleDescriptor::GetFieldIterable ( const RFieldDescriptor & fieldDesc) const

Definition at line 1426 of file RNTupleDescriptor.cxx.

◆ GetFieldIterable() [2/4]

ROOT::RNTupleDescriptor::RFieldDescriptorIterable ROOT::RNTupleDescriptor::GetFieldIterable ( const RFieldDescriptor & fieldDesc,
const std::function< bool(ROOT::DescriptorId_t, ROOT::DescriptorId_t)> & comparator ) const

Definition at line 1431 of file RNTupleDescriptor.cxx.

◆ GetFieldIterable() [3/4]

ROOT::RNTupleDescriptor::RFieldDescriptorIterable ROOT::RNTupleDescriptor::GetFieldIterable ( ROOT::DescriptorId_t fieldId) const

Definition at line 1439 of file RNTupleDescriptor.cxx.

◆ GetFieldIterable() [4/4]

ROOT::RNTupleDescriptor::RFieldDescriptorIterable ROOT::RNTupleDescriptor::GetFieldIterable ( ROOT::DescriptorId_t fieldId,
const std::function< bool(ROOT::DescriptorId_t, ROOT::DescriptorId_t)> & comparator ) const

Definition at line 1444 of file RNTupleDescriptor.cxx.

◆ GetFieldZero()

const RFieldDescriptor & ROOT::RNTupleDescriptor::GetFieldZero ( ) const
inline

Definition at line 885 of file RNTupleDescriptor.hxx.

◆ GetFieldZeroId()

ROOT::DescriptorId_t ROOT::RNTupleDescriptor::GetFieldZeroId ( ) const
inline

Returns the logical parent of all top-level RNTuple data fields.

Definition at line 884 of file RNTupleDescriptor.hxx.

◆ GetGeneration()

std::uint64_t ROOT::RNTupleDescriptor::GetGeneration ( ) const
inline

Definition at line 915 of file RNTupleDescriptor.hxx.

◆ GetHeaderExtension()

const RHeaderExtension * ROOT::RNTupleDescriptor::GetHeaderExtension ( ) const
inline

Return header extension information; if the descriptor does not have a header extension, return nullptr

Definition at line 908 of file RNTupleDescriptor.hxx.

◆ GetNActiveClusters()

std::size_t ROOT::RNTupleDescriptor::GetNActiveClusters ( ) const
inline

Definition at line 875 of file RNTupleDescriptor.hxx.

◆ GetName()

const std::string & ROOT::RNTupleDescriptor::GetName ( ) const
inline

Definition at line 867 of file RNTupleDescriptor.hxx.

◆ GetNAttributeSets()

std::size_t ROOT::RNTupleDescriptor::GetNAttributeSets ( ) const
inline

Definition at line 877 of file RNTupleDescriptor.hxx.

◆ GetNClusterGroups()

std::size_t ROOT::RNTupleDescriptor::GetNClusterGroups ( ) const
inline

Definition at line 873 of file RNTupleDescriptor.hxx.

◆ GetNClusters()

std::size_t ROOT::RNTupleDescriptor::GetNClusters ( ) const
inline

Definition at line 874 of file RNTupleDescriptor.hxx.

◆ GetNElements()

ROOT::NTupleSize_t ROOT::RNTupleDescriptor::GetNElements ( ROOT::DescriptorId_t physicalColumnId) const

Definition at line 359 of file RNTupleDescriptor.cxx.

◆ GetNEntries()

ROOT::NTupleSize_t ROOT::RNTupleDescriptor::GetNEntries ( ) const
inline

We know the number of entries from adding the cluster summaries.

Definition at line 880 of file RNTupleDescriptor.hxx.

◆ GetNExtraTypeInfos()

std::size_t ROOT::RNTupleDescriptor::GetNExtraTypeInfos ( ) const
inline

Definition at line 876 of file RNTupleDescriptor.hxx.

◆ GetNFields()

std::size_t ROOT::RNTupleDescriptor::GetNFields ( ) const
inline

Definition at line 870 of file RNTupleDescriptor.hxx.

◆ GetNLogicalColumns()

std::size_t ROOT::RNTupleDescriptor::GetNLogicalColumns ( ) const
inline

Definition at line 871 of file RNTupleDescriptor.hxx.

◆ GetNPhysicalColumns()

std::size_t ROOT::RNTupleDescriptor::GetNPhysicalColumns ( ) const
inline

Definition at line 872 of file RNTupleDescriptor.hxx.

◆ GetOnDiskFooterSize()

std::uint64_t ROOT::RNTupleDescriptor::GetOnDiskFooterSize ( ) const
inline

Definition at line 823 of file RNTupleDescriptor.hxx.

◆ GetOnDiskHeaderSize()

std::uint64_t ROOT::RNTupleDescriptor::GetOnDiskHeaderSize ( ) const
inline

Definition at line 822 of file RNTupleDescriptor.hxx.

◆ GetOnDiskHeaderXxHash3()

std::uint64_t ROOT::RNTupleDescriptor::GetOnDiskHeaderXxHash3 ( ) const
inline

Definition at line 821 of file RNTupleDescriptor.hxx.

◆ GetQualifiedFieldName()

std::string ROOT::RNTupleDescriptor::GetQualifiedFieldName ( ROOT::DescriptorId_t fieldId) const

Walks up the parents of the field ID and returns a field name of the form a.b.c.d In case of invalid field ID, an empty string is returned.

Definition at line 409 of file RNTupleDescriptor.cxx.

◆ GetTopLevelFields() [1/2]

ROOT::RNTupleDescriptor::RFieldDescriptorIterable ROOT::RNTupleDescriptor::GetTopLevelFields ( ) const

Definition at line 1451 of file RNTupleDescriptor.cxx.

◆ GetTopLevelFields() [2/2]

ROOT::RNTupleDescriptor::RFieldDescriptorIterable ROOT::RNTupleDescriptor::GetTopLevelFields ( const std::function< bool(ROOT::DescriptorId_t, ROOT::DescriptorId_t)> & comparator) const

Definition at line 1456 of file RNTupleDescriptor.cxx.

◆ GetTypeNameForComparison()

std::string ROOT::RNTupleDescriptor::GetTypeNameForComparison ( const RFieldDescriptor & fieldDesc) const

Adjust the type name of the passed RFieldDescriptor for comparison with another renormalized type name.

Definition at line 421 of file RNTupleDescriptor.cxx.

◆ HasFeature()

bool ROOT::RNTupleDescriptor::HasFeature ( unsigned int flag) const
inline

Definition at line 904 of file RNTupleDescriptor.hxx.

◆ IncGeneration()

void ROOT::RNTupleDescriptor::IncGeneration ( )
inline

Definition at line 916 of file RNTupleDescriptor.hxx.

◆ operator=() [1/2]

RNTupleDescriptor & ROOT::RNTupleDescriptor::operator= ( const RNTupleDescriptor & other)
delete

◆ operator=() [2/2]

RNTupleDescriptor & ROOT::RNTupleDescriptor::operator= ( RNTupleDescriptor && other)
default

◆ operator==()

bool ROOT::RNTupleDescriptor::operator== ( const RNTupleDescriptor & other) const

Definition at line 344 of file RNTupleDescriptor.cxx.

◆ PrintInfo()

void ROOT::RNTupleDescriptor::PrintInfo ( std::ostream & output) const

Definition at line 79 of file RNTupleDescriptorFmt.cxx.

Friends And Related Symbol Documentation

◆ Experimental::RNTupleAttrSetDescriptorIterable

friend class Experimental::RNTupleAttrSetDescriptorIterable
friend

Definition at line 776 of file RNTupleDescriptor.hxx.

◆ Internal::CallFindClusterIdOn

DescriptorId_t Internal::CallFindClusterIdOn ( const RNTupleDescriptor & desc,
NTupleSize_t entryIdx )
friend

◆ Internal::CloneDescriptorSchema

RNTupleDescriptor Internal::CloneDescriptorSchema ( const RNTupleDescriptor & desc)
friend

◆ Internal::RNTupleDescriptorBuilder

friend class Internal::RNTupleDescriptorBuilder
friend

Definition at line 702 of file RNTupleDescriptor.hxx.

Member Data Documentation

◆ fAttributeSets

std::vector<Experimental::RNTupleAttrSetDescriptor> ROOT::RNTupleDescriptor::fAttributeSets
private

List of AttributeSets linked to this RNTuple.

Definition at line 758 of file RNTupleDescriptor.hxx.

◆ fClusterDescriptors

std::unordered_map<ROOT::DescriptorId_t, RClusterDescriptor> ROOT::RNTupleDescriptor::fClusterDescriptors
private

Potentially a subset of all the available clusters.

Definition at line 756 of file RNTupleDescriptor.hxx.

◆ fClusterGroupDescriptors

std::unordered_map<ROOT::DescriptorId_t, RClusterGroupDescriptor> ROOT::RNTupleDescriptor::fClusterGroupDescriptors
private

Definition at line 750 of file RNTupleDescriptor.hxx.

◆ fColumnDescriptors

std::unordered_map<ROOT::DescriptorId_t, RColumnDescriptor> ROOT::RNTupleDescriptor::fColumnDescriptors
private

Definition at line 721 of file RNTupleDescriptor.hxx.

◆ fDescription

std::string ROOT::RNTupleDescriptor::fDescription
private

Free text from the user.

Definition at line 713 of file RNTupleDescriptor.hxx.

◆ fExtraTypeInfoDescriptors

std::vector<RExtraTypeInfoDescriptor> ROOT::RNTupleDescriptor::fExtraTypeInfoDescriptors
private

Definition at line 723 of file RNTupleDescriptor.hxx.

◆ fFeatureFlags

std::set<unsigned int> ROOT::RNTupleDescriptor::fFeatureFlags
private

Definition at line 719 of file RNTupleDescriptor.hxx.

◆ fFieldDescriptors

std::unordered_map<ROOT::DescriptorId_t, RFieldDescriptor> ROOT::RNTupleDescriptor::fFieldDescriptors
private

Definition at line 720 of file RNTupleDescriptor.hxx.

◆ fFieldZeroId

ROOT::DescriptorId_t ROOT::RNTupleDescriptor::fFieldZeroId = ROOT::kInvalidDescriptorId
private

Set by the descriptor builder.

Definition at line 715 of file RNTupleDescriptor.hxx.

◆ fGeneration

std::uint64_t ROOT::RNTupleDescriptor::fGeneration = 0
private

The generation of the descriptor.

Once constructed by an RNTupleDescriptorBuilder, the descriptor is mostly immutable except for the set of active page locations. During the lifetime of the descriptor, page location information for clusters can be added or removed. When this happens, the generation should be increased, so that users of the descriptor know that the information changed. The generation is increased, e.g., by the page source's exclusive lock guard around the descriptor. It is used, e.g., by the descriptor cache in RNTupleReader.

Definition at line 748 of file RNTupleDescriptor.hxx.

◆ fHeaderExtension

std::unique_ptr<RHeaderExtension> ROOT::RNTupleDescriptor::fHeaderExtension
private

Definition at line 724 of file RNTupleDescriptor.hxx.

◆ fName

std::string ROOT::RNTupleDescriptor::fName
private

The RNTuple name needs to be unique in a given storage location (file)

Definition at line 711 of file RNTupleDescriptor.hxx.

◆ fNClusters

std::uint64_t ROOT::RNTupleDescriptor::fNClusters = 0
private

Updated by the descriptor builder when the cluster groups are added.

Definition at line 739 of file RNTupleDescriptor.hxx.

◆ fNEntries

std::uint64_t ROOT::RNTupleDescriptor::fNEntries = 0
private

Updated by the descriptor builder when the cluster groups are added.

Definition at line 738 of file RNTupleDescriptor.hxx.

◆ fNPhysicalColumns

std::uint64_t ROOT::RNTupleDescriptor::fNPhysicalColumns = 0
private

Updated by the descriptor builder when columns are added.

Definition at line 717 of file RNTupleDescriptor.hxx.

◆ fOnDiskFooterSize

std::uint64_t ROOT::RNTupleDescriptor::fOnDiskFooterSize = 0
private

Like fOnDiskHeaderSize, contains both cluster summaries and page locations.

Definition at line 736 of file RNTupleDescriptor.hxx.

◆ fOnDiskHeaderSize

std::uint64_t ROOT::RNTupleDescriptor::fOnDiskHeaderSize = 0
private

Set by the descriptor builder when deserialized.

Definition at line 734 of file RNTupleDescriptor.hxx.

◆ fOnDiskHeaderXxHash3

std::uint64_t ROOT::RNTupleDescriptor::fOnDiskHeaderXxHash3 = 0
private

Set by the descriptor builder when deserialized.

Definition at line 735 of file RNTupleDescriptor.hxx.

◆ fSortedClusterGroupIds

std::vector<ROOT::DescriptorId_t> ROOT::RNTupleDescriptor::fSortedClusterGroupIds
private

References cluster groups sorted by entry range and thus allows for binary search.

Note that this list is empty during the descriptor building process and will only be created when the final descriptor is extracted from the builder.

Definition at line 754 of file RNTupleDescriptor.hxx.

◆ fVersionEpoch

std::uint16_t ROOT::RNTupleDescriptor::fVersionEpoch = 0
private

Set by the descriptor builder when deserialized.

Definition at line 729 of file RNTupleDescriptor.hxx.

◆ fVersionMajor

std::uint16_t ROOT::RNTupleDescriptor::fVersionMajor = 0
private

Set by the descriptor builder when deserialized.

Definition at line 730 of file RNTupleDescriptor.hxx.

◆ fVersionMinor

std::uint16_t ROOT::RNTupleDescriptor::fVersionMinor = 0
private

Set by the descriptor builder when deserialized.

Definition at line 731 of file RNTupleDescriptor.hxx.

◆ fVersionPatch

std::uint16_t ROOT::RNTupleDescriptor::fVersionPatch = 0
private

Set by the descriptor builder when deserialized.

Definition at line 732 of file RNTupleDescriptor.hxx.

◆ kFeatureFlagTest

constexpr unsigned int ROOT::RNTupleDescriptor::kFeatureFlagTest = 137
staticconstexpr

Definition at line 769 of file RNTupleDescriptor.hxx.

Libraries for ROOT::RNTupleDescriptor:
[legend]
The documentation for this class was generated from the following files: