ROOT::Experimental::Internal::RClusterDescriptorBuilder Class Reference

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

The cluster descriptor builder starts from a summary-only cluster descriptor and allows for the piecewise addition of page locations.

Definition at line 957 of file RNTupleDescriptor.hxx.

Public Member Functions
RClusterDescriptorBuilder &	AddDeferredColumnRanges (const RNTupleDescriptor &desc)
	Add column and page ranges for deferred columns missing in this cluster.
RClusterDescriptorBuilder &	ClusterId (DescriptorId_t clusterId)
RResult< void >	CommitColumnRange (DescriptorId_t physicalId, std::uint64_t firstElementIndex, std::uint32_t compressionSettings, const RClusterDescriptor::RPageRange &pageRange)
RClusterDescriptorBuilder &	FirstEntryIndex (std::uint64_t firstEntryIndex)
RResult< RClusterDescriptor >	MoveDescriptor ()
	Move out the full cluster descriptor including page locations.
RClusterDescriptorBuilder &	NEntries (std::uint64_t nEntries)

Private Attributes
RClusterDescriptor	fCluster

#include <ROOT/RNTupleDescriptor.hxx>

Member Function Documentation

AddDeferredColumnRanges()

ROOT::Experimental::Internal::RClusterDescriptorBuilder & ROOT::Experimental::Internal::RClusterDescriptorBuilder::AddDeferredColumnRanges

(

const RNTupleDescriptor &

desc

)

Add column and page ranges for deferred columns missing in this cluster.

The locator type for the synthesized page ranges is kTypePageZero. All the page sources must be able to populate the 'zero' page from such locator. Any call to CommitColumnRange() should happen before calling this function.

Definition at line 551 of file RNTupleDescriptor.cxx.

ClusterId()

RClusterDescriptorBuilder & ROOT::Experimental::Internal::RClusterDescriptorBuilder::ClusterId ( DescriptorId_t  clusterId )

inline

Definition at line 962 of file RNTupleDescriptor.hxx.

CommitColumnRange()

ROOT::Experimental::RResult< void > ROOT::Experimental::Internal::RClusterDescriptorBuilder::CommitColumnRange	(	DescriptorId_t	physicalId,
		std::uint64_t	firstElementIndex,
		std::uint32_t	compressionSettings,
		const RClusterDescriptor::RPageRange &	pageRange
	)

Definition at line 532 of file RNTupleDescriptor.cxx.

FirstEntryIndex()

RClusterDescriptorBuilder & ROOT::Experimental::Internal::RClusterDescriptorBuilder::FirstEntryIndex ( std::uint64_t  firstEntryIndex )

inline

Definition at line 968 of file RNTupleDescriptor.hxx.

MoveDescriptor()

ROOT::Experimental::RResult< ROOT::Experimental::RClusterDescriptor > ROOT::Experimental::Internal::RClusterDescriptorBuilder::MoveDescriptor

(

)

Move out the full cluster descriptor including page locations.

Definition at line 609 of file RNTupleDescriptor.cxx.

NEntries()

RClusterDescriptorBuilder & ROOT::Experimental::Internal::RClusterDescriptorBuilder::NEntries ( std::uint64_t  nEntries )

inline

Definition at line 974 of file RNTupleDescriptor.hxx.

Member Data Documentation

fCluster

RClusterDescriptor ROOT::Experimental::Internal::RClusterDescriptorBuilder::fCluster

private

Definition at line 959 of file RNTupleDescriptor.hxx.

Libraries for ROOT::Experimental::Internal::RClusterDescriptorBuilder:

---

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

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