Logo ROOT  
Reference Guide
 
Loading...
Searching...
No Matches
ROOT::Experimental::RNTupleReadOptions Class Reference

Common user-tunable settings for reading ntuples.

All page source classes need to support the common options.

Definition at line 43 of file RNTupleReadOptions.hxx.

Public Types

enum class  EClusterCache { kOff , kOn , kDefault = kOn }
 Controls if the prefetcher (including the prefetcher thread) is used. More...
 
enum class  EImplicitMT { kOff , kDefault }
 Allows to disable parallel page compression and decompression even if ROOT uses implicit MT. More...
 

Public Member Functions

EClusterCache GetClusterCache () const
 
bool GetEnableMetrics () const
 
EImplicitMT GetUseImplicitMT () const
 
void SetClusterCache (EClusterCache val)
 
void SetEnableMetrics (bool val)
 
void SetUseImplicitMT (EImplicitMT val)
 

Private Attributes

unsigned int fClusterBunchSize = 1
 The number of cluster to be prefetched in a single batch; this option is transitional and will be replaced by an option that allows to control the amount of memory that the prefetcher uses.
 
EClusterCache fClusterCache = EClusterCache::kDefault
 
bool fEnableMetrics = false
 If true, the RNTupleReader will track metrics straight from its construction, as if calling RNTupleReader::EnableMetrics() before having created the object.
 
EImplicitMT fUseImplicitMT = EImplicitMT::kDefault
 

Friends

class Internal::RNTupleReadOptionsManip
 

#include <ROOT/RNTupleReadOptions.hxx>

Member Enumeration Documentation

◆ EClusterCache

Controls if the prefetcher (including the prefetcher thread) is used.

Enumerator
kOff 
kOn 
kDefault 

Definition at line 48 of file RNTupleReadOptions.hxx.

◆ EImplicitMT

Allows to disable parallel page compression and decompression even if ROOT uses implicit MT.

This is useful, e.g., in the context of RDataFrame where the threads are fully managed by RDataFrame.

Enumerator
kOff 
kDefault 

Definition at line 56 of file RNTupleReadOptions.hxx.

Member Function Documentation

◆ GetClusterCache()

EClusterCache ROOT::Experimental::RNTupleReadOptions::GetClusterCache ( ) const
inline

Definition at line 72 of file RNTupleReadOptions.hxx.

◆ GetEnableMetrics()

bool ROOT::Experimental::RNTupleReadOptions::GetEnableMetrics ( ) const
inline

Definition at line 78 of file RNTupleReadOptions.hxx.

◆ GetUseImplicitMT()

EImplicitMT ROOT::Experimental::RNTupleReadOptions::GetUseImplicitMT ( ) const
inline

Definition at line 75 of file RNTupleReadOptions.hxx.

◆ SetClusterCache()

void ROOT::Experimental::RNTupleReadOptions::SetClusterCache ( EClusterCache val)
inline

Definition at line 73 of file RNTupleReadOptions.hxx.

◆ SetEnableMetrics()

void ROOT::Experimental::RNTupleReadOptions::SetEnableMetrics ( bool val)
inline

Definition at line 79 of file RNTupleReadOptions.hxx.

◆ SetUseImplicitMT()

void ROOT::Experimental::RNTupleReadOptions::SetUseImplicitMT ( EImplicitMT val)
inline

Definition at line 76 of file RNTupleReadOptions.hxx.

Friends And Related Symbol Documentation

◆ Internal::RNTupleReadOptionsManip

Definition at line 44 of file RNTupleReadOptions.hxx.

Member Data Documentation

◆ fClusterBunchSize

unsigned int ROOT::Experimental::RNTupleReadOptions::fClusterBunchSize = 1
private

The number of cluster to be prefetched in a single batch; this option is transitional and will be replaced by an option that allows to control the amount of memory that the prefetcher uses.

Definition at line 65 of file RNTupleReadOptions.hxx.

◆ fClusterCache

EClusterCache ROOT::Experimental::RNTupleReadOptions::fClusterCache = EClusterCache::kDefault
private

Definition at line 62 of file RNTupleReadOptions.hxx.

◆ fEnableMetrics

bool ROOT::Experimental::RNTupleReadOptions::fEnableMetrics = false
private

If true, the RNTupleReader will track metrics straight from its construction, as if calling RNTupleReader::EnableMetrics() before having created the object.

Definition at line 69 of file RNTupleReadOptions.hxx.

◆ fUseImplicitMT

EImplicitMT ROOT::Experimental::RNTupleReadOptions::fUseImplicitMT = EImplicitMT::kDefault
private

Definition at line 66 of file RNTupleReadOptions.hxx.

Libraries for ROOT::Experimental::RNTupleReadOptions:

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