Skip to content
Snippets Groups Projects
Commit 205e2645 authored by Olivier Couet's avatar Olivier Couet
Browse files

- The class header is "C comments' style" : /** \class TClassName 

- The methods' header is "C++ comments' style"
- Only one blank line before the methods' headers
parent 8d52ac62
No related branches found
No related tags found
No related merge requests found
Hide whitespace changes
Inline Side-by-side
tree/tree/src/TChain.cxx
+ 11
− 85
View file @ 205e2645
......@@ -9,20 +9,18 @@
* For the list of contributors see $ROOTSYS/README/CREDITS. *
*************************************************************************/
////////////////////////////////////////////////////////////////////////////////
/// \class TChain
///
/// A chain is a collection of files containg TTree objects.
/// When the chain is created, the first parameter is the default name
/// for the Tree to be processed later on.
///
/// Enter a new element in the chain via the TChain::Add function.
/// Once a chain is defined, one can use the normal TTree functions
/// to Draw,Scan,etc.
///
/// Use TChain::SetBranchStatus to activate one or more branches for all
/// the trees in the chain.
/** \class TChain
A chain is a collection of files containg TTree objects.
When the chain is created, the first parameter is the default name
for the Tree to be processed later on.
Enter a new element in the chain via the TChain::Add function.
Once a chain is defined, one can use the normal TTree functions
to Draw,Scan,etc.
Use TChain::SetBranchStatus to activate one or more branches for all
the trees in the chain.
*/
#include "TChain.h"
......@@ -58,7 +56,6 @@ const Long64_t theBigNumber = Long64_t(1234567890)<<28;
ClassImp(TChain)
////////////////////////////////////////////////////////////////////////////////
/// Default constructor.
......@@ -95,7 +92,6 @@ TChain::TChain()
gROOT->GetListOfCleanups()->Add(this);
}
////////////////////////////////////////////////////////////////////////////////
/// Create a chain.
///
......@@ -171,7 +167,6 @@ TChain::TChain(const char* name, const char* title)
gROOT->GetListOfCleanups()->Add(this);
}
////////////////////////////////////////////////////////////////////////////////
/// Destructor.
......@@ -209,7 +204,6 @@ TChain::~TChain()
fDirectory = 0;
}
////////////////////////////////////////////////////////////////////////////////
/// Add all files referenced by the passed chain to this chain.
/// The function returns the total number of files connected.
......@@ -254,7 +248,6 @@ Int_t TChain::Add(TChain* chain)
return nf;
}
////////////////////////////////////////////////////////////////////////////////
/// Add a new file to this chain.
///
......@@ -384,7 +377,6 @@ Int_t TChain::Add(const char* name, Long64_t nentries /* = kBigNumber */)
return nf;
}
////////////////////////////////////////////////////////////////////////////////
/// Add a new file to this chain.
///
......@@ -531,7 +523,6 @@ Int_t TChain::AddFile(const char* name, Long64_t nentries /* = kBigNumber */, co
return 1;
}
////////////////////////////////////////////////////////////////////////////////
/// Add all files referenced in the list to the chain. The object type in the
/// list must be either TFileInfo or TObjString or TUrl .
......@@ -580,7 +571,6 @@ Int_t TChain::AddFileInfoList(TCollection* filelist, Long64_t nfiles /* = kBigNu
return 1;
}
////////////////////////////////////////////////////////////////////////////////
/// Add a TFriendElement to the list of friends of this chain.
///
......@@ -654,7 +644,6 @@ TFriendElement* TChain::AddFriend(const char* chain, const char* dummy /* = "" *
return fe;
}
////////////////////////////////////////////////////////////////////////////////
/// Add the whole chain or tree as a friend of this chain.
......@@ -682,7 +671,6 @@ TFriendElement* TChain::AddFriend(const char* chain, TFile* dummy)
return fe;
}
////////////////////////////////////////////////////////////////////////////////
/// Add the whole chain or tree as a friend of this chain.
......@@ -709,7 +697,6 @@ TFriendElement* TChain::AddFriend(TTree* chain, const char* alias, Bool_t /* war
return fe;
}
////////////////////////////////////////////////////////////////////////////////
/// Browse the contents of the chain.
......@@ -718,7 +705,6 @@ void TChain::Browse(TBrowser* b)
TTree::Browse(b);
}
////////////////////////////////////////////////////////////////////////////////
/// When closing a file during the chain processing, the file
/// may be closed with option "R" if flag is set to kTRUE.
......@@ -737,7 +723,6 @@ void TChain::CanDeleteRefs(Bool_t flag /* = kTRUE */)
fCanDeleteRefs = flag;
}
////////////////////////////////////////////////////////////////////////////////
/// Initialize the packet descriptor string.
......@@ -750,7 +735,6 @@ void TChain::CreatePackets()
}
}
////////////////////////////////////////////////////////////////////////////////
/// Override the TTree::DirectoryAutoAdd behavior:
/// we never auto add.
......@@ -759,7 +743,6 @@ void TChain::DirectoryAutoAdd(TDirectory * /* dir */)
{
}
////////////////////////////////////////////////////////////////////////////////
/// Draw expression varexp for selected entries.
/// Returns -1 in case of error or number of selected events in case of success.
......@@ -784,7 +767,6 @@ Long64_t TChain::Draw(const char* varexp, const TCut& selection,
return TChain::Draw(varexp, selection.GetTitle(), option, nentries, firstentry);
}
////////////////////////////////////////////////////////////////////////////////
/// Process all entries in this chain and draw histogram corresponding to
/// expression varexp.
......@@ -806,7 +788,6 @@ Long64_t TChain::Draw(const char* varexp, const char* selection,
return TTree::Draw(varexp,selection,option,nentries,firstentry);
}
////////////////////////////////////////////////////////////////////////////////
/// See TTree::GetReadEntry().
......@@ -828,7 +809,6 @@ TBranch* TChain::FindBranch(const char* branchname)
return 0;
}
////////////////////////////////////////////////////////////////////////////////
/// See TTree::GetReadEntry().
......@@ -850,7 +830,6 @@ TLeaf* TChain::FindLeaf(const char* searchname)
return 0;
}
////////////////////////////////////////////////////////////////////////////////
/// Returns the expanded value of the alias. Search in the friends if any.
......@@ -870,7 +849,6 @@ const char* TChain::GetAlias(const char* aliasName) const
return 0;
}
////////////////////////////////////////////////////////////////////////////////
/// Return pointer to the branch name in the current tree.
......@@ -892,7 +870,6 @@ TBranch* TChain::GetBranch(const char* name)
return 0;
}
////////////////////////////////////////////////////////////////////////////////
/// See TTree::GetReadEntry().
......@@ -908,7 +885,6 @@ Bool_t TChain::GetBranchStatus(const char* branchname) const
return TTree::GetBranchStatus(branchname);
}
////////////////////////////////////////////////////////////////////////////////
/// Return an iterator over the cluster of baskets starting at firstentry.
///
......@@ -920,7 +896,6 @@ TTree::TClusterIterator TChain::GetClusterIterator(Long64_t /* firstentry */)
return TTree::GetClusterIterator(-1);
}
////////////////////////////////////////////////////////////////////////////////
/// Return absolute entry number in the chain.
/// The input parameter entry is the entry number in
......@@ -931,7 +906,6 @@ Long64_t TChain::GetChainEntryNumber(Long64_t entry) const
return entry + fTreeOffset[fTreeNumber];
}
////////////////////////////////////////////////////////////////////////////////
/// Return the total number of entries in the chain.
/// In case the number of entries in each tree is not yet known,
......@@ -952,7 +926,6 @@ Long64_t TChain::GetEntries() const
return fEntries;
}
////////////////////////////////////////////////////////////////////////////////
/// Get entry from the file to memory.
///
......@@ -974,7 +947,6 @@ Int_t TChain::GetEntry(Long64_t entry, Int_t getall)
return fTree->GetEntry(treeReadEntry, getall);
}
////////////////////////////////////////////////////////////////////////////////
/// Return entry number corresponding to entry.
///
......@@ -1006,7 +978,6 @@ Long64_t TChain::GetEntryNumber(Long64_t entry) const
return entry;
}
////////////////////////////////////////////////////////////////////////////////
/// Return entry corresponding to major and minor number.
///
......@@ -1023,7 +994,6 @@ Int_t TChain::GetEntryWithIndex(Int_t major, Int_t minor)
return GetEntry(serial);
}
////////////////////////////////////////////////////////////////////////////////
/// Return a pointer to the current file.
/// If no file is connected, the first file is automatically loaded.
......@@ -1038,7 +1008,6 @@ TFile* TChain::GetFile() const
return fFile;
}
////////////////////////////////////////////////////////////////////////////////
/// Return a pointer to the leaf name in the current tree.
......@@ -1060,7 +1029,6 @@ TLeaf* TChain::GetLeaf(const char* branchname, const char *leafname)
return 0;
}
////////////////////////////////////////////////////////////////////////////////
/// Return a pointer to the leaf name in the current tree.
......@@ -1082,7 +1050,6 @@ TLeaf* TChain::GetLeaf(const char* name)
return 0;
}
////////////////////////////////////////////////////////////////////////////////
/// Return a pointer to the list of branches of the current tree.
///
......@@ -1109,7 +1076,6 @@ TObjArray* TChain::GetListOfBranches()
return 0;
}
////////////////////////////////////////////////////////////////////////////////
/// Return a pointer to the list of leaves of the current tree.
///
......@@ -1133,7 +1099,6 @@ TObjArray* TChain::GetListOfLeaves()
return 0;
}
////////////////////////////////////////////////////////////////////////////////
/// Return maximum of column with name columname.
......@@ -1151,7 +1116,6 @@ Double_t TChain::GetMaximum(const char* columname)
return theMax;
}
////////////////////////////////////////////////////////////////////////////////
/// Return minimum of column with name columname.
......@@ -1169,7 +1133,6 @@ Double_t TChain::GetMinimum(const char* columname)
return theMin;
}
////////////////////////////////////////////////////////////////////////////////
/// Return the number of branches of the current tree.
///
......@@ -1187,7 +1150,6 @@ Int_t TChain::GetNbranches()
return 0;
}
////////////////////////////////////////////////////////////////////////////////
/// See TTree::GetReadEntry().
......@@ -1203,7 +1165,6 @@ Long64_t TChain::GetReadEntry() const
return TTree::GetReadEntry();
}
////////////////////////////////////////////////////////////////////////////////
/// Return the chain weight.
///
......@@ -1229,7 +1190,6 @@ Double_t TChain::GetWeight() const
}
}
////////////////////////////////////////////////////////////////////////////////
/// Set the TTree to be reloaded as soon as possible. In particular this
/// is needed when adding a Friend.
......@@ -1254,7 +1214,6 @@ void TChain::InvalidateCurrentTree()
fTree = 0;
}
////////////////////////////////////////////////////////////////////////////////
/// Dummy function.
/// It could be implemented and load all baskets of all trees in the chain.
......@@ -1267,7 +1226,6 @@ Int_t TChain::LoadBaskets(Long64_t /*maxmemory*/)
return 0;
}
////////////////////////////////////////////////////////////////////////////////
/// Find the tree which contains entry, and set it as the current tree.
///
......@@ -1672,7 +1630,6 @@ Long64_t TChain::LoadTree(Long64_t entry)
return treeReadEntry;
}
////////////////////////////////////////////////////////////////////////////////
/// Check / locate the files in the chain.
/// By default only the files not yet looked up are checked.
......@@ -1745,7 +1702,6 @@ void TChain::Lookup(Bool_t force)
SafeDelete(stg);
}
////////////////////////////////////////////////////////////////////////////////
/// Loop on nentries of this chain starting at firstentry. (NOT IMPLEMENTED)
......@@ -1790,7 +1746,6 @@ void TChain::Loop(Option_t* option, Long64_t nentries, Long64_t firstentry)
#endif
}
////////////////////////////////////////////////////////////////////////////////
/// List the chain.
......@@ -1806,7 +1761,6 @@ void TChain::ls(Option_t* option) const
TROOT::DecreaseDirLevel();
}
////////////////////////////////////////////////////////////////////////////////
/// Merge all the entries in the chain into a new tree in a new file.
///
......@@ -1833,7 +1787,6 @@ Long64_t TChain::Merge(const char* name, Option_t* option)
return Merge(file, 0, option);
}
////////////////////////////////////////////////////////////////////////////////
/// Merge all chains in the collection. (NOT IMPLEMENTED)
......@@ -1843,7 +1796,6 @@ Long64_t TChain::Merge(TCollection* /* list */, Option_t* /* option */ )
return -1;
}
////////////////////////////////////////////////////////////////////////////////
/// Merge all chains in the collection. (NOT IMPLEMENTED)
......@@ -1853,7 +1805,6 @@ Long64_t TChain::Merge(TCollection* /* list */, TFileMergeInfo *)
return -1;
}
////////////////////////////////////////////////////////////////////////////////
/// Merge all the entries in the chain into a new tree in the current file.
///
......@@ -2054,7 +2005,6 @@ Long64_t TChain::Merge(TFile* file, Int_t basketsize, Option_t* option)
return nfiles;
}
////////////////////////////////////////////////////////////////////////////////
/// Get the tree url or filename and other information from the name
///
......@@ -2158,7 +2108,6 @@ void TChain::ParseTreeFilename(const char *name, TString &filename, TString &tre
}
}
////////////////////////////////////////////////////////////////////////////////
/// Print the header information of each tree in the chain.
/// See TTree::Print for a list of options.
......@@ -2180,7 +2129,6 @@ void TChain::Print(Option_t *option) const
}
}
////////////////////////////////////////////////////////////////////////////////
/// Process all entries in this chain, calling functions in filename.
/// The return value is -1 in case of error and TSelector::GetStatus() in
......@@ -2204,7 +2152,6 @@ Long64_t TChain::Process(const char *filename, Option_t *option, Long64_t nentri
return TTree::Process(filename, option, nentries, firstentry);
}
////////////////////////////////////////////////////////////////////////////////
/// Process this chain executing the code in selector.
/// The return value is -1 in case of error and TSelector::GetStatus() in
......@@ -2224,7 +2171,6 @@ Long64_t TChain::Process(TSelector* selector, Option_t* option, Long64_t nentrie
return TTree::Process(selector, option, nentries, firstentry);
}
////////////////////////////////////////////////////////////////////////////////
/// Make sure that obj (which is being deleted or will soon be) is no
/// longer referenced by this TTree.
......@@ -2245,7 +2191,6 @@ void TChain::RecursiveRemove(TObject *obj)
}
}
////////////////////////////////////////////////////////////////////////////////
/// Remove a friend from the list of friends.
......@@ -2269,7 +2214,6 @@ void TChain::RemoveFriend(TTree* oldFriend)
InvalidateCurrentTree();
}
////////////////////////////////////////////////////////////////////////////////
/// Resets the state of this chain.
......@@ -2291,7 +2235,6 @@ void TChain::Reset(Option_t*)
TTree::Reset();
}
////////////////////////////////////////////////////////////////////////////////
/// Resets the state of this chain after a merge (keep the customization but
/// forget the data).
......@@ -2308,7 +2251,6 @@ void TChain::ResetAfterMerge(TFileMergeInfo *info)
TTree::ResetAfterMerge(info);
}
////////////////////////////////////////////////////////////////////////////////
/// Loop on tree and print entries passing selection.
/// - If varexp is 0 (or "") then print only first 8 columns.
......@@ -2324,7 +2266,6 @@ Long64_t TChain::Scan(const char* varexp, const char* selection, Option_t* optio
return TTree::Scan(varexp, selection, option, nentries, firstentry);
}
////////////////////////////////////////////////////////////////////////////////
/// Set the global branch kAutoDelete bit.
///
......@@ -2363,7 +2304,6 @@ Int_t TChain::SetCacheSize(Long64_t cacheSize)
return res;
}
////////////////////////////////////////////////////////////////////////////////
/// Reset the addresses of the branch.
......@@ -2378,7 +2318,6 @@ void TChain::ResetBranchAddress(TBranch *branch)
}
}
////////////////////////////////////////////////////////////////////////////////
/// Reset the addresses of the branches.
......@@ -2394,7 +2333,6 @@ void TChain::ResetBranchAddresses()
}
}
////////////////////////////////////////////////////////////////////////////////
/// Set branch address.
///
......@@ -2457,7 +2395,6 @@ Int_t TChain::SetBranchAddress(const char *bname, void* add, TBranch** ptr)
return res;
}
////////////////////////////////////////////////////////////////////////////////
/// Check if bname is already in the status list, and if not, create a TChainElement object and set its address.
/// See TTree::CheckBranchAddressType for the semantic of the return value.
......@@ -2470,7 +2407,6 @@ Int_t TChain::SetBranchAddress(const char* bname, void* add, TClass* realClass,
return SetBranchAddress(bname, add, 0, realClass, datatype, isptr);
}
////////////////////////////////////////////////////////////////////////////////
/// Check if bname is already in the status list, and if not, create a TChainElement object and set its address.
/// See TTree::CheckBranchAddressType for the semantic of the return value.
......@@ -2494,7 +2430,6 @@ Int_t TChain::SetBranchAddress(const char* bname, void* add, TBranch** ptr, TCla
return SetBranchAddress(bname, add, ptr);
}
////////////////////////////////////////////////////////////////////////////////
/// Set branch status to Process or DoNotProcess
///
......@@ -2530,7 +2465,6 @@ void TChain::SetBranchStatus(const char* bname, Bool_t status, UInt_t* found)
}
}
////////////////////////////////////////////////////////////////////////////////
/// Remove reference to this chain from current directory and add
/// reference to new directory dir. dir can be 0 in which case the chain
......@@ -2549,7 +2483,6 @@ void TChain::SetDirectory(TDirectory* dir)
}
}
////////////////////////////////////////////////////////////////////////////////
/// Set the input entry list (processing the entries of the chain will then be
/// limited to the entries in the list)
......@@ -2632,7 +2565,6 @@ void TChain::SetEntryList(TEntryList *elist, Option_t *opt)
}
////////////////////////////////////////////////////////////////////////////////
/// Set the input entry list (processing the entries of the chain will then be
/// limited to the entries in the list). This function creates a special kind
......@@ -2689,7 +2621,6 @@ void TChain::SetEntryListFile(const char *filename, Option_t * /*opt*/)
((TEntryListFromFile*)fEntryList)->SetFileNames(fFiles);
}
////////////////////////////////////////////////////////////////////////////////
/// This function transfroms the given TEventList into a TEntryList
///
......@@ -2774,7 +2705,6 @@ void TChain::SetEventList(TEventList *evlist)
SetEntryList(enlist);
}
////////////////////////////////////////////////////////////////////////////////
/// Set number of entries per packet for parallel root.
......@@ -2788,7 +2718,6 @@ void TChain::SetPacketSize(Int_t size)
}
}
////////////////////////////////////////////////////////////////////////////////
/// Enable/Disable PROOF processing on the current default Proof (gProof).
///
......@@ -2828,7 +2757,6 @@ void TChain::SetProof(Bool_t on, Bool_t refresh, Bool_t gettreeheader)
}
}
////////////////////////////////////////////////////////////////////////////////
/// Set chain weight.
///
......@@ -2859,7 +2787,6 @@ void TChain::SetWeight(Double_t w, Option_t* option)
}
}
////////////////////////////////////////////////////////////////////////////////
/// Stream a class object.
......@@ -2895,7 +2822,6 @@ void TChain::Streamer(TBuffer& b)
}
}
////////////////////////////////////////////////////////////////////////////////
/// Dummy function kept for back compatibility.
/// The cache is now activated automatically when processing TTrees/TChain.
......
tree/tree/src/TChainElement.cxx
+ 3
− 3
View file @ 205e2645
......@@ -9,9 +9,9 @@
* For the list of contributors see $ROOTSYS/README/CREDITS. *
*************************************************************************/
////////////////////////////////////////////////////////////////////////////////
/// \class TChainElement
/// A TChainElement describes a component of a TChain.
/** \class TChainElement
A TChainElement describes a component of a TChain.
*/
#include "TTree.h"
#include "TChainElement.h"
......
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment