Logo ROOT  
Reference Guide
ROOT::Experimental::RNTupleWriteOptions Class Reference

Common user-tunable settings for storing ntuples.

All page sink classes need to support the common options.

Definition at line 47 of file RNTupleOptions.hxx.

Public Member Functions

virtual ~RNTupleWriteOptions ()=default
 
virtual std::unique_ptr< RNTupleWriteOptionsClone () const
 
int GetCompression () const
 
ENTupleContainerFormat GetContainerFormat () const
 
NTupleSize_t GetNElementsPerPage () const
 
NTupleSize_t GetNEntriesPerCluster () const
 
bool GetUseBufferedWrite () const
 
void SetCompression (int val)
 
void SetCompression (RCompressionSetting::EAlgorithm algorithm, int compressionLevel)
 
void SetContainerFormat (ENTupleContainerFormat val)
 
void SetNElementsPerPage (NTupleSize_t val)
 
void SetNEntriesPerCluster (NTupleSize_t val)
 
void SetUseBufferedWrite (bool val)
 

Private Attributes

int fCompression {RCompressionSetting::EDefaults::kUseAnalysis}
 
ENTupleContainerFormat fContainerFormat {ENTupleContainerFormat::kTFile}
 
NTupleSize_t fNElementsPerPage = 10000
 
NTupleSize_t fNEntriesPerCluster = 64000
 
bool fUseBufferedWrite = true
 

#include <ROOT/RNTupleOptions.hxx>

Inheritance diagram for ROOT::Experimental::RNTupleWriteOptions:
[legend]

Constructor & Destructor Documentation

◆ ~RNTupleWriteOptions()

virtual ROOT::Experimental::RNTupleWriteOptions::~RNTupleWriteOptions ( )
virtualdefault

Member Function Documentation

◆ Clone()

virtual std::unique_ptr< RNTupleWriteOptions > ROOT::Experimental::RNTupleWriteOptions::Clone ( ) const
inlinevirtual

Reimplemented in ROOT::Experimental::RNTupleWriteOptionsDaos.

Definition at line 56 of file RNTupleOptions.hxx.

◆ GetCompression()

int ROOT::Experimental::RNTupleWriteOptions::GetCompression ( ) const
inline

Definition at line 59 of file RNTupleOptions.hxx.

◆ GetContainerFormat()

ENTupleContainerFormat ROOT::Experimental::RNTupleWriteOptions::GetContainerFormat ( ) const
inline

Definition at line 65 of file RNTupleOptions.hxx.

◆ GetNElementsPerPage()

NTupleSize_t ROOT::Experimental::RNTupleWriteOptions::GetNElementsPerPage ( ) const
inline

Definition at line 68 of file RNTupleOptions.hxx.

◆ GetNEntriesPerCluster()

NTupleSize_t ROOT::Experimental::RNTupleWriteOptions::GetNEntriesPerCluster ( ) const
inline

Definition at line 71 of file RNTupleOptions.hxx.

◆ GetUseBufferedWrite()

bool ROOT::Experimental::RNTupleWriteOptions::GetUseBufferedWrite ( ) const
inline

Definition at line 74 of file RNTupleOptions.hxx.

◆ SetCompression() [1/2]

void ROOT::Experimental::RNTupleWriteOptions::SetCompression ( int  val)
inline

Definition at line 60 of file RNTupleOptions.hxx.

◆ SetCompression() [2/2]

void ROOT::Experimental::RNTupleWriteOptions::SetCompression ( RCompressionSetting::EAlgorithm  algorithm,
int  compressionLevel 
)
inline

Definition at line 61 of file RNTupleOptions.hxx.

◆ SetContainerFormat()

void ROOT::Experimental::RNTupleWriteOptions::SetContainerFormat ( ENTupleContainerFormat  val)
inline

Definition at line 66 of file RNTupleOptions.hxx.

◆ SetNElementsPerPage()

void ROOT::Experimental::RNTupleWriteOptions::SetNElementsPerPage ( NTupleSize_t  val)
inline

Definition at line 69 of file RNTupleOptions.hxx.

◆ SetNEntriesPerCluster()

void ROOT::Experimental::RNTupleWriteOptions::SetNEntriesPerCluster ( NTupleSize_t  val)
inline

Definition at line 72 of file RNTupleOptions.hxx.

◆ SetUseBufferedWrite()

void ROOT::Experimental::RNTupleWriteOptions::SetUseBufferedWrite ( bool  val)
inline

Definition at line 75 of file RNTupleOptions.hxx.

Member Data Documentation

◆ fCompression

int ROOT::Experimental::RNTupleWriteOptions::fCompression {RCompressionSetting::EDefaults::kUseAnalysis}
private

Definition at line 48 of file RNTupleOptions.hxx.

◆ fContainerFormat

ENTupleContainerFormat ROOT::Experimental::RNTupleWriteOptions::fContainerFormat {ENTupleContainerFormat::kTFile}
private

Definition at line 49 of file RNTupleOptions.hxx.

◆ fNElementsPerPage

NTupleSize_t ROOT::Experimental::RNTupleWriteOptions::fNElementsPerPage = 10000
private

Definition at line 51 of file RNTupleOptions.hxx.

◆ fNEntriesPerCluster

NTupleSize_t ROOT::Experimental::RNTupleWriteOptions::fNEntriesPerCluster = 64000
private

Definition at line 50 of file RNTupleOptions.hxx.

◆ fUseBufferedWrite

bool ROOT::Experimental::RNTupleWriteOptions::fUseBufferedWrite = true
private

Definition at line 52 of file RNTupleOptions.hxx.


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