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 945 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 columnId, DescriptorId_t fieldId, const RColumnModel &model, std::uint32_t index)
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.
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 642 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 632 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 659 of file RNTupleDescriptor.cxx.

AddColumn() [1/2]

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

Definition at line 596 of file RNTupleDescriptor.cxx.

AddColumn() [2/2]

ROOT::Experimental::RResult< void > ROOT::Experimental::RNTupleDescriptorBuilder::AddColumn

(

RColumnDescriptor &&

columnDesc

)

Definition at line 609 of file RNTupleDescriptor.cxx.

AddField()

void ROOT::Experimental::RNTupleDescriptorBuilder::AddField

(

const RFieldDescriptor &

fieldDesc

)

Definition at line 566 of file RNTupleDescriptor.cxx.

AddFieldLink()

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

Definition at line 571 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 965 of file RNTupleDescriptor.hxx.

EnsureFieldExists()

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

private

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

GetDescriptor()

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

inline

Definition at line 956 of file RNTupleDescriptor.hxx.

GetHeaderCRC32()

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

inline

Definition at line 961 of file RNTupleDescriptor.hxx.

MoveDescriptor()

ROOT::Experimental::RNTupleDescriptor ROOT::Experimental::RNTupleDescriptorBuilder::MoveDescriptor

(

)

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

SetHeaderCRC32()

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

inline

Definition at line 960 of file RNTupleDescriptor.hxx.

SetNTuple()

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

Definition at line 509 of file RNTupleDescriptor.cxx.

SetOnDiskHeaderSize()

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

inline

Definition at line 963 of file RNTupleDescriptor.hxx.

Member Data Documentation

fDescriptor

RNTupleDescriptor ROOT::Experimental::RNTupleDescriptorBuilder::fDescriptor

private

Definition at line 947 of file RNTupleDescriptor.hxx.

fHeaderCRC32

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

private

Definition at line 948 of file RNTupleDescriptor.hxx.

Libraries for ROOT::Experimental::RNTupleDescriptorBuilder:

---

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

• tree/ntuple/v7/inc/ROOT/RNTupleDescriptor.hxx
• tree/ntuple/v7/src/RNTupleDescriptor.cxx