Logo ROOT  
Reference Guide
ROOT::Experimental::RNTupleWriteOptionsDaos Class Reference

DAOS-specific user-tunable settings for storing ntuples.

Definition at line 98 of file RNTupleOptions.hxx.

Public Member Functions

 ~RNTupleWriteOptionsDaos () override=default
 
std::unique_ptr< RNTupleWriteOptionsClone () const override
 
uint32_t GetMaxCageSize () const
 
const std::string & GetObjectClass () const
 
void SetMaxCageSize (uint32_t cageSz)
 Set the upper bound for page concatenation into cages, in bytes. More...
 
void SetObjectClass (const std::string &val)
 Set the object class used to generate OIDs that relate to user data. More...
 
- Public Member Functions inherited from ROOT::Experimental::RNTupleWriteOptions
virtual ~RNTupleWriteOptions ()=default
 
virtual std::unique_ptr< RNTupleWriteOptionsClone () const
 
std::size_t GetApproxUnzippedPageSize () const
 
std::size_t GetApproxZippedClusterSize () const
 
int GetCompression () const
 
ENTupleContainerFormat GetContainerFormat () const
 
std::size_t GetMaxUnzippedClusterSize () const
 
bool GetUseBufferedWrite () const
 
void SetApproxUnzippedPageSize (std::size_t val)
 
void SetApproxZippedClusterSize (std::size_t val)
 
void SetCompression (int val)
 
void SetCompression (RCompressionSetting::EAlgorithm::EValues algorithm, int compressionLevel)
 
void SetContainerFormat (ENTupleContainerFormat val)
 
void SetMaxUnzippedClusterSize (std::size_t val)
 
void SetUseBufferedWrite (bool val)
 

Private Attributes

uint32_t fMaxCageSize = 16 * RNTupleWriteOptions::fApproxUnzippedPageSize
 The maximum cage size is set to the equivalent of 16 uncompressed pages - 1MiB by default. More...
 
std::string fObjectClass {"SX"}
 

Additional Inherited Members

- Protected Attributes inherited from ROOT::Experimental::RNTupleWriteOptions
std::size_t fApproxUnzippedPageSize = 64 * 1024
 Should be just large enough so that the compression ratio does not benefit much more from larger pages. More...
 
std::size_t fApproxZippedClusterSize = 50 * 1000 * 1000
 Approximation of the target compressed cluster size. More...
 
int fCompression {RCompressionSetting::EDefaults::kUseAnalysis}
 
ENTupleContainerFormat fContainerFormat {ENTupleContainerFormat::kTFile}
 
std::size_t fMaxUnzippedClusterSize = 512 * 1024 * 1024
 Memory limit for committing a cluster: with very high compression ratio, we need a limit on how large the I/O buffer can grow during writing. More...
 
bool fUseBufferedWrite = true
 

#include <ROOT/RNTupleOptions.hxx>

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

Constructor & Destructor Documentation

◆ ~RNTupleWriteOptionsDaos()

ROOT::Experimental::RNTupleWriteOptionsDaos::~RNTupleWriteOptionsDaos ( )
overridedefault

Member Function Documentation

◆ Clone()

std::unique_ptr< RNTupleWriteOptions > ROOT::Experimental::RNTupleWriteOptionsDaos::Clone ( ) const
inlineoverridevirtual

Reimplemented from ROOT::Experimental::RNTupleWriteOptions.

Definition at line 107 of file RNTupleOptions.hxx.

◆ GetMaxCageSize()

uint32_t ROOT::Experimental::RNTupleWriteOptionsDaos::GetMaxCageSize ( ) const
inline

Definition at line 116 of file RNTupleOptions.hxx.

◆ GetObjectClass()

const std::string & ROOT::Experimental::RNTupleWriteOptionsDaos::GetObjectClass ( ) const
inline

Definition at line 110 of file RNTupleOptions.hxx.

◆ SetMaxCageSize()

void ROOT::Experimental::RNTupleWriteOptionsDaos::SetMaxCageSize ( uint32_t  cageSz)
inline

Set the upper bound for page concatenation into cages, in bytes.

It is assumed that cage size will be no smaller than the approximate uncompressed page size. To disable page concatenation, set this value to 0.

Definition at line 120 of file RNTupleOptions.hxx.

◆ SetObjectClass()

void ROOT::Experimental::RNTupleWriteOptionsDaos::SetObjectClass ( const std::string &  val)
inline

Set the object class used to generate OIDs that relate to user data.

Any OC_xxx constant defined in daos_obj_class.h may be used here without the OC_ prefix.

Definition at line 114 of file RNTupleOptions.hxx.

Member Data Documentation

◆ fMaxCageSize

uint32_t ROOT::Experimental::RNTupleWriteOptionsDaos::fMaxCageSize = 16 * RNTupleWriteOptions::fApproxUnzippedPageSize
private

The maximum cage size is set to the equivalent of 16 uncompressed pages - 1MiB by default.

Empirically, such a cage size yields acceptable results in throughput and page granularity for most use cases. A fMaxCageSize of 0 disables the caging mechanism.

Definition at line 103 of file RNTupleOptions.hxx.

◆ fObjectClass

std::string ROOT::Experimental::RNTupleWriteOptionsDaos::fObjectClass {"SX"}
private

Definition at line 99 of file RNTupleOptions.hxx.

Libraries for ROOT::Experimental::RNTupleWriteOptionsDaos:
[legend]

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