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

Public Member Functions
RClusterDescriptorBuilder &	AddExtendedColumnRanges (const RNTupleDescriptor &desc)
	Add column and page ranges for columns created during late model extension 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)
RResult< void >	CommitSuppressedColumnRanges (const RNTupleDescriptor &desc)
	Sets the first element index and number of elements for all the suppressed column ranges.
RClusterDescriptorBuilder &	FirstEntryIndex (std::uint64_t firstEntryIndex)
const RClusterDescriptor::RColumnRange &	GetColumnRange (DescriptorId_t physicalId)
RResult< void >	MarkSuppressedColumnRange (DescriptorId_t physicalId)
	Books the given column ID as being suppressed in this cluster.
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

AddExtendedColumnRanges()

ROOT::Experimental::Internal::RClusterDescriptorBuilder & ROOT::Experimental::Internal::RClusterDescriptorBuilder::AddExtendedColumnRanges

(

const RNTupleDescriptor &

desc

)

Add column and page ranges for columns created during late model extension 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() and CommitSuppressedColumnRanges() should happen before calling this function.

Definition at line 636 of file RNTupleDescriptor.cxx.

ClusterId()

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

inline

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

CommitSuppressedColumnRanges()

ROOT::Experimental::RResult< void > ROOT::Experimental::Internal::RClusterDescriptorBuilder::CommitSuppressedColumnRanges

(

const RNTupleDescriptor &

desc

)

Sets the first element index and number of elements for all the suppressed column ranges.

The information is taken from the corresponding columns from the primary representation. Needs to be called when all the columns (suppressed and regular) where added.

Definition at line 599 of file RNTupleDescriptor.cxx.

FirstEntryIndex()

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

inline

Definition at line 1214 of file RNTupleDescriptor.hxx.

GetColumnRange()

const RClusterDescriptor::RColumnRange & ROOT::Experimental::Internal::RClusterDescriptorBuilder::GetColumnRange ( DescriptorId_t  physicalId )

inline

Definition at line 1245 of file RNTupleDescriptor.hxx.

MarkSuppressedColumnRange()

ROOT::Experimental::RResult< void > ROOT::Experimental::Internal::RClusterDescriptorBuilder::MarkSuppressedColumnRange

(

DescriptorId_t

physicalId

)

Books the given column ID as being suppressed in this cluster.

The correct first element index and number of elements need to be set by CommitSuppressedColumnRanges() once all the calls to CommitColumnRange() and MarkSuppressedColumnRange() took place.

Definition at line 585 of file RNTupleDescriptor.cxx.

MoveDescriptor()

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

(

)

Move out the full cluster descriptor including page locations.

Definition at line 699 of file RNTupleDescriptor.cxx.

NEntries()

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

inline

Definition at line 1220 of file RNTupleDescriptor.hxx.

Member Data Documentation

fCluster

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

private

Definition at line 1205 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