Jpp 19.3.0-rc.2
the software that should make you happy
Loading...
Searching...
No Matches
JROOT::JTreeParameters Class Reference

Data structure for TTree parameters. More...

#include <JTreeParameters.hh>

Inheritance diagram for JROOT::JTreeParameters:
JROOT::JChainReader< JDerived_t > JROOT::JTreeWriter< JHead_t, JROOT::JRootCreateFlatTree< JHead_t >::value > JROOT::JTreeWriter< JTail_t, JROOT::JRootCreateFlatTree< JTail_t >::value > JROOT::JTreeWriter< JDAQTimesliceTypes_t, JROOT::JRootCreateFlatTree< JDAQTimesliceTypes_t >::value > JROOT::JTreeWriter< T, JROOT::JRootCreateFlatTree< T >::value > JROOT::JChainReader< T > JROOT::JTreeReader< T > JROOT::JTreeWriter< T, flat >

Public Member Functions

 JTreeParameters (const TString &treeName, const TString &treeTitle, const TString &branchName="", const int compressionLevel=1, const int basketSize=65536, const int splitLevel=1, const Long64_t autoFlush=5000)
 Constructor.
 
const JTreeParametersgetTreeParameters () const
 Get TTree parameters.
 
const TString & getTreeName () const
 Get TTree name.
 
const TString & getTreeTitle () const
 Get TTree title.
 
const TString & getBranchName () const
 Get TBranch name.
 
int getCompressionLevel () const
 Get compression level.
 
void setCompressionLevel (const int value)
 Set compression level.
 
int getBasketSize () const
 Get basket size.
 
void setBasketSize (int value)
 Set basket size.
 
int getSplitLevel () const
 Get split level.
 
void setSplitLevel (int value)
 Set split level.
 
Long64_t getAutoFlush () const
 Get auto flush.
 
void setAutoFlush (Long64_t value)
 Set auto flush.
 

Protected Attributes

TString treeName
 TTree name.
 
TString treeTitle
 TTree title.
 
TString branchName
 TBranch name.
 
int compressionLevel
 TBranch compression level.
 
int basketSize
 TBranch basket size.
 
int splitLevel
 TBranch split level.
 
Long64_t autoFlush
 TTree auto flush.
 

Friends

std::ostream & operator<< (std::ostream &out, const JTreeParameters &object)
 Write TTree parameters to output.
 

Detailed Description

Data structure for TTree parameters.

Definition at line 30 of file JTreeParameters.hh.

Constructor & Destructor Documentation

◆ JTreeParameters()

JROOT::JTreeParameters::JTreeParameters ( const TString & treeName,
const TString & treeTitle,
const TString & branchName = "",
const int compressionLevel = 1,
const int basketSize = 65536,
const int splitLevel = 1,
const Long64_t autoFlush = 5000 )
inline

Constructor.

Parameters
treeNameTTree name
treeTitleTTree title
branchNameTBranch name
compressionLevelTBranch compression level
basketSizeTBranch basket size
splitLevelTBranch split level
autoFlushTTree auto flush

Definition at line 43 of file JTreeParameters.hh.

51 {
52 this->treeName = treeName;
53 this->treeTitle = treeTitle;
54 this->branchName = branchName;
56 this->basketSize = basketSize;
57 this->splitLevel = splitLevel;
58 this->autoFlush = autoFlush;
59 }
int basketSize
TBranch basket size.
int splitLevel
TBranch split level.
TString branchName
TBranch name.
TString treeTitle
TTree title.
int compressionLevel
TBranch compression level.
Long64_t autoFlush
TTree auto flush.
TString treeName
TTree name.

Member Function Documentation

◆ getTreeParameters()

const JTreeParameters & JROOT::JTreeParameters::getTreeParameters ( ) const
inline

Get TTree parameters.

Returns
TTree parameters

Definition at line 67 of file JTreeParameters.hh.

68 {
69 return static_cast<const JTreeParameters&>(*this);
70 }
JTreeParameters(const TString &treeName, const TString &treeTitle, const TString &branchName="", const int compressionLevel=1, const int basketSize=65536, const int splitLevel=1, const Long64_t autoFlush=5000)
Constructor.

◆ getTreeName()

const TString & JROOT::JTreeParameters::getTreeName ( ) const
inline

Get TTree name.

Returns
TTree name

Definition at line 78 of file JTreeParameters.hh.

79 {
80 return treeName;
81 }

◆ getTreeTitle()

const TString & JROOT::JTreeParameters::getTreeTitle ( ) const
inline

Get TTree title.

Returns
TTree title

Definition at line 89 of file JTreeParameters.hh.

90 {
91 return treeTitle;
92 }

◆ getBranchName()

const TString & JROOT::JTreeParameters::getBranchName ( ) const
inline

Get TBranch name.

Returns
TBranch name

Definition at line 100 of file JTreeParameters.hh.

101 {
102 return (branchName != "" ? branchName : treeName);
103 }

◆ getCompressionLevel()

int JROOT::JTreeParameters::getCompressionLevel ( ) const
inline

Get compression level.

Returns
compression level

Definition at line 111 of file JTreeParameters.hh.

112 {
113 return compressionLevel;
114 }

◆ setCompressionLevel()

void JROOT::JTreeParameters::setCompressionLevel ( const int value)
inline

Set compression level.

Parameters
valuecompression level

Definition at line 122 of file JTreeParameters.hh.

123 {
124 compressionLevel = value;
125 }

◆ getBasketSize()

int JROOT::JTreeParameters::getBasketSize ( ) const
inline

Get basket size.

Returns
basket size

Definition at line 133 of file JTreeParameters.hh.

134 {
135 return basketSize;
136 }

◆ setBasketSize()

void JROOT::JTreeParameters::setBasketSize ( int value)
inline

Set basket size.

Parameters
valuebasket size

Definition at line 144 of file JTreeParameters.hh.

145 {
146 basketSize = value;
147 }

◆ getSplitLevel()

int JROOT::JTreeParameters::getSplitLevel ( ) const
inline

Get split level.

Returns
split level

Definition at line 155 of file JTreeParameters.hh.

156 {
157 return splitLevel;
158 }

◆ setSplitLevel()

void JROOT::JTreeParameters::setSplitLevel ( int value)
inline

Set split level.

Parameters
valuesplit level

Definition at line 166 of file JTreeParameters.hh.

167 {
168 splitLevel = value;
169 }

◆ getAutoFlush()

Long64_t JROOT::JTreeParameters::getAutoFlush ( ) const
inline

Get auto flush.

Returns
auto flush

Definition at line 177 of file JTreeParameters.hh.

178 {
179 return autoFlush;
180 }

◆ setAutoFlush()

void JROOT::JTreeParameters::setAutoFlush ( Long64_t value)
inline

Set auto flush.

Parameters
valueauto flush

Definition at line 188 of file JTreeParameters.hh.

189 {
190 autoFlush = value;
191 }

Friends And Related Symbol Documentation

◆ operator<<

std::ostream & operator<< ( std::ostream & out,
const JTreeParameters & object )
friend

Write TTree parameters to output.

Parameters
outoutput stream
objectTTree parameters
Returns
output stream

Definition at line 201 of file JTreeParameters.hh.

202 {
203 using namespace std;
204
205 return out << setw(24) << left << object.getTreeName() << right << ' '
206 << setw(24) << left << object.getBranchName() << right << ' '
207 << setw(1) << object.getCompressionLevel() << ' '
208 << setw(10) << object.getBasketSize() << ' '
209 << setw(2) << object.getSplitLevel() << ' '
210 << setw(8) << object.getAutoFlush();
211 }

Member Data Documentation

◆ treeName

TString JROOT::JTreeParameters::treeName
protected

TTree name.

Definition at line 215 of file JTreeParameters.hh.

◆ treeTitle

TString JROOT::JTreeParameters::treeTitle
protected

TTree title.

Definition at line 216 of file JTreeParameters.hh.

◆ branchName

TString JROOT::JTreeParameters::branchName
protected

TBranch name.

Definition at line 217 of file JTreeParameters.hh.

◆ compressionLevel

int JROOT::JTreeParameters::compressionLevel
protected

TBranch compression level.

Definition at line 218 of file JTreeParameters.hh.

◆ basketSize

int JROOT::JTreeParameters::basketSize
protected

TBranch basket size.

Definition at line 219 of file JTreeParameters.hh.

◆ splitLevel

int JROOT::JTreeParameters::splitLevel
protected

TBranch split level.

Definition at line 220 of file JTreeParameters.hh.

◆ autoFlush

Long64_t JROOT::JTreeParameters::autoFlush
protected

TTree auto flush.

Definition at line 221 of file JTreeParameters.hh.


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