Logo ROOT  

Reference Guide
Loading...
Searching...
No Matches
ROOT::RNTupleReadOptions Class Reference
RNTuple

Common user-tunable settings for reading RNTuples.

All page source classes need to support the common options.

Option nameTypeDefaultDescription
ClusterCacheEClusterCacheEClusterCache::kDefaultControls if the prefetcher (including the prefetcher thread) is used
UseImplicitMTEImplicitMTEImplicitMT::kDefaultAllows 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.
EnableMetricsboolfalseIf true, the RNTupleReader will track metrics straight from its construction, as if calling RNTupleReader::EnableMetrics() before having created the object.

Definition at line 77 of file RNTupleReadOptions.hxx.

Public Types

enum class  EClusterCache { kOff , kOn , kDefault = kOn }
enum class  EImplicitMT { kOff , kDefault }

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
EImplicitMT fUseImplicitMT = EImplicitMT::kDefault

Friends

class Internal::RNTupleReadOptionsManip

#include <ROOT/RNTupleReadOptions.hxx>

Member Enumeration Documentation

◆ EClusterCache

enum class ROOT::RNTupleReadOptions::EClusterCache
strong
Enumerator
kOff 
kOn 
kDefault 

Definition at line 81 of file RNTupleReadOptions.hxx.

◆ EImplicitMT

enum class ROOT::RNTupleReadOptions::EImplicitMT
strong
Enumerator
kOff 
kDefault 

Definition at line 87 of file RNTupleReadOptions.hxx.

Member Function Documentation

◆ GetClusterCache()

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

Definition at line 101 of file RNTupleReadOptions.hxx.

◆ GetEnableMetrics()

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

Definition at line 107 of file RNTupleReadOptions.hxx.

◆ GetUseImplicitMT()

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

Definition at line 104 of file RNTupleReadOptions.hxx.

◆ SetClusterCache()

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

Definition at line 102 of file RNTupleReadOptions.hxx.

◆ SetEnableMetrics()

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

Definition at line 108 of file RNTupleReadOptions.hxx.

◆ SetUseImplicitMT()

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

Definition at line 105 of file RNTupleReadOptions.hxx.

◆ Internal::RNTupleReadOptionsManip

friend class Internal::RNTupleReadOptionsManip
friend

Definition at line 78 of file RNTupleReadOptions.hxx.

Member Data Documentation

◆ fClusterBunchSize

unsigned int ROOT::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 96 of file RNTupleReadOptions.hxx.

◆ fClusterCache

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

Definition at line 93 of file RNTupleReadOptions.hxx.

◆ fEnableMetrics

bool ROOT::RNTupleReadOptions::fEnableMetrics = false
private

Definition at line 98 of file RNTupleReadOptions.hxx.

◆ fUseImplicitMT

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

Definition at line 97 of file RNTupleReadOptions.hxx.

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