RFriendInfo.hxx

Go to the documentation of this file.

/*************************************************************************
 * Copyright (C) 1995-2022, Rene Brun and Fons Rademakers.               *
 * All rights reserved.                                                  *
 *                                                                       *
 * For the licensing terms see $ROOTSYS/LICENSE.                         *
 * For the list of contributors see $ROOTSYS/README/CREDITS.             *
 *************************************************************************/
 
/**
 \file ROOT/RFriendInfo.hxx
 \author Ivan Kabadzhov
 \author Enrico Guiraud
 \author Vincenzo Eduardo Padulano
 \date 2022-10
*/
 
#ifndef ROOT_RFRIENDINFO_H
#define ROOT_RFRIENDINFO_H
 
#include <string_view>
#include <Rtypes.h> // Long64_t
#include <TVirtualIndex.h>
#include <TTree.h>
 
#include <limits>
#include <memory>
#include <string>
#include <utility> // std::pair
#include <vector>
 
class TTree;
 
namespace ROOT {
namespace TreeUtils {
 
/**
\struct ROOT::TreeUtils::RFriendInfo
\brief Information about friend trees of a certain TTree or TChain object.
\ingroup tree
*/
struct RFriendInfo {
 
   /**
    * Pairs of names and aliases of each friend tree/chain.
    */
   std::vector<std::pair<std::string, std::string>> fFriendNames;
   /**
   Names of the files where each friend is stored. fFriendFileNames[i] is the
   list of files for friend with name fFriendNames[i].
   */
   std::vector<std::vector<std::string>> fFriendFileNames;
   /**
      Names of the subtrees of a friend TChain. fFriendChainSubNames[i] is the
      list of names of the trees that make a friend TChain whose information is
      stored at fFriendNames[i] and fFriendFileNames[i]. If instead the friend
      tree at position `i` is a TTree, fFriendChainSubNames[i] will be an empty
      vector.
   */
   std::vector<std::vector<std::string>> fFriendChainSubNames;
   /**
    * Number of entries contained in each tree of each friend. The outer
    * dimension of the vector tracks the n-th friend tree/chain, the inner
    * dimension tracks the number of entries of each tree in the current friend.
    */
   std::vector<std::vector<Long64_t>> fNEntriesPerTreePerFriend;
 
   /**
      Information on the friend's TTreeIndexes.
   */
   std::vector<std::unique_ptr<TVirtualIndex>> fTreeIndexInfos;
 
   RFriendInfo() = default;
   RFriendInfo(const RFriendInfo &);
   RFriendInfo &operator=(const RFriendInfo &);
   RFriendInfo(RFriendInfo &&) = default;
   RFriendInfo &operator=(RFriendInfo &&) = default;
   RFriendInfo(std::vector<std::pair<std::string, std::string>> friendNames,
               std::vector<std::vector<std::string>> friendFileNames,
               std::vector<std::vector<std::string>> friendChainSubNames,
               std::vector<std::vector<Long64_t>> nEntriesPerTreePerFriend,
               std::vector<std::unique_ptr<TVirtualIndex>> treeIndexInfos);
 
   void AddFriend(const std::string &treeName, const std::string &fileNameGlob, const std::string &alias = "",
                  Long64_t nEntries = TTree::kMaxEntries, TVirtualIndex *indexInfo = nullptr);
 
   void AddFriend(const std::string &treeName, const std::vector<std::string> &fileNameGlobs,
                  const std::string &alias = "", const std::vector<Long64_t> &nEntriesVec = {},
                  TVirtualIndex *indexInfo = nullptr);
 
   void AddFriend(const std::vector<std::pair<std::string, std::string>> &treeAndFileNameGlobs,
                  const std::string &alias = "", const std::vector<Long64_t> &nEntriesVec = {},
                  TVirtualIndex *indexInfo = nullptr);
};
 
} // namespace TreeUtils
} // namespace ROOT
 
#endif // ROOT_RFRIENDINFO_H