Logo ROOT  
Reference Guide
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 695 of file RNTupleDescriptor.hxx.

Public Member Functions

void AddCluster (DescriptorId_t clusterId, RNTupleVersion version, NTupleSize_t firstEntryIndex, ClusterSize_t nEntries)
 
void AddClusterColumnRange (DescriptorId_t clusterId, const RClusterDescriptor::RColumnRange &columnRange)
 
void AddClusterPageRange (DescriptorId_t clusterId, RClusterDescriptor::RPageRange &&pageRange)
 
void AddClustersFromFooter (void *footerBuffer)
 
void AddColumn (DescriptorId_t columnId, DescriptorId_t fieldId, const RNTupleVersion &version, const RColumnModel &model, std::uint32_t index)
 
void AddField (const RFieldDescriptor &fieldDesc)
 
RResult< voidAddFieldLink (DescriptorId_t fieldId, DescriptorId_t linkId)
 
RResult< voidEnsureValidDescriptor () const
 Checks whether invariants hold: More...
 
const RNTupleDescriptorGetDescriptor () const
 
RNTupleDescriptor MoveDescriptor ()
 
void Reset ()
 Clears so-far stored clusters, fields, and columns and return to a pristine ntuple descriptor. More...
 
void SetClusterLocator (DescriptorId_t clusterId, RClusterDescriptor::RLocator locator)
 
void SetFromHeader (void *headerBuffer)
 
void SetNTuple (const std::string_view name, const std::string_view description, const std::string_view author, const RNTupleVersion &version, const RNTupleUuid &uuid)
 

Private Attributes

RNTupleDescriptor fDescriptor
 

#include <ROOT/RNTupleDescriptor.hxx>

Member Function Documentation

◆ AddCluster()

void ROOT::Experimental::RNTupleDescriptorBuilder::AddCluster ( DescriptorId_t  clusterId,
RNTupleVersion  version,
NTupleSize_t  firstEntryIndex,
ClusterSize_t  nEntries 
)

Definition at line 984 of file RNTupleDescriptor.cxx.

◆ AddClusterColumnRange()

void ROOT::Experimental::RNTupleDescriptorBuilder::AddClusterColumnRange ( DescriptorId_t  clusterId,
const RClusterDescriptor::RColumnRange columnRange 
)

Definition at line 1001 of file RNTupleDescriptor.cxx.

◆ AddClusterPageRange()

void ROOT::Experimental::RNTupleDescriptorBuilder::AddClusterPageRange ( DescriptorId_t  clusterId,
RClusterDescriptor::RPageRange &&  pageRange 
)

Definition at line 1007 of file RNTupleDescriptor.cxx.

◆ AddClustersFromFooter()

void ROOT::Experimental::RNTupleDescriptorBuilder::AddClustersFromFooter ( void footerBuffer)

Definition at line 832 of file RNTupleDescriptor.cxx.

◆ AddColumn()

void ROOT::Experimental::RNTupleDescriptorBuilder::AddColumn ( DescriptorId_t  columnId,
DescriptorId_t  fieldId,
const RNTupleVersion version,
const RColumnModel model,
std::uint32_t  index 
)

Definition at line 971 of file RNTupleDescriptor.cxx.

◆ AddField()

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

Definition at line 941 of file RNTupleDescriptor.cxx.

◆ AddFieldLink()

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

Definition at line 946 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 738 of file RNTupleDescriptor.cxx.

◆ GetDescriptor()

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

Definition at line 704 of file RNTupleDescriptor.hxx.

◆ MoveDescriptor()

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

Definition at line 756 of file RNTupleDescriptor.cxx.

◆ Reset()

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

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

Definition at line 1013 of file RNTupleDescriptor.cxx.

◆ SetClusterLocator()

void ROOT::Experimental::RNTupleDescriptorBuilder::SetClusterLocator ( DescriptorId_t  clusterId,
RClusterDescriptor::RLocator  locator 
)

Definition at line 995 of file RNTupleDescriptor.cxx.

◆ SetFromHeader()

void ROOT::Experimental::RNTupleDescriptorBuilder::SetFromHeader ( void headerBuffer)

Definition at line 763 of file RNTupleDescriptor.cxx.

◆ SetNTuple()

void ROOT::Experimental::RNTupleDescriptorBuilder::SetNTuple ( const std::string_view  name,
const std::string_view  description,
const std::string_view  author,
const RNTupleVersion version,
const RNTupleUuid uuid 
)

Definition at line 891 of file RNTupleDescriptor.cxx.

Member Data Documentation

◆ fDescriptor

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

Definition at line 697 of file RNTupleDescriptor.hxx.


The documentation for this class was generated from the following files: