ROOT::RClusterGroupDescriptor Class Reference

Clusters are bundled in cluster groups.

Very large RNTuples can contain multiple cluster groups to organize cluster metadata. Every RNTuple has at least one cluster group. The clusters in a cluster group are ordered corresponding to their first entry number.

Definition at line 582 of file RNTupleDescriptor.hxx.

Public Member Functions
	RClusterGroupDescriptor ()=default
	RClusterGroupDescriptor (const RClusterGroupDescriptor &other)=delete
	RClusterGroupDescriptor (RClusterGroupDescriptor &&other)=default
RClusterGroupDescriptor	Clone () const
RClusterGroupDescriptor	CloneSummary () const
	Creates a clone without the cluster IDs.
const std::vector< ROOT::DescriptorId_t > &	GetClusterIds () const
std::uint64_t	GetEntrySpan () const
ROOT::DescriptorId_t	GetId () const
std::uint64_t	GetMinEntry () const
std::uint32_t	GetNClusters () const
std::uint64_t	GetPageListLength () const
RNTupleLocator	GetPageListLocator () const
bool	HasClusterDetails () const
	A cluster group is loaded in two stages.
RClusterGroupDescriptor &	operator= (const RClusterGroupDescriptor &other)=delete
RClusterGroupDescriptor &	operator= (RClusterGroupDescriptor &&other)=default
bool	operator== (const RClusterGroupDescriptor &other) const

Private Attributes
ROOT::DescriptorId_t	fClusterGroupId = ROOT::kInvalidDescriptorId
std::vector< ROOT::DescriptorId_t >	fClusterIds
	The cluster IDs can be empty if the corresponding page list is not loaded.
std::uint64_t	fEntrySpan = 0
	Number of entries that are (partially for sharded clusters) covered by this cluster group.
std::uint64_t	fMinEntry = 0
	The minimum first entry number of the clusters in the cluster group.
std::uint32_t	fNClusters = 0
	Number of clusters is always known even if the cluster IDs are not (yet) populated.
std::uint64_t	fPageListLength = 0
	Uncompressed size of the page list.
RNTupleLocator	fPageListLocator
	The page list that corresponds to the cluster group.

Friends
class	Internal::RClusterGroupDescriptorBuilder

#include <ROOT/RNTupleDescriptor.hxx>

Constructor & Destructor Documentation

RClusterGroupDescriptor() [1/3]

ROOT::RClusterGroupDescriptor::RClusterGroupDescriptor ( )

default

RClusterGroupDescriptor() [2/3]

ROOT::RClusterGroupDescriptor::RClusterGroupDescriptor ( const RClusterGroupDescriptor & other )

delete

RClusterGroupDescriptor() [3/3]

ROOT::RClusterGroupDescriptor::RClusterGroupDescriptor ( RClusterGroupDescriptor && other )

default

Member Function Documentation

Clone()

ROOT::RClusterGroupDescriptor ROOT::RClusterGroupDescriptor::Clone

(

)

const

Definition at line 838 of file RNTupleDescriptor.cxx.

CloneSummary()

ROOT::RClusterGroupDescriptor ROOT::RClusterGroupDescriptor::CloneSummary

(

)

const

Creates a clone without the cluster IDs.

Definition at line 826 of file RNTupleDescriptor.cxx.

GetClusterIds()

const std::vector< ROOT::DescriptorId_t > & ROOT::RClusterGroupDescriptor::GetClusterIds ( ) const

inline

Definition at line 618 of file RNTupleDescriptor.hxx.

GetEntrySpan()

std::uint64_t ROOT::RClusterGroupDescriptor::GetEntrySpan ( ) const

inline

Definition at line 620 of file RNTupleDescriptor.hxx.

GetId()

ROOT::DescriptorId_t ROOT::RClusterGroupDescriptor::GetId ( ) const

inline

Definition at line 614 of file RNTupleDescriptor.hxx.

GetMinEntry()

std::uint64_t ROOT::RClusterGroupDescriptor::GetMinEntry ( ) const

inline

Definition at line 619 of file RNTupleDescriptor.hxx.

GetNClusters()

std::uint32_t ROOT::RClusterGroupDescriptor::GetNClusters ( ) const

inline

Definition at line 615 of file RNTupleDescriptor.hxx.

GetPageListLength()

std::uint64_t ROOT::RClusterGroupDescriptor::GetPageListLength ( ) const

inline

Definition at line 617 of file RNTupleDescriptor.hxx.

GetPageListLocator()

RNTupleLocator ROOT::RClusterGroupDescriptor::GetPageListLocator ( ) const

inline

Definition at line 616 of file RNTupleDescriptor.hxx.

HasClusterDetails()

bool ROOT::RClusterGroupDescriptor::HasClusterDetails ( ) const

inline

A cluster group is loaded in two stages.

Stage one loads only the summary information. Stage two loads the list of cluster IDs.

Definition at line 623 of file RNTupleDescriptor.hxx.

operator=() [1/2]

RClusterGroupDescriptor & ROOT::RClusterGroupDescriptor::operator= ( const RClusterGroupDescriptor & other )

delete

operator=() [2/2]

RClusterGroupDescriptor & ROOT::RClusterGroupDescriptor::operator= ( RClusterGroupDescriptor && other )

default

operator==()

bool ROOT::RClusterGroupDescriptor::operator==

(

const RClusterGroupDescriptor &

other

)

const

Definition at line 820 of file RNTupleDescriptor.cxx.

Friends And Related Symbol Documentation

Internal::RClusterGroupDescriptorBuilder

friend class Internal::RClusterGroupDescriptorBuilder

friend

Definition at line 583 of file RNTupleDescriptor.hxx.

Member Data Documentation

fClusterGroupId

ROOT::DescriptorId_t ROOT::RClusterGroupDescriptor::fClusterGroupId = ROOT::kInvalidDescriptorId

private

Definition at line 586 of file RNTupleDescriptor.hxx.

fClusterIds

std::vector<ROOT::DescriptorId_t> ROOT::RClusterGroupDescriptor::fClusterIds

private

The cluster IDs can be empty if the corresponding page list is not loaded.

Otherwise, cluster ids are sorted by first entry number.

Definition at line 589 of file RNTupleDescriptor.hxx.

fEntrySpan

std::uint64_t ROOT::RClusterGroupDescriptor::fEntrySpan = 0

private

Number of entries that are (partially for sharded clusters) covered by this cluster group.

Definition at line 597 of file RNTupleDescriptor.hxx.

fMinEntry

std::uint64_t ROOT::RClusterGroupDescriptor::fMinEntry = 0

private

The minimum first entry number of the clusters in the cluster group.

Definition at line 595 of file RNTupleDescriptor.hxx.

fNClusters

std::uint32_t ROOT::RClusterGroupDescriptor::fNClusters = 0

private

Number of clusters is always known even if the cluster IDs are not (yet) populated.

Definition at line 599 of file RNTupleDescriptor.hxx.

fPageListLength

std::uint64_t ROOT::RClusterGroupDescriptor::fPageListLength = 0

private

Uncompressed size of the page list.

Definition at line 593 of file RNTupleDescriptor.hxx.

fPageListLocator

RNTupleLocator ROOT::RClusterGroupDescriptor::fPageListLocator

private

The page list that corresponds to the cluster group.

Definition at line 591 of file RNTupleDescriptor.hxx.

Libraries for ROOT::RClusterGroupDescriptor:

---

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

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