Jpp
Public Member Functions | Protected Attributes | Private Attributes | List of all members
JROOT::JTreeWriter< T > Class Template Reference

Auxiliary class for template TTree writing. More...

#include <JTreeWriter.hh>

Inheritance diagram for JROOT::JTreeWriter< T >:
JROOT::JTreeParameters JROOT::JTreeCopyWriter< T >

Public Member Functions

 JTreeWriter (const JTreeParameters &parameters=JROOT::getTreeParameters< T >())
 Constructor. More...
 
const TBranch * GetBranch () const
 Get the pointer to the unique TBranch belonging this TTree. More...
 
Int_t Write (const T &object)
 Data object output equivalent of TTree::Fill(). More...
 
const JTreeParametersgetTreeParameters () const
 Get TTree parameters. More...
 
const TString & getTreeName () const
 Get TTree name. More...
 
const TString & getTreeTitle () const
 Get TTree title. More...
 
const TString & getBranchName () const
 Get TBranch name. More...
 
int getCompressionLevel () const
 Get compression level. More...
 
int getBasketSize () const
 Get basket size. More...
 
int getSplitLevel () const
 Get split level. More...
 

Protected Attributes

TString treeName
 TTree name. More...
 
TString treeTitle
 TTree title. More...
 
TString branchName
 TBranch name. More...
 
int compressionLevel
 TBranch compression level. More...
 
int basketSize
 TBranch basket size. More...
 
int splitLevel
 TBranch split level. More...
 

Private Attributes

TBranch * branch
 Pointer to unique branch belonging to this TTree. More...
 
const T * address
 Pointer to unique object belonging to this TTree. More...
 

Detailed Description

template<class T>
class JROOT::JTreeWriter< T >

Auxiliary class for template TTree writing.

Definition at line 28 of file JTreeWriter.hh.

Constructor & Destructor Documentation

◆ JTreeWriter()

template<class T>
JROOT::JTreeWriter< T >::JTreeWriter ( const JTreeParameters parameters = JROOT::getTreeParameters<T>())
inline

Constructor.

Note that the default TTree parameters are obtained using method JROOT::getTreeParameters.

Parameters
parametersparameters of TTree

Definition at line 40 of file JTreeWriter.hh.

40  :
41  JTreeParameters(parameters),
42  address(NULL)
43  {
44  SetNameTitle(this->getTreeName(), this->getTreeTitle());
45 
46  branch = Branch(this->getBranchName(),
47  T::Class_Name(),
48  &address,
49  this->getBasketSize(),
50  this->getSplitLevel());
51 
52  branch->SetCompressionLevel(this->getCompressionLevel());
53  }

Member Function Documentation

◆ GetBranch()

template<class T>
const TBranch* JROOT::JTreeWriter< T >::GetBranch ( ) const
inline

Get the pointer to the unique TBranch belonging this TTree.

Returns
pointer to TBranch

Definition at line 61 of file JTreeWriter.hh.

62  {
63  return branch;
64  }

◆ Write()

template<class T>
Int_t JROOT::JTreeWriter< T >::Write ( const T &  object)
inline

Data object output equivalent of TTree::Fill().

Parameters
objectdata object
Returns
as TTree::Fill

Definition at line 73 of file JTreeWriter.hh.

74  {
75  address = &object;
76 
77  return this->Fill();
78  }

◆ getTreeParameters()

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

Get TTree parameters.

Returns
TTree parameters

Definition at line 60 of file JTreeParameters.hh.

61  {
62  return static_cast<const JTreeParameters&>(*this);
63  }

◆ getTreeName()

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

Get TTree name.

Returns
TTree name

Definition at line 71 of file JTreeParameters.hh.

72  {
73  return treeName;
74  }

◆ getTreeTitle()

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

Get TTree title.

Returns
TTree title

Definition at line 82 of file JTreeParameters.hh.

83  {
84  return treeTitle;
85  }

◆ getBranchName()

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

Get TBranch name.

Returns
TBranch name

Definition at line 93 of file JTreeParameters.hh.

94  {
95  return (branchName != "" ? branchName : treeName);
96  }

◆ getCompressionLevel()

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

Get compression level.

Returns
compression level

Definition at line 104 of file JTreeParameters.hh.

105  {
106  return compressionLevel;
107  }

◆ getBasketSize()

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

Get basket size.

Returns
basket size

Definition at line 115 of file JTreeParameters.hh.

116  {
117  return basketSize;
118  }

◆ getSplitLevel()

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

Get split level.

Returns
split level

Definition at line 126 of file JTreeParameters.hh.

127  {
128  return splitLevel;
129  }

Member Data Documentation

◆ branch

template<class T>
TBranch* JROOT::JTreeWriter< T >::branch
private

Pointer to unique branch belonging to this TTree.

Definition at line 82 of file JTreeWriter.hh.

◆ address

template<class T>
const T* JROOT::JTreeWriter< T >::address
private

Pointer to unique object belonging to this TTree.

Definition at line 83 of file JTreeWriter.hh.

◆ treeName

TString JROOT::JTreeParameters::treeName
protectedinherited

TTree name.

Definition at line 133 of file JTreeParameters.hh.

◆ treeTitle

TString JROOT::JTreeParameters::treeTitle
protectedinherited

TTree title.

Definition at line 134 of file JTreeParameters.hh.

◆ branchName

TString JROOT::JTreeParameters::branchName
protectedinherited

TBranch name.

Definition at line 135 of file JTreeParameters.hh.

◆ compressionLevel

int JROOT::JTreeParameters::compressionLevel
protectedinherited

TBranch compression level.

Definition at line 136 of file JTreeParameters.hh.

◆ basketSize

int JROOT::JTreeParameters::basketSize
protectedinherited

TBranch basket size.

Definition at line 137 of file JTreeParameters.hh.

◆ splitLevel

int JROOT::JTreeParameters::splitLevel
protectedinherited

TBranch split level.

Definition at line 138 of file JTreeParameters.hh.


The documentation for this class was generated from the following file:
JROOT::JTreeParameters::getTreeName
const TString & getTreeName() const
Get TTree name.
Definition: JTreeParameters.hh:71
JROOT::JTreeParameters::treeName
TString treeName
TTree name.
Definition: JTreeParameters.hh:133
JROOT::JTreeParameters::JTreeParameters
JTreeParameters(const TString &treeName, const TString &treeTitle, const TString &branchName="", const int compressionLevel=1, const int basketSize=65536, const int splitLevel=1)
Constructor.
Definition: JTreeParameters.hh:38
JROOT::JTreeParameters::splitLevel
int splitLevel
TBranch split level.
Definition: JTreeParameters.hh:138
JROOT::JTreeParameters::basketSize
int basketSize
TBranch basket size.
Definition: JTreeParameters.hh:137
JROOT::JTreeParameters::treeTitle
TString treeTitle
TTree title.
Definition: JTreeParameters.hh:134
JROOT::JTreeParameters::getBranchName
const TString & getBranchName() const
Get TBranch name.
Definition: JTreeParameters.hh:93
JROOT::JTreeParameters::getSplitLevel
int getSplitLevel() const
Get split level.
Definition: JTreeParameters.hh:126
JROOT::JTreeParameters::branchName
TString branchName
TBranch name.
Definition: JTreeParameters.hh:135
JROOT::JTreeParameters::getCompressionLevel
int getCompressionLevel() const
Get compression level.
Definition: JTreeParameters.hh:104
JROOT::JTreeParameters::getTreeTitle
const TString & getTreeTitle() const
Get TTree title.
Definition: JTreeParameters.hh:82
JROOT::JTreeParameters::getBasketSize
int getBasketSize() const
Get basket size.
Definition: JTreeParameters.hh:115
JROOT::JTreeWriter::branch
TBranch * branch
Pointer to unique branch belonging to this TTree.
Definition: JTreeWriter.hh:82
JROOT::JTreeParameters::compressionLevel
int compressionLevel
TBranch compression level.
Definition: JTreeParameters.hh:136
JROOT::JTreeWriter::address
const T * address
Pointer to unique object belonging to this TTree.
Definition: JTreeWriter.hh:83