Logo ROOT  
Reference Guide
ROOT::Experimental::RNTuple Class Reference

Entry point for an RNTuple in a ROOT file.

The class points to the header and footer keys, which in turn have the references to the pages. Only the RNTuple key will be listed in the list of keys. Like TBaskets, the pages are "invisible" keys. Byte offset references in the RNTuple header and footer reference directly the data part of page records, skipping the TFile key part.

While the class is central to anchoring an RNTuple in a TFile, it is an internal detail not exposed to users. Note that there is no user-facing RNTuple class but RNTupleReader and RNTupleWriter.

Definition at line 55 of file RMiniFile.hxx.

Public Member Functions

Long64_t Merge (TCollection *input, TFileMergeInfo *mergeInfo)
 Merge this NTuple with the input list entries. More...
 
bool operator== (const RNTuple &other) const
 The canonical, member-wise equality test. More...
 

Public Attributes

std::uint32_t fLenFooter = 0
 The size of the uncompressed ntuple footer. More...
 
std::uint32_t fLenHeader = 0
 The size of the uncompressed ntuple header. More...
 
std::uint32_t fNBytesFooter = 0
 The size of the compressed ntuple footer. More...
 
std::uint32_t fNBytesHeader = 0
 The size of the compressed ntuple header. More...
 
std::uint64_t fReserved = 0
 Currently unused, reserved for later use. More...
 
std::uint64_t fSeekFooter = 0
 The file offset of the footer excluding the TKey part. More...
 
std::uint64_t fSeekHeader = 0
 The file offset of the header excluding the TKey part. More...
 
std::uint32_t fSize = sizeof(RNTuple)
 Allows for skipping the struct. More...
 
std::uint32_t fVersion = 0
 Allows for evolving the struct in future versions. More...
 

#include <ROOT/RMiniFile.hxx>

Member Function Documentation

◆ Merge()

Long64_t ROOT::Experimental::RNTuple::Merge ( TCollection input,
TFileMergeInfo mergeInfo 
)

Merge this NTuple with the input list entries.

Definition at line 22 of file RNTupleMerger.cxx.

◆ operator==()

bool ROOT::Experimental::RNTuple::operator== ( const RNTuple other) const
inline

The canonical, member-wise equality test.

Definition at line 76 of file RMiniFile.hxx.

Member Data Documentation

◆ fLenFooter

std::uint32_t ROOT::Experimental::RNTuple::fLenFooter = 0

The size of the uncompressed ntuple footer.

Definition at line 71 of file RMiniFile.hxx.

◆ fLenHeader

std::uint32_t ROOT::Experimental::RNTuple::fLenHeader = 0

The size of the uncompressed ntuple header.

Definition at line 65 of file RMiniFile.hxx.

◆ fNBytesFooter

std::uint32_t ROOT::Experimental::RNTuple::fNBytesFooter = 0

The size of the compressed ntuple footer.

Definition at line 69 of file RMiniFile.hxx.

◆ fNBytesHeader

std::uint32_t ROOT::Experimental::RNTuple::fNBytesHeader = 0

The size of the compressed ntuple header.

Definition at line 63 of file RMiniFile.hxx.

◆ fReserved

std::uint64_t ROOT::Experimental::RNTuple::fReserved = 0

Currently unused, reserved for later use.

Definition at line 73 of file RMiniFile.hxx.

◆ fSeekFooter

std::uint64_t ROOT::Experimental::RNTuple::fSeekFooter = 0

The file offset of the footer excluding the TKey part.

Definition at line 67 of file RMiniFile.hxx.

◆ fSeekHeader

std::uint64_t ROOT::Experimental::RNTuple::fSeekHeader = 0

The file offset of the header excluding the TKey part.

Definition at line 61 of file RMiniFile.hxx.

◆ fSize

std::uint32_t ROOT::Experimental::RNTuple::fSize = sizeof(RNTuple)

Allows for skipping the struct.

Definition at line 59 of file RMiniFile.hxx.

◆ fVersion

std::uint32_t ROOT::Experimental::RNTuple::fVersion = 0

Allows for evolving the struct in future versions.

Definition at line 57 of file RMiniFile.hxx.

Collaboration diagram for ROOT::Experimental::RNTuple:
[legend]

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