Quick Links: ROOT Homepage Class Index Class Hierarchy

Source: header file source file viewVC header viewVC source

Sections: class description function members data members class charts

class TFileMerger: public TObject


TFileMerger

This class provides file copy and merging services.

It can be used to copy files (not only ROOT files), using TFile or
any of its remote file access plugins. It is therefore usefull in
a Grid environment where the files might be accessable via Castor,
rfio, dcap, etc.
The merging interface allows files containing histograms and trees
to be merged, like the standalone hadd program.

Function Members (Methods)

public:

virtual	~TFileMerger()
void	TObject::AbstractMethod(const char* method) const
virtual Bool_t	AddAdoptFile(TFile* source, Bool_t cpProgress = kTRUE)
virtual Bool_t	AddFile(const char* url, Bool_t cpProgress = kTRUE)
virtual Bool_t	AddFile(TFile* source, Bool_t cpProgress = kTRUE)
void	AddObjectNames(const char* name)
virtual void	TObject::AppendPad(Option_t* option = "")
virtual void	TObject::Browse(TBrowser* b)
static TClass*	Class()
virtual const char*	TObject::ClassName() const
virtual void	TObject::Clear(Option_t* = "")
void	ClearObjectNames()
virtual TObject*	TObject::Clone(const char* newname = "") const
virtual Int_t	TObject::Compare(const TObject* obj) const
virtual void	TObject::Copy(TObject& object) const
virtual void	TObject::Delete(Option_t* option = "")MENU
virtual Int_t	TObject::DistancetoPrimitive(Int_t px, Int_t py)
virtual void	TObject::Draw(Option_t* option = "")
virtual void	TObject::DrawClass() constMENU
virtual TObject*	TObject::DrawClone(Option_t* option = "") constMENU
virtual void	TObject::Dump() constMENU
virtual void	TObject::Error(const char* method, const char* msgfmt) const
virtual void	TObject::Execute(const char* method, const char* params, Int_t* error = 0)
virtual void	TObject::Execute(TMethod* method, TObjArray* params, Int_t* error = 0)
virtual void	TObject::ExecuteEvent(Int_t event, Int_t px, Int_t py)
virtual void	TObject::Fatal(const char* method, const char* msgfmt) const
virtual TObject*	TObject::FindObject(const char* name) const
virtual TObject*	TObject::FindObject(const TObject* obj) const
virtual const char*	GetCWD()
virtual Option_t*	TObject::GetDrawOption() const
static Long_t	TObject::GetDtorOnly()
virtual const char*	TObject::GetIconName() const
Int_t	GetMaxOpenedFies() const
TList*	GetMergeList() const
const char*	GetMsgPrefix() const
virtual const char*	TObject::GetName() const
virtual char*	TObject::GetObjectInfo(Int_t px, Int_t py) const
const char*	GetObjectNames() const
static Bool_t	TObject::GetObjectStat()
virtual Option_t*	TObject::GetOption() const
TFile*	GetOutputFile() const
const char*	GetOutputFileName() const
Int_t	GetPrintLevel() const
virtual const char*	TObject::GetTitle() const
virtual UInt_t	TObject::GetUniqueID() const
virtual Bool_t	TObject::HandleTimer(TTimer* timer)
Bool_t	HasCompressionChange() const
virtual ULong_t	TObject::Hash() const
virtual void	TObject::Info(const char* method, const char* msgfmt) const
virtual Bool_t	TObject::InheritsFrom(const char* classname) const
virtual Bool_t	TObject::InheritsFrom(const TClass* cl) const
virtual void	TObject::Inspect() constMENU
void	TObject::InvertBit(UInt_t f)
virtual TClass*	IsA() const
virtual Bool_t	TObject::IsEqual(const TObject* obj) const
virtual Bool_t	TObject::IsFolder() const
Bool_t	TObject::IsOnHeap() const
virtual Bool_t	TObject::IsSortable() const
Bool_t	TObject::IsZombie() const
virtual void	TObject::ls(Option_t* option = "") const
void	TObject::MayNotUse(const char* method) const
virtual Bool_t	Merge(Bool_t = kTRUE)
virtual Bool_t	TObject::Notify()
void	TObject::Obsolete(const char* method, const char* asOfVers, const char* removedFromVers) const
void	TObject::operator delete(void* ptr)
void	TObject::operator delete(void* ptr, void* vp)
void	TObject::operator delete[](void* ptr)
void	TObject::operator delete[](void* ptr, void* vp)
void*	TObject::operator new(size_t sz)
void*	TObject::operator new(size_t sz, void* vp)
void*	TObject::operator new[](size_t sz)
void*	TObject::operator new[](size_t sz, void* vp)
virtual Bool_t	OutputFile(const char* url, Bool_t force)
virtual Bool_t	OutputFile(const char* url, const char* mode = "RECREATE")
virtual Bool_t	OutputFile(const char* url, Bool_t force, Int_t compressionLevel)
virtual Bool_t	OutputFile(const char* url, const char* mode, Int_t compressionLevel)
virtual void	TObject::Paint(Option_t* option = "")
virtual Bool_t	PartialMerge(Int_t type = kAll \| kIncremental)
virtual void	TObject::Pop()
virtual void	TObject::Print(Option_t* option = "") const
virtual void	PrintFiles(Option_t* options)
virtual Int_t	TObject::Read(const char* name)
virtual void	RecursiveRemove(TObject* obj)
virtual void	Reset()
void	TObject::ResetBit(UInt_t f)
virtual void	TObject::SaveAs(const char* filename = "", Option_t* option = "") constMENU
virtual void	TObject::SavePrimitive(ostream& out, Option_t* option = "")
void	TObject::SetBit(UInt_t f)
void	TObject::SetBit(UInt_t f, Bool_t set)
virtual Bool_t	SetCWD(const char*)
virtual void	TObject::SetDrawOption(Option_t* option = "")MENU
static void	TObject::SetDtorOnly(void* obj)
virtual void	SetFastMethod(Bool_t fast = kTRUE)
void	SetMaxOpenedFiles(Int_t newmax)
void	SetMsgPrefix(const char* prefix)
virtual void	SetNotrees(Bool_t notrees = kFALSE)
static void	TObject::SetObjectStat(Bool_t stat)
void	SetPrintLevel(Int_t level)
virtual void	TObject::SetUniqueID(UInt_t uid)
virtual void	ShowMembers(TMemberInspector& insp) const
virtual void	Streamer(TBuffer&)
void	StreamerNVirtual(TBuffer& ClassDef_StreamerNVirtual_b)
virtual void	TObject::SysError(const char* method, const char* msgfmt) const
Bool_t	TObject::TestBit(UInt_t f) const
Int_t	TObject::TestBits(UInt_t f) const
	TFileMerger(Bool_t isLocal = kTRUE, Bool_t histoOneGo = kTRUE)
virtual void	TObject::UseCurrentStyle()
virtual void	TObject::Warning(const char* method, const char* msgfmt) const
virtual Int_t	TObject::Write(const char* name = 0, Int_t option = 0, Int_t bufsize = 0)
virtual Int_t	TObject::Write(const char* name = 0, Int_t option = 0, Int_t bufsize = 0) const

protected:

virtual Bool_t	AddFile(TFile* source, Bool_t own, Bool_t cpProgress)
virtual void	TObject::DoError(int level, const char* location, const char* fmt, va_list va) const
void	TObject::MakeZombie()
virtual Bool_t	MergeRecursive(TDirectory* target, TList* sourcelist, Int_t type = kRegular \| kAll)
Bool_t	OpenExcessFiles()

private:

TFileMerger&	operator=(const TFileMerger&)
	TFileMerger(const TFileMerger&)

Data Members

public:

static TFileMerger::EPartialMergeType	kAll
static TFileMerger::EPartialMergeType	kAllIncremental
static TObject::(anonymous)	TObject::kBitMask
static TObject::EStatusBits	TObject::kCanDelete
static TObject::EStatusBits	TObject::kCannotPick
static TObject::EStatusBits	TObject::kHasUUID
static TFileMerger::EPartialMergeType	kIncremental
static TObject::EStatusBits	TObject::kInvalidObject
static TObject::(anonymous)	TObject::kIsOnHeap
static TObject::EStatusBits	TObject::kIsReferenced
static TObject::EStatusBits	TObject::kMustCleanup
static TObject::EStatusBits	TObject::kNoContextMenu
static TFileMerger::EPartialMergeType	kNonResetable
static TObject::(anonymous)	TObject::kNotDeleted
static TObject::EStatusBits	TObject::kObjInCanvas
static TFileMerger::EPartialMergeType	kOnlyListed
static TObject::(anonymous)	TObject::kOverwrite
static TFileMerger::EPartialMergeType	kRegular
static TFileMerger::EPartialMergeType	kResetable
static TObject::(anonymous)	TObject::kSingleKey
static TFileMerger::EPartialMergeType	kSkipListed
static TObject::(anonymous)	TObject::kWriteDelete
static TObject::(anonymous)	TObject::kZombie

protected:

Bool_t	fCompressionChange	True if the output and input have different compression level (default kFALSE)
TList*	fExcessFiles	! List of TObjString containing the name of the files not yet added to fFileList due to user or system limitiation on the max number of files opened.
Bool_t	fExplicitCompLevel	True if the user explicitly requested a compressio level change (default kFALSE)
Bool_t	fFastMethod	True if using Fast merging algorithm (default)
TList*	fFileList	a list the file (TFile*) which shall be merged
Bool_t	fHistoOneGo	Merger histos in one go (default is kTRUE)
Bool_t	fLocal	Makes local copies of merging files if True (default is kTRUE)
Int_t	fMaxOpenedFiles	Maximum number of files opened at the same time by the TFileMerger.
TList*	fMergeList	list of TObjString containing the name of the files need to be merged
TString	fMsgPrefix	Prefix to be used when printing informational message (default TFileMerger)
Bool_t	fNoTrees	True if Trees should not be merged (default is kFALSE)
TString	fObjectNames	List of object names to be either merged exclusively or skipped
TFile*	fOutputFile	the outputfile for merging
TString	fOutputFilename	the name of the outputfile for merging
Int_t	fPrintLevel	How much information to print out at run time.
TStopwatch	fWatch	stop watch to measure file copy speed

Class Charts

Inheritance Inherited Members Includes Libraries

Function documentation

TFileMerger(Bool_t isLocal = kTRUE, Bool_t histoOneGo = kTRUE)

 Create file merger object.

~TFileMerger()

 Cleanup.

void Reset()

 Reset merger file list.

Bool_t AddFile(const char* url, Bool_t cpProgress = kTRUE)

 Add file to file merger.

Bool_t AddFile(TFile* source, Bool_t cpProgress = kTRUE)

 Add the TFile to this file merger and *do not* give ownership of the TFile to this
 object.

 Return kTRUE if the addition was successful.

Bool_t AddAdoptFile(TFile* source, Bool_t cpProgress = kTRUE)

 Add the TFile to this file merger and give ownership of the TFile to this
 object (unless kFALSE is returned).

 Return kTRUE if the addition was successful.

Bool_t AddFile(TFile* source, Bool_t own, Bool_t cpProgress)

 Add the TFile to this file merger and give ownership of the TFile to this
 object (unless kFALSE is returned).

 Return kTRUE if the addition was successful.

Bool_t OutputFile(const char* url, Bool_t force, Int_t compressionLevel)

 Open merger output file.

Bool_t OutputFile(const char* url, Bool_t force)

 Open merger output file.

Bool_t OutputFile(const char* url, const char* mode, Int_t compressionLevel)

 Open merger output file.  'mode' is passed to the TFile constructor as the option, it should
 be one of 'NEW','CREATE','RECREATE','UPDATE'
 'UPDATE' is usually used in conjunction with IncrementalMerge.

Bool_t OutputFile(const char* url, const char* mode = "RECREATE")

 Open merger output file.  'mode' is passed to the TFile constructor as the option, it should
 be one of 'NEW','CREATE','RECREATE','UPDATE'
 'UPDATE' is usually used in conjunction with IncrementalMerge.

void PrintFiles(Option_t* options)

 Print list of files being merged.

Bool_t Merge(Bool_t = kTRUE)

 Merge the files. If no output file was specified it will write into
 the file "FileMerger.root" in the working directory. Returns true
 on success, false in case of error.

Bool_t MergeRecursive(TDirectory* target, TList* sourcelist, Int_t type = kRegular | kAll)

 Merge all objects in a directory
 The type is defined by the bit values in EPartialMergeType:
   kRegular      : normal merge, overwritting the output file (default)
   kIncremental  : merge the input file with the (existing) content of the output file (if already exising)
   kAll          : merge all type of objects (default)
   kResetable    : merge only the objects with a MergeAfterReset member function.
   kNonResetable : merge only the objects without a MergeAfterReset member function.
   kOnlyListed   : merge only objects listed in fObjectNames
   kSkipListed   : skip merging of objects listed in fObjectNames

Bool_t PartialMerge(Int_t type = kAll | kIncremental)

 Merge the files. If no output file was specified it will write into
 the file "FileMerger.root" in the working directory. Returns true
 on success, false in case of error.
 The type is defined by the bit values in EPartialMergeType:
   kRegular      : normal merge, overwritting the output file
   kIncremental  : merge the input file with the content of the output file (if already exising) (default)
   kAll          : merge all type of objects (default)
   kResetable    : merge only the objects with a MergeAfterReset member function.
   kNonResetable : merge only the objects without a MergeAfterReset member function.

 If the type is set to kIncremental the output file is done deleted at the end of
 this operation.  If the type is not set to kIncremental, the output file is closed.

Bool_t OpenExcessFiles()

 Open up to fMaxOpenedFiles of the excess files.

void RecursiveRemove(TObject* obj)

 Intercept the case where the output TFile is deleted!

void SetMaxOpenedFiles(Int_t newmax)

 Set a limit to the number file that TFileMerger will opened at one time.
 If the request is higher than the system limit, we reset it to the system limit.
 If the request is less than two, we reset it to 2 (one for the output file and one for the input file).

void SetMsgPrefix(const char* prefix)

 Set the prefix to be used when printing informational message.

TFileMerger(const TFileMerger& )

TFileMerger& operator=(const TFileMerger& )

Int_t GetPrintLevel() const

{ return fPrintLevel; }

void SetPrintLevel(Int_t level)

{ fPrintLevel = level; }

Bool_t HasCompressionChange() const

{ return fCompressionChange; }

const char * GetOutputFileName() const

{ return fOutputFilename; }

TList * GetMergeList() const

{ return fMergeList; }

TFile * GetOutputFile() const

{ return fOutputFile; }

Int_t GetMaxOpenedFies() const

{ return fMaxOpenedFiles; }

const char * GetMsgPrefix() const

{ return fMsgPrefix; }

void AddObjectNames(const char* name)

{fObjectNames += name; fObjectNames += " ";}

const char * GetObjectNames() const

{return fObjectNames.Data();}

void ClearObjectNames()

{fObjectNames.Clear();}

Bool_t SetCWD(const char* )

--- file management interface

{ MayNotUse("SetCWD"); return kFALSE; }

const char * GetCWD()

{ MayNotUse("GetCWD"); return 0; }

void SetFastMethod(Bool_t fast = kTRUE)

{fFastMethod = fast;}

void SetNotrees(Bool_t notrees = kFALSE)

{fNoTrees = notrees;}