Jpp 21.0.0-rc.1-88-g0130508c4
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::JTreeParameters_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 Member Functions

 JTreeParameters ()
 Default constructor.
 

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::istream & operator>> (std::istream &in, JTreeParameters &object)
 Read TTree parameters from input.
 
std::ostream & operator<< (std::ostream &out, const JTreeParameters &object)
 Write TTree parameters to output.
 

Detailed Description

Data structure for TTree parameters.

Definition at line 31 of file JTreeParameters.hh.

Constructor & Destructor Documentation

◆ JTreeParameters() [1/2]

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 44 of file JTreeParameters.hh.

52 {
53 this->treeName = treeName;
54 this->treeTitle = treeTitle;
55 this->branchName = branchName;
57 this->basketSize = basketSize;
58 this->splitLevel = splitLevel;
59 this->autoFlush = autoFlush;
60 }
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.

◆ JTreeParameters() [2/2]

JROOT::JTreeParameters::JTreeParameters ( )
inlineprotected

Default constructor.

Definition at line 239 of file JTreeParameters.hh.

240 {}

Member Function Documentation

◆ getTreeParameters()

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

Get TTree parameters.

Returns
TTree parameters

Definition at line 68 of file JTreeParameters.hh.

69 {
70 return static_cast<const JTreeParameters&>(*this);
71 }
JTreeParameters()
Default constructor.

◆ getTreeName()

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

Get TTree name.

Returns
TTree name

Definition at line 79 of file JTreeParameters.hh.

80 {
81 return treeName;
82 }

◆ getTreeTitle()

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

Get TTree title.

Returns
TTree title

Definition at line 90 of file JTreeParameters.hh.

91 {
92 return treeTitle;
93 }

◆ getBranchName()

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

Get TBranch name.

Returns
TBranch name

Definition at line 101 of file JTreeParameters.hh.

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

◆ getCompressionLevel()

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

Get compression level.

Returns
compression level

Definition at line 112 of file JTreeParameters.hh.

113 {
114 return compressionLevel;
115 }

◆ setCompressionLevel()

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

Set compression level.

Parameters
valuecompression level

Definition at line 123 of file JTreeParameters.hh.

124 {
125 compressionLevel = value;
126 }

◆ getBasketSize()

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

Get basket size.

Returns
basket size

Definition at line 134 of file JTreeParameters.hh.

135 {
136 return basketSize;
137 }

◆ setBasketSize()

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

Set basket size.

Parameters
valuebasket size

Definition at line 145 of file JTreeParameters.hh.

146 {
147 basketSize = value;
148 }

◆ getSplitLevel()

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

Get split level.

Returns
split level

Definition at line 156 of file JTreeParameters.hh.

157 {
158 return splitLevel;
159 }

◆ setSplitLevel()

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

Set split level.

Parameters
valuesplit level

Definition at line 167 of file JTreeParameters.hh.

168 {
169 splitLevel = value;
170 }

◆ getAutoFlush()

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

Get auto flush.

Returns
auto flush

Definition at line 178 of file JTreeParameters.hh.

179 {
180 return autoFlush;
181 }

◆ setAutoFlush()

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

Set auto flush.

Parameters
valueauto flush

Definition at line 189 of file JTreeParameters.hh.

190 {
191 autoFlush = value;
192 }

Friends And Related Symbol Documentation

◆ operator>>

std::istream & operator>> ( std::istream & in,
JTreeParameters & object )
friend

Read TTree parameters from input.

Parameters
ininput stream
objectTTree parameters
Returns
input stream

Definition at line 202 of file JTreeParameters.hh.

203 {
204 using namespace std;
205
206 object.treeName .ReadToken(in);
207 object.branchName.ReadToken(in);
208
209 return in >> object.compressionLevel
210 >> object.basketSize
211 >> object.splitLevel
212 >> object.autoFlush;
213 }

◆ 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 222 of file JTreeParameters.hh.

223 {
224 using namespace std;
225
226 return out << setw(24) << left << object.getTreeName() << right << ' '
227 << setw(24) << left << object.getBranchName() << right << ' '
228 << setw(1) << object.getCompressionLevel() << ' '
229 << setw(10) << object.getBasketSize() << ' '
230 << setw(2) << object.getSplitLevel() << ' '
231 << setw(8) << object.getAutoFlush();
232 }

Member Data Documentation

◆ treeName

TString JROOT::JTreeParameters::treeName
protected

TTree name.

Definition at line 243 of file JTreeParameters.hh.

◆ treeTitle

TString JROOT::JTreeParameters::treeTitle
protected

TTree title.

Definition at line 244 of file JTreeParameters.hh.

◆ branchName

TString JROOT::JTreeParameters::branchName
protected

TBranch name.

Definition at line 245 of file JTreeParameters.hh.

◆ compressionLevel

int JROOT::JTreeParameters::compressionLevel
protected

TBranch compression level.

Definition at line 246 of file JTreeParameters.hh.

◆ basketSize

int JROOT::JTreeParameters::basketSize
protected

TBranch basket size.

Definition at line 247 of file JTreeParameters.hh.

◆ splitLevel

int JROOT::JTreeParameters::splitLevel
protected

TBranch split level.

Definition at line 248 of file JTreeParameters.hh.

◆ autoFlush

Long64_t JROOT::JTreeParameters::autoFlush
protected

TTree auto flush.

Definition at line 249 of file JTreeParameters.hh.


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