TFileMergeInfo.h

Go to the documentation of this file.

// Author: Philippe Canal May, 2011
 
/*************************************************************************
 * Copyright (C) 1995-2005, Rene Brun and Fons Rademakers.               *
 * All rights reserved.                                                  *
 *                                                                       *
 * For the licensing terms see $ROOTSYS/LICENSE.                         *
 * For the list of contributors see $ROOTSYS/README/CREDITS.             *
 *************************************************************************/
 
/** \class TFileMergeInfo
A class to pass information from the TFileMerger to the objects being merged.
*/
 
#ifndef ROOT_TFileMergeInfo
#define ROOT_TFileMergeInfo
 
/// This class provides access to the output directory pointer (fOutputDirectory)
/// whether or not this is the first time Merge is being called in the
/// series (for example for TTree, the first time we also need to Clone
/// the object on which Merge is called), and provides for a User Data
/// object to be passed along to each of the calls to Merge.
/// The fUserData object is owned by the TFileMergeInfo and will be
/// deleted when the TFileMerger moves on to the next set of objects.
 
#include "TObject.h"
 
#include "TString.h"
 
class TDirectory;
 
namespace ROOT {
class TIOFeatures;
}
 
class TFileMergeInfo {
public:
   using TIOFeatures = ROOT::TIOFeatures;
private:
   TFileMergeInfo() = delete;
   TFileMergeInfo(const TFileMergeInfo&) = delete;
   TFileMergeInfo& operator=(const TFileMergeInfo&) = delete;
 
public:
   TDirectory  *fOutputDirectory{nullptr}; ///< Target directory where the merged object will be written.
   Bool_t       fIsFirst{kTRUE};           ///< True if this is the first call to Merge for this series of object.
   TString      fOptions;                  ///< Additional text based option being passed down to customize the merge.
   TObject     *fUserData{nullptr};        ///< Place holder to pass extra information.  This object will be deleted at the end of each series of objects.
   TIOFeatures *fIOFeatures{nullptr};      ///< Any ROOT IO features that should be explicitly enabled.
 
   TFileMergeInfo(TDirectory *outputfile) : fOutputDirectory(outputfile) {}
   virtual ~TFileMergeInfo() { delete fUserData; } ;
 
   void Reset() { fIsFirst = kTRUE; delete fUserData; fUserData = nullptr; }
 
   ClassDef(TFileMergeInfo, 0);
};
 
#endif