Logo ROOT  
Reference Guide
RSnapshotOptions.hxx
Go to the documentation of this file.
1// Author: Guilherme Amadio, Enrico Guiraud, Danilo Piparo CERN 2/2018
2
3/*************************************************************************
4 * Copyright (C) 1995-2018, Rene Brun and Fons Rademakers. *
5 * All rights reserved. *
6 * *
7 * For the licensing terms see $ROOTSYS/LICENSE. *
8 * For the list of contributors see $ROOTSYS/README/CREDITS. *
9 *************************************************************************/
10
11#ifndef ROOT_RSNAPSHOTOPTIONS
12#define ROOT_RSNAPSHOTOPTIONS
13
14#include <Compression.h>
15#include <ROOT/RStringView.hxx>
16#include <string>
17
18namespace ROOT {
19
20namespace RDF {
21/// A collection of options to steer the creation of the dataset on file
24 RSnapshotOptions() = default;
27 RSnapshotOptions(std::string_view mode, ECAlgo comprAlgo, int comprLevel, int autoFlush, int splitLevel, bool lazy,
28 bool overwriteIfExists = false)
29 : fMode(mode), fCompressionAlgorithm(comprAlgo), fCompressionLevel{comprLevel}, fAutoFlush(autoFlush),
30 fSplitLevel(splitLevel), fLazy(lazy), fOverwriteIfExists(overwriteIfExists)
31 {
32 }
33 std::string fMode = "RECREATE"; ///< Mode of creation of output file
34 ECAlgo fCompressionAlgorithm = ROOT::kZLIB; ///< Compression algorithm of output file
35 int fCompressionLevel = 1; ///< Compression level of output file
36 int fAutoFlush = 0; ///< AutoFlush value for output tree
37 int fSplitLevel = 99; ///< Split level of output tree
38 bool fLazy = false; ///< Do not start the event loop when Snapshot is called
39 bool fOverwriteIfExists = false; ///< If fMode is "UPDATE", overwrite object in output file if it already exists
40};
41} // ns RDF
42} // ns ROOT
43
44#endif
basic_string_view< char > string_view
tbb::task_arena is an alias of tbb::interface7::task_arena, which doesn't allow to forward declare tb...
ECompressionAlgorithm
Definition: Compression.h:105
@ kZLIB
Deprecated name, do not use:
Definition: Compression.h:111
A collection of options to steer the creation of the dataset on file.
int fAutoFlush
AutoFlush value for output tree.
std::string fMode
Mode of creation of output file.
RSnapshotOptions(const RSnapshotOptions &)=default
ECAlgo fCompressionAlgorithm
Compression algorithm of output file.
int fSplitLevel
Split level of output tree.
RSnapshotOptions(RSnapshotOptions &&)=default
bool fLazy
Do not start the event loop when Snapshot is called.
int fCompressionLevel
Compression level of output file.
bool fOverwriteIfExists
If fMode is "UPDATE", overwrite object in output file if it already exists.
RSnapshotOptions(std::string_view mode, ECAlgo comprAlgo, int comprLevel, int autoFlush, int splitLevel, bool lazy, bool overwriteIfExists=false)