Logo ROOT  
Reference Guide
RNTupleOptions.hxx
Go to the documentation of this file.
1 /// \file ROOT/RNTupleOptions.hxx
2 /// \ingroup NTuple ROOT7
3 /// \author Jakob Blomer <jblomer@cern.ch>
4 /// \date 2019-08-25
5 /// \warning This is part of the ROOT 7 prototype! It will change without notice. It might trigger earthquakes. Feedback
6 /// is welcome!
7 
8 /*************************************************************************
9  * Copyright (C) 1995-2019, Rene Brun and Fons Rademakers. *
10  * All rights reserved. *
11  * *
12  * For the licensing terms see $ROOTSYS/LICENSE. *
13  * For the list of contributors see $ROOTSYS/README/CREDITS. *
14  *************************************************************************/
15 
16 #ifndef ROOT7_RNTupleOptions
17 #define ROOT7_RNTupleOptions
18 
19 #include <Compression.h>
20 
21 namespace ROOT {
22 namespace Experimental {
23 
24 // clang-format off
25 /**
26 \class ROOT::Experimental::ENTupleContainerFormat
27 \ingroup NTuple
28 \brief Describes the options for wrapping RNTuple data in files
29 */
30 // clang-format on
32  kTFile, // ROOT TFile
33  kBare, // A thin envelope supporting a single RNTuple only
34 };
35 
36 
37 // clang-format off
38 /**
39 \class ROOT::Experimental::RNTupleWriteOptions
40 \ingroup NTuple
41 \brief Common user-tunable settings for storing ntuples
42 
43 All page sink classes need to support the common options.
44 */
45 // clang-format on
49 
50 public:
51  int GetCompression() const { return fCompression; }
52  void SetCompression(int val) { fCompression = val; }
53  void SetCompression(RCompressionSetting::EAlgorithm algorithm, int compressionLevel) {
54  fCompression = CompressionSettings(algorithm, compressionLevel);
55  }
56 
59 };
60 
61 
62 // clang-format off
63 /**
64 \class ROOT::Experimental::RNTupleReadOptions
65 \ingroup NTuple
66 \brief Common user-tunable settings for reading ntuples
67 
68 All page source classes need to support the common options.
69 */
70 // clang-format on
72 public:
75  kOn,
77  };
78 
79 private:
81 
82 public:
85 };
86 
87 } // namespace Experimental
88 } // namespace ROOT
89 
90 #endif
ROOT::Experimental::RNTupleWriteOptions
Common user-tunable settings for storing ntuples.
Definition: RNTupleOptions.hxx:46
ROOT::Experimental::RNTupleWriteOptions::SetContainerFormat
void SetContainerFormat(ENTupleContainerFormat val)
Definition: RNTupleOptions.hxx:58
ROOT::Experimental::RNTupleReadOptions::kDefault
@ kDefault
Definition: RNTupleOptions.hxx:76
ROOT::Experimental::ENTupleContainerFormat::kTFile
@ kTFile
Compression.h
ROOT::Experimental::RNTupleReadOptions::SetClusterCache
void SetClusterCache(EClusterCache val)
Definition: RNTupleOptions.hxx:84
ROOT::Experimental::RNTupleWriteOptions::SetCompression
void SetCompression(RCompressionSetting::EAlgorithm algorithm, int compressionLevel)
Definition: RNTupleOptions.hxx:53
ROOT::Experimental::RNTupleReadOptions
Common user-tunable settings for reading ntuples.
Definition: RNTupleOptions.hxx:71
ROOT::Experimental::RNTupleWriteOptions::fContainerFormat
ENTupleContainerFormat fContainerFormat
Definition: RNTupleOptions.hxx:48
ROOT::Experimental::RNTupleWriteOptions::fCompression
int fCompression
Definition: RNTupleOptions.hxx:47
ROOT::RCompressionSetting::EDefaults::kUseAnalysis
@ kUseAnalysis
Use the default analysis setting; fast reading but poor compression ratio.
Definition: Compression.h:52
ROOT::RCompressionSetting::EAlgorithm
Definition: Compression.h:81
ROOT::Experimental::RNTupleReadOptions::kOff
@ kOff
Definition: RNTupleOptions.hxx:74
ROOT::Experimental::ENTupleContainerFormat
ENTupleContainerFormat
Definition: RNTupleOptions.hxx:31
ROOT::Experimental::RNTupleReadOptions::fClusterCache
EClusterCache fClusterCache
Definition: RNTupleOptions.hxx:80
ROOT::Experimental::ENTupleContainerFormat::kBare
@ kBare
ROOT::Experimental::RNTupleWriteOptions::SetCompression
void SetCompression(int val)
Definition: RNTupleOptions.hxx:52
ROOT::CompressionSettings
int CompressionSettings(RCompressionSetting::EAlgorithm algorithm, int compressionLevel)
ROOT::Experimental::RNTupleWriteOptions::GetContainerFormat
ENTupleContainerFormat GetContainerFormat() const
Definition: RNTupleOptions.hxx:57
ROOT::Experimental::RNTupleWriteOptions::GetCompression
int GetCompression() const
Definition: RNTupleOptions.hxx:51
kDefault
@ kDefault
Definition: TSystem.h:229
ROOT::Experimental::RNTupleReadOptions::kOn
@ kOn
Definition: RNTupleOptions.hxx:75
ROOT
tbb::task_arena is an alias of tbb::interface7::task_arena, which doesn't allow to forward declare tb...
Definition: EExecutionPolicy.hxx:4
ROOT::Experimental::RNTupleReadOptions::GetClusterCache
EClusterCache GetClusterCache() const
Definition: RNTupleOptions.hxx:83
ROOT::Experimental::RNTupleReadOptions::EClusterCache
EClusterCache
Definition: RNTupleOptions.hxx:73