Logo ROOT  

Reference Guide
 
Loading...
Searching...
No Matches
List of all members | Public Member Functions | Private Member Functions | Private Attributes | List of all members
ROOT::Experimental::RNTupleDescriptorBuilder Class Reference

A helper class for piece-wise construction of an RNTupleDescriptor.

Used by RPageStorage implementations in order to construct the RNTupleDescriptor from the various header parts.

Definition at line 1036 of file RNTupleDescriptor.hxx.

Public Member Functions

void AddClusterGroup (RClusterGroupDescriptorBuilder &&clusterGroup)
 
RResult< void > AddClusterSummary (DescriptorId_t clusterId, std::uint64_t firstEntry, std::uint64_t nEntries)
 
RResult< void > AddClusterWithDetails (RClusterDescriptor &&clusterDesc)
 Used during writing.
 
void AddColumn (DescriptorId_t logicalId, DescriptorId_t physicalId, DescriptorId_t fieldId, const RColumnModel &model, std::uint32_t index, std::uint64_t firstElementIdx=0U)
 
RResult< void > AddColumn (RColumnDescriptor &&columnDesc)
 
void AddField (const RFieldDescriptor &fieldDesc)
 
RResult< void > AddFieldLink (DescriptorId_t fieldId, DescriptorId_t linkId)
 
void AddToOnDiskFooterSize (std::uint64_t size)
 The real footer size also include the page list envelopes.
 
void BeginHeaderExtension ()
 Mark the beginning of the header extension; any fields and columns added after a call to this function are annotated as begin part of the header extension.
 
RResult< void > EnsureValidDescriptor () const
 Checks whether invariants hold:
 
const RNTupleDescriptor & GetDescriptor () const
 
std::uint32_t GetHeaderCRC32 () const
 
RNTupleDescriptor MoveDescriptor ()
 
void Reset ()
 Clears so-far stored clusters, fields, and columns and return to a pristine ntuple descriptor.
 
void SetHeaderCRC32 (std::uint32_t crc32)
 
void SetNTuple (const std::string_view name, const std::string_view description)
 
void SetOnDiskHeaderSize (std::uint64_t size)
 

Private Member Functions

RResult< void > EnsureFieldExists (DescriptorId_t fieldId) const
 

Private Attributes

RNTupleDescriptor fDescriptor
 
std::uint32_t fHeaderCRC32 = 0
 

#include <ROOT/RNTupleDescriptor.hxx>

Member Function Documentation

◆ AddClusterGroup()

void ROOT::Experimental::RNTupleDescriptorBuilder::AddClusterGroup ( RClusterGroupDescriptorBuilder &&  clusterGroup)

Definition at line 809 of file RNTupleDescriptor.cxx.

◆ AddClusterSummary()

ROOT::Experimental::RResult< void > ROOT::Experimental::RNTupleDescriptorBuilder::AddClusterSummary ( DescriptorId_t  clusterId,
std::uint64_t  firstEntry,
std::uint64_t  nEntries 
)

Definition at line 799 of file RNTupleDescriptor.cxx.

◆ AddClusterWithDetails()

ROOT::Experimental::RResult< void > ROOT::Experimental::RNTupleDescriptorBuilder::AddClusterWithDetails ( RClusterDescriptor &&  clusterDesc)

Used during writing.

For reading, cluster summaries are added in the builder and cluster details are added on demand through the RNTupleDescriptor.

Definition at line 833 of file RNTupleDescriptor.cxx.

◆ AddColumn() [1/2]

void ROOT::Experimental::RNTupleDescriptorBuilder::AddColumn ( DescriptorId_t  logicalId,
DescriptorId_t  physicalId,
DescriptorId_t  fieldId,
const RColumnModel &  model,
std::uint32_t  index,
std::uint64_t  firstElementIdx = 0U 
)

Definition at line 748 of file RNTupleDescriptor.cxx.

◆ AddColumn() [2/2]

ROOT::Experimental::RResult< void > ROOT::Experimental::RNTupleDescriptorBuilder::AddColumn ( RColumnDescriptor &&  columnDesc)

Definition at line 768 of file RNTupleDescriptor.cxx.

◆ AddField()

void ROOT::Experimental::RNTupleDescriptorBuilder::AddField ( const RFieldDescriptor &  fieldDesc)

Definition at line 716 of file RNTupleDescriptor.cxx.

◆ AddFieldLink()

ROOT::Experimental::RResult< void > ROOT::Experimental::RNTupleDescriptorBuilder::AddFieldLink ( DescriptorId_t  fieldId,
DescriptorId_t  linkId 
)

Definition at line 723 of file RNTupleDescriptor.cxx.

◆ AddToOnDiskFooterSize()

void ROOT::Experimental::RNTupleDescriptorBuilder::AddToOnDiskFooterSize ( std::uint64_t  size)
inline

The real footer size also include the page list envelopes.

Definition at line 1056 of file RNTupleDescriptor.hxx.

◆ BeginHeaderExtension()

void ROOT::Experimental::RNTupleDescriptorBuilder::BeginHeaderExtension ( )

Mark the beginning of the header extension; any fields and columns added after a call to this function are annotated as begin part of the header extension.

Definition at line 826 of file RNTupleDescriptor.cxx.

◆ EnsureFieldExists()

ROOT::Experimental::RResult< void > ROOT::Experimental::RNTupleDescriptorBuilder::EnsureFieldExists ( DescriptorId_t  fieldId) const
private

Definition at line 624 of file RNTupleDescriptor.cxx.

◆ EnsureValidDescriptor()

ROOT::Experimental::RResult< void > ROOT::Experimental::RNTupleDescriptorBuilder::EnsureValidDescriptor ( ) const

Checks whether invariants hold:

  • NTuple name is valid
  • Fields have valid parent and child ids

Definition at line 631 of file RNTupleDescriptor.cxx.

◆ GetDescriptor()

const RNTupleDescriptor & ROOT::Experimental::RNTupleDescriptorBuilder::GetDescriptor ( ) const
inline

Definition at line 1047 of file RNTupleDescriptor.hxx.

◆ GetHeaderCRC32()

std::uint32_t ROOT::Experimental::RNTupleDescriptorBuilder::GetHeaderCRC32 ( ) const
inline

Definition at line 1052 of file RNTupleDescriptor.hxx.

◆ MoveDescriptor()

ROOT::Experimental::RNTupleDescriptor ROOT::Experimental::RNTupleDescriptorBuilder::MoveDescriptor ( )

Definition at line 649 of file RNTupleDescriptor.cxx.

◆ Reset()

void ROOT::Experimental::RNTupleDescriptorBuilder::Reset ( )

Clears so-far stored clusters, fields, and columns and return to a pristine ntuple descriptor.

Definition at line 815 of file RNTupleDescriptor.cxx.

◆ SetHeaderCRC32()

void ROOT::Experimental::RNTupleDescriptorBuilder::SetHeaderCRC32 ( std::uint32_t  crc32)
inline

Definition at line 1051 of file RNTupleDescriptor.hxx.

◆ SetNTuple()

void ROOT::Experimental::RNTupleDescriptorBuilder::SetNTuple ( const std::string_view  name,
const std::string_view  description 
)

Definition at line 656 of file RNTupleDescriptor.cxx.

◆ SetOnDiskHeaderSize()

void ROOT::Experimental::RNTupleDescriptorBuilder::SetOnDiskHeaderSize ( std::uint64_t  size)
inline

Definition at line 1054 of file RNTupleDescriptor.hxx.

Member Data Documentation

◆ fDescriptor

RNTupleDescriptor ROOT::Experimental::RNTupleDescriptorBuilder::fDescriptor
private

Definition at line 1038 of file RNTupleDescriptor.hxx.

◆ fHeaderCRC32

std::uint32_t ROOT::Experimental::RNTupleDescriptorBuilder::fHeaderCRC32 = 0
private

Definition at line 1039 of file RNTupleDescriptor.hxx.

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