Representation of an RNTuple data set in a ROOT file.
The class points to the header and footer keys, which in turn have the references to the pages (via page lists). 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.
In the list of keys, this object appears as "ROOT::Experimental::RNTuple". It is the user-facing representation of an RNTuple data set in a ROOT file and it provides an API entry point to an RNTuple stored in a ROOT file. Its main purpose is to construct a page source for an RNTuple, which in turn can be used to read an RNTuple with an RDF or an RNTupleReader.
For instance, for an RNTuple called "Events" in a ROOT file, usage can be
Definition at line 61 of file RNTuple.hxx.
Public Member Functions | |
RNTuple ()=default | |
~RNTuple ()=default | |
std::uint64_t | GetLenFooter () const |
std::uint64_t | GetLenHeader () const |
std::uint64_t | GetMaxKeySize () const |
std::uint64_t | GetNBytesFooter () const |
std::uint64_t | GetNBytesHeader () const |
std::uint64_t | GetSeekFooter () const |
std::uint64_t | GetSeekHeader () const |
std::uint16_t | GetVersionEpoch () const |
std::uint16_t | GetVersionMajor () const |
std::uint16_t | GetVersionMinor () const |
std::uint16_t | GetVersionPatch () const |
TClass * | IsA () const |
Long64_t | Merge (TCollection *input, TFileMergeInfo *mergeInfo) |
RNTuple implements the hadd MergeFile interface Merge this NTuple with the input list entries. | |
void | Streamer (TBuffer &) |
void | StreamerNVirtual (TBuffer &ClassDef_StreamerNVirtual_b) |
Static Public Member Functions | |
static TClass * | Class () |
static const char * | Class_Name () |
static constexpr Version_t | Class_Version () |
NOTE: if you change this version you also need to update: | |
static const char * | DeclFileName () |
Static Public Attributes | |
static constexpr std::uint16_t | kVersionEpoch = 0 |
static constexpr std::uint16_t | kVersionMajor = 2 |
static constexpr std::uint16_t | kVersionMinor = 0 |
static constexpr std::uint16_t | kVersionPatch = 0 |
Private Attributes | |
TFile * | fFile = nullptr |
! The file from which the ntuple was streamed, registered in the custom streamer | |
std::uint64_t | fLenFooter = 0 |
The size of the uncompressed ntuple footer. | |
std::uint64_t | fLenHeader = 0 |
The size of the uncompressed ntuple header. | |
std::uint64_t | fMaxKeySize = 0 |
The maximum size for a TKey payload. Payloads bigger than this size will be written as multiple blobs. | |
std::uint64_t | fNBytesFooter = 0 |
The size of the compressed ntuple footer. | |
std::uint64_t | fNBytesHeader = 0 |
The size of the compressed ntuple header. | |
std::uint64_t | fSeekFooter = 0 |
The file offset of the footer excluding the TKey part. | |
std::uint64_t | fSeekHeader = 0 |
The file offset of the header excluding the TKey part. | |
std::uint16_t | fVersionEpoch = kVersionEpoch |
Version of the RNTuple binary format that the writer supports (see specification). | |
std::uint16_t | fVersionMajor = kVersionMajor |
Changing the major version indicates forward incompatible changes; such changes should correspond to a new bit in the feature flag of the RNTuple header. | |
std::uint16_t | fVersionMinor = kVersionMinor |
Changing the minor version indicates new optional fields added to the RNTuple meta-data. | |
std::uint16_t | fVersionPatch = kVersionPatch |
Changing the patch version indicates new backported features from newer binary format versions. | |
Friends | |
class | Internal::RMiniFileReader |
class | Internal::RNTupleFileWriter |
class | Internal::RPageSourceFile |
#include <ROOT/RNTuple.hxx>
|
default |
|
default |
|
static |
|
inlinestaticconstexpr |
NOTE: if you change this version you also need to update:
Definition at line 127 of file RNTuple.hxx.
|
inlinestatic |
Definition at line 127 of file RNTuple.hxx.
|
inline |
Definition at line 116 of file RNTuple.hxx.
|
inline |
Definition at line 112 of file RNTuple.hxx.
|
inline |
Definition at line 117 of file RNTuple.hxx.
|
inline |
Definition at line 115 of file RNTuple.hxx.
|
inline |
Definition at line 111 of file RNTuple.hxx.
|
inline |
Definition at line 114 of file RNTuple.hxx.
|
inline |
Definition at line 110 of file RNTuple.hxx.
|
inline |
Definition at line 105 of file RNTuple.hxx.
|
inline |
Definition at line 106 of file RNTuple.hxx.
|
inline |
Definition at line 107 of file RNTuple.hxx.
|
inline |
Definition at line 108 of file RNTuple.hxx.
|
inline |
Definition at line 127 of file RNTuple.hxx.
Long64_t RNTuple::Merge | ( | TCollection * | input, |
TFileMergeInfo * | mergeInfo | ||
) |
RNTuple implements the hadd MergeFile interface Merge this NTuple with the input list entries.
Definition at line 45 of file RNTupleMerger.cxx.
void ROOT::Experimental::RNTuple::Streamer | ( | TBuffer & | buf | ) |
Definition at line 27 of file RNTuple.cxx.
|
inline |
Definition at line 127 of file RNTuple.hxx.
|
friend |
Definition at line 62 of file RNTuple.hxx.
|
friend |
Definition at line 63 of file RNTuple.hxx.
|
friend |
Definition at line 64 of file RNTuple.hxx.
|
private |
! The file from which the ntuple was streamed, registered in the custom streamer
Definition at line 99 of file RNTuple.hxx.
|
private |
The size of the uncompressed ntuple footer.
Definition at line 95 of file RNTuple.hxx.
|
private |
The size of the uncompressed ntuple header.
Definition at line 89 of file RNTuple.hxx.
|
private |
The maximum size for a TKey payload. Payloads bigger than this size will be written as multiple blobs.
Definition at line 97 of file RNTuple.hxx.
|
private |
The size of the compressed ntuple footer.
Definition at line 93 of file RNTuple.hxx.
|
private |
The size of the compressed ntuple header.
Definition at line 87 of file RNTuple.hxx.
|
private |
The file offset of the footer excluding the TKey part.
Definition at line 91 of file RNTuple.hxx.
|
private |
The file offset of the header excluding the TKey part.
Definition at line 85 of file RNTuple.hxx.
|
private |
Version of the RNTuple binary format that the writer supports (see specification).
Changing the epoch indicates backward-incompatible changes
Definition at line 75 of file RNTuple.hxx.
|
private |
Changing the major version indicates forward incompatible changes; such changes should correspond to a new bit in the feature flag of the RNTuple header.
For the pre-release epoch 0, indicates the release candidate number
Definition at line 79 of file RNTuple.hxx.
|
private |
Changing the minor version indicates new optional fields added to the RNTuple meta-data.
Definition at line 81 of file RNTuple.hxx.
|
private |
Changing the patch version indicates new backported features from newer binary format versions.
Definition at line 83 of file RNTuple.hxx.
|
staticconstexpr |
Definition at line 67 of file RNTuple.hxx.
|
staticconstexpr |
Definition at line 68 of file RNTuple.hxx.
|
staticconstexpr |
Definition at line 69 of file RNTuple.hxx.
|
staticconstexpr |
Definition at line 70 of file RNTuple.hxx.