ROOT::Experimental::RClusterDescriptorBuilder Class Reference

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

Dangling cluster descriptors can become actual descriptors when added to an RNTupleDescriptorBuilder instance.

Definition at line 742 of file RNTupleDescriptor.hxx.

Public Member Functions
	RClusterDescriptorBuilder ()=default
	Make an empty cluster descriptor builder.
RClusterDescriptorBuilder &	ClusterId (DescriptorId_t clusterId)
RResult< void >	CommitColumnRange (DescriptorId_t columnId, std::uint64_t firstElementIndex, std::uint32_t compressionSettings, const RClusterDescriptor::RPageRange &pageRange)
RClusterDescriptorBuilder &	FirstEntryIndex (std::uint64_t firstEntryIndex)
RResult< RClusterDescriptor >	MoveDescriptor ()
	Attempt to make a cluster descriptor.
RClusterDescriptorBuilder &	NEntries (std::uint64_t nEntries)

Private Attributes
RClusterDescriptor	fCluster = RClusterDescriptor()

#include <ROOT/RNTupleDescriptor.hxx>

Constructor & Destructor Documentation

RClusterDescriptorBuilder()

ROOT::Experimental::RClusterDescriptorBuilder::RClusterDescriptorBuilder ( )

default

Make an empty cluster descriptor builder.

Member Function Documentation

ClusterId()

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

inline

Definition at line 749 of file RNTupleDescriptor.hxx.

CommitColumnRange()

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

Definition at line 762 of file RNTupleDescriptor.cxx.

FirstEntryIndex()

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

inline

Definition at line 753 of file RNTupleDescriptor.hxx.

MoveDescriptor()

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

(

)

Attempt to make a cluster descriptor.

This may fail if the cluster was not given enough information to make a proper descriptor.

Definition at line 782 of file RNTupleDescriptor.cxx.

NEntries()

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

inline

Definition at line 757 of file RNTupleDescriptor.hxx.

Member Data Documentation

fCluster

RClusterDescriptor ROOT::Experimental::RClusterDescriptorBuilder::fCluster = RClusterDescriptor()

private

Definition at line 744 of file RNTupleDescriptor.hxx.

Libraries for ROOT::Experimental::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