Logo ROOT  

Reference Guide
 
Loading...
Searching...
No Matches
List of all members | Public Types | Public Member Functions | Private Attributes | List of all members
ROOT::Experimental::RNTupleReadOptions Class Reference
NTuple-related classes

Common user-tunable settings for reading ntuples.

All page source classes need to support the common options.

Definition at line 31 of file RNTupleReadOptions.hxx.

Public Types

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

Public Member Functions

unsigned int GetClusterBunchSize () const
 
EClusterCache GetClusterCache () const
 
EImplicitMT GetUseImplicitMT () const
 
bool HasMetricsEnabled () const
 
void SetClusterBunchSize (unsigned int val)
 
void SetClusterCache (EClusterCache val)
 
void SetMetricsEnabled (bool enable)
 
void SetUseImplicitMT (EImplicitMT val)
 

Private Attributes

unsigned int fClusterBunchSize = 1
 
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
 

#include <ROOT/RNTupleReadOptions.hxx>

Member Enumeration Documentation

◆ EClusterCache

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

Definition at line 33 of file RNTupleReadOptions.hxx.

◆ EImplicitMT

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

Definition at line 38 of file RNTupleReadOptions.hxx.

Member Function Documentation

◆ GetClusterBunchSize()

unsigned int ROOT::Experimental::RNTupleReadOptions::GetClusterBunchSize ( ) const
inline

Definition at line 55 of file RNTupleReadOptions.hxx.

◆ GetClusterCache()

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

Definition at line 52 of file RNTupleReadOptions.hxx.

◆ GetUseImplicitMT()

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

Definition at line 58 of file RNTupleReadOptions.hxx.

◆ HasMetricsEnabled()

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

Definition at line 61 of file RNTupleReadOptions.hxx.

◆ SetClusterBunchSize()

void ROOT::Experimental::RNTupleReadOptions::SetClusterBunchSize ( unsigned int val)
inline

Definition at line 56 of file RNTupleReadOptions.hxx.

◆ SetClusterCache()

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

Definition at line 53 of file RNTupleReadOptions.hxx.

◆ SetMetricsEnabled()

void ROOT::Experimental::RNTupleReadOptions::SetMetricsEnabled ( bool enable)
inline

Definition at line 62 of file RNTupleReadOptions.hxx.

◆ SetUseImplicitMT()

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

Definition at line 59 of file RNTupleReadOptions.hxx.

Member Data Documentation

◆ fClusterBunchSize

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

Definition at line 45 of file RNTupleReadOptions.hxx.

◆ fClusterCache

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

Definition at line 44 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 49 of file RNTupleReadOptions.hxx.

◆ fUseImplicitMT

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

Definition at line 46 of file RNTupleReadOptions.hxx.

Libraries for ROOT::Experimental::RNTupleReadOptions:
[legend]
The documentation for this class was generated from the following file: