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::Internal::RNTupleDescriptorBuilder Class Referencefinal
RNTuple-related classes

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 1532 of file RNTupleDescriptor.hxx.

Public Member Functions

RResult< void > AddCluster (RClusterDescriptor &&clusterDesc)
 
RResult< void > AddClusterGroup (RClusterGroupDescriptor &&clusterGroup)
 
RResult< void > AddColumn (RColumnDescriptor &&columnDesc)
 
RResult< void > AddExtraTypeInfo (RExtraTypeInfoDescriptor &&extraTypeInfoDesc)
 
void AddField (const RFieldDescriptor &fieldDesc)
 
RResult< void > AddFieldLink (ROOT::DescriptorId_t fieldId, ROOT::DescriptorId_t linkId)
 
RResult< void > AddFieldProjection (ROOT::DescriptorId_t sourceId, ROOT::DescriptorId_t targetId)
 
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
 
RNTupleDescriptor MoveDescriptor ()
 
void ReplaceExtraTypeInfo (RExtraTypeInfoDescriptor &&extraTypeInfoDesc)
 
void Reset ()
 Clears so-far stored clusters, fields, and columns and return to a pristine RNTupleDescriptor.
 
void SetFeature (unsigned int flag)
 
void SetNTuple (const std::string_view name, const std::string_view description)
 
void SetOnDiskHeaderSize (std::uint64_t size)
 
void SetOnDiskHeaderXxHash3 (std::uint64_t xxhash3)
 
void SetSchemaFromExisting (const RNTupleDescriptor &descriptor)
 Copies the "schema" part of descriptor into the builder's descriptor.
 
void SetVersion (std::uint16_t versionEpoch, std::uint16_t versionMajor, std::uint16_t versionMinor, std::uint16_t versionPatch)
 
void SetVersionForWriting ()
 
void ShiftAliasColumns (std::uint32_t offset)
 Shift column IDs of alias columns by offset
 

Private Member Functions

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

Private Attributes

RNTupleDescriptor fDescriptor
 

#include <ROOT/RNTupleDescriptor.hxx>

Member Function Documentation

◆ AddCluster()

ROOT::RResult< void > ROOT::Internal::RNTupleDescriptorBuilder::AddCluster ( RClusterDescriptor && clusterDesc)

Definition at line 1330 of file RNTupleDescriptor.cxx.

◆ AddClusterGroup()

ROOT::RResult< void > ROOT::Internal::RNTupleDescriptorBuilder::AddClusterGroup ( RClusterGroupDescriptor && clusterGroup)

Definition at line 1274 of file RNTupleDescriptor.cxx.

◆ AddColumn()

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

Definition at line 1220 of file RNTupleDescriptor.cxx.

◆ AddExtraTypeInfo()

ROOT::RResult< void > ROOT::Internal::RNTupleDescriptorBuilder::AddExtraTypeInfo ( RExtraTypeInfoDescriptor && extraTypeInfoDesc)

Definition at line 1340 of file RNTupleDescriptor.cxx.

◆ AddField()

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

Definition at line 1157 of file RNTupleDescriptor.cxx.

◆ AddFieldLink()

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

Definition at line 1168 of file RNTupleDescriptor.cxx.

◆ AddFieldProjection()

ROOT::RResult< void > ROOT::Internal::RNTupleDescriptorBuilder::AddFieldProjection ( ROOT::DescriptorId_t sourceId,
ROOT::DescriptorId_t targetId )

Definition at line 1192 of file RNTupleDescriptor.cxx.

◆ AddToOnDiskFooterSize()

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

The real footer size also include the page list envelopes.

Definition at line 1561 of file RNTupleDescriptor.hxx.

◆ BeginHeaderExtension()

void ROOT::Internal::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 1301 of file RNTupleDescriptor.cxx.

◆ EnsureFieldExists()

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

Definition at line 992 of file RNTupleDescriptor.cxx.

◆ EnsureValidDescriptor()

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

Checks whether invariants hold:

  • RNTuple epoch is valid
  • RNTuple name is valid
  • Fields have valid parents
  • Number of columns is constant across column representations

Definition at line 999 of file RNTupleDescriptor.cxx.

◆ GetDescriptor()

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

Definition at line 1544 of file RNTupleDescriptor.hxx.

◆ MoveDescriptor()

ROOT::RNTupleDescriptor ROOT::Internal::RNTupleDescriptorBuilder::MoveDescriptor ( )

Definition at line 1038 of file RNTupleDescriptor.cxx.

◆ ReplaceExtraTypeInfo()

void ROOT::Internal::RNTupleDescriptorBuilder::ReplaceExtraTypeInfo ( RExtraTypeInfoDescriptor && extraTypeInfoDesc)

Definition at line 1351 of file RNTupleDescriptor.cxx.

◆ Reset()

void ROOT::Internal::RNTupleDescriptorBuilder::Reset ( )

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

Definition at line 1285 of file RNTupleDescriptor.cxx.

◆ SetFeature()

void ROOT::Internal::RNTupleDescriptorBuilder::SetFeature ( unsigned int flag)

Definition at line 1081 of file RNTupleDescriptor.cxx.

◆ SetNTuple()

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

Definition at line 1074 of file RNTupleDescriptor.cxx.

◆ SetOnDiskHeaderSize()

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

Definition at line 1559 of file RNTupleDescriptor.hxx.

◆ SetOnDiskHeaderXxHash3()

void ROOT::Internal::RNTupleDescriptorBuilder::SetOnDiskHeaderXxHash3 ( std::uint64_t xxhash3)
inline

Definition at line 1558 of file RNTupleDescriptor.hxx.

◆ SetSchemaFromExisting()

void ROOT::Internal::RNTupleDescriptorBuilder::SetSchemaFromExisting ( const RNTupleDescriptor & descriptor)

Copies the "schema" part of descriptor into the builder's descriptor.

This resets the builder's descriptor.

Definition at line 1296 of file RNTupleDescriptor.cxx.

◆ SetVersion()

void ROOT::Internal::RNTupleDescriptorBuilder::SetVersion ( std::uint16_t versionEpoch,
std::uint16_t versionMajor,
std::uint16_t versionMinor,
std::uint16_t versionPatch )

Definition at line 1054 of file RNTupleDescriptor.cxx.

◆ SetVersionForWriting()

void ROOT::Internal::RNTupleDescriptorBuilder::SetVersionForWriting ( )

Definition at line 1066 of file RNTupleDescriptor.cxx.

◆ ShiftAliasColumns()

void ROOT::Internal::RNTupleDescriptorBuilder::ShiftAliasColumns ( std::uint32_t offset)

Shift column IDs of alias columns by offset

If the descriptor is constructed in pieces consisting of physical and alias columns (regular and projected fields), the natural column order would be

  • Physical and alias columns of piece one
  • Physical and alias columns of piece two
  • etc. What we want, however, are first all physical column IDs and then all alias column IDs. This method adds offset to the logical column IDs of all alias columns and fixes up the corresponding column IDs in the projected field descriptors. In this way, a new piece of physical and alias columns can first shift the existing alias columns by the number of new physical columns, resulting in the following order
  • Physical columns of piece one
  • Physical columns of piece two
  • ...

Logical columns of piece two

  • ...

Definition at line 1307 of file RNTupleDescriptor.cxx.

Member Data Documentation

◆ fDescriptor

RNTupleDescriptor ROOT::Internal::RNTupleDescriptorBuilder::fDescriptor
private

Definition at line 1534 of file RNTupleDescriptor.hxx.

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