Logo ROOT  
Reference Guide
 
Loading...
Searching...
No Matches
ROOT::RDF::RSnapshotOptions Struct Reference

A collection of options to steer the creation of the dataset on file.

Definition at line 22 of file RSnapshotOptions.hxx.

Public Types

using ECAlgo = ROOT::ECompressionAlgorithm
 

Public Member Functions

 RSnapshotOptions ()=default
 
 RSnapshotOptions (const RSnapshotOptions &)=default
 
 RSnapshotOptions (RSnapshotOptions &&)=default
 
 RSnapshotOptions (std::string_view mode, ECAlgo comprAlgo, int comprLevel, int autoFlush, int splitLevel, bool lazy, bool overwriteIfExists=false)
 

Public Attributes

int fAutoFlush = 0
 AutoFlush value for output tree.
 
ECAlgo fCompressionAlgorithm = ROOT::kZLIB
 Compression algorithm of output file.
 
int fCompressionLevel = 1
 Compression level of output file.
 
bool fLazy = false
 Do not start the event loop when Snapshot is called.
 
std::string fMode = "RECREATE"
 Mode of creation of output file.
 
bool fOverwriteIfExists = false
 If fMode is "UPDATE", overwrite object in output file if it already exists.
 
int fSplitLevel = 99
 Split level of output tree.
 

#include <ROOT/RSnapshotOptions.hxx>

Member Typedef Documentation

◆ ECAlgo

Constructor & Destructor Documentation

◆ RSnapshotOptions() [1/4]

ROOT::RDF::RSnapshotOptions::RSnapshotOptions ( )
default

◆ RSnapshotOptions() [2/4]

ROOT::RDF::RSnapshotOptions::RSnapshotOptions ( const RSnapshotOptions )
default

◆ RSnapshotOptions() [3/4]

ROOT::RDF::RSnapshotOptions::RSnapshotOptions ( RSnapshotOptions &&  )
default

◆ RSnapshotOptions() [4/4]

ROOT::RDF::RSnapshotOptions::RSnapshotOptions ( std::string_view  mode,
ECAlgo  comprAlgo,
int  comprLevel,
int  autoFlush,
int  splitLevel,
bool  lazy,
bool  overwriteIfExists = false 
)
inline

Definition at line 27 of file RSnapshotOptions.hxx.

Member Data Documentation

◆ fAutoFlush

int ROOT::RDF::RSnapshotOptions::fAutoFlush = 0

AutoFlush value for output tree.

Definition at line 36 of file RSnapshotOptions.hxx.

◆ fCompressionAlgorithm

ECAlgo ROOT::RDF::RSnapshotOptions::fCompressionAlgorithm = ROOT::kZLIB

Compression algorithm of output file.

Definition at line 34 of file RSnapshotOptions.hxx.

◆ fCompressionLevel

int ROOT::RDF::RSnapshotOptions::fCompressionLevel = 1

Compression level of output file.

Definition at line 35 of file RSnapshotOptions.hxx.

◆ fLazy

bool ROOT::RDF::RSnapshotOptions::fLazy = false

Do not start the event loop when Snapshot is called.

Definition at line 38 of file RSnapshotOptions.hxx.

◆ fMode

std::string ROOT::RDF::RSnapshotOptions::fMode = "RECREATE"

Mode of creation of output file.

Definition at line 33 of file RSnapshotOptions.hxx.

◆ fOverwriteIfExists

bool ROOT::RDF::RSnapshotOptions::fOverwriteIfExists = false

If fMode is "UPDATE", overwrite object in output file if it already exists.

Definition at line 39 of file RSnapshotOptions.hxx.

◆ fSplitLevel

int ROOT::RDF::RSnapshotOptions::fSplitLevel = 99

Split level of output tree.

Definition at line 37 of file RSnapshotOptions.hxx.

Collaboration diagram for ROOT::RDF::RSnapshotOptions:
[legend]

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