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 TProofOutputFile: public TNamed


TProofOutputFile

Small class to steer the merging of files produced on the workers

Function Members (Methods)

public:

virtual	~TProofOutputFile()
void	TObject::AbstractMethod(const char* method) const
Int_t	AdoptFile(TFile* f)
virtual void	TObject::AppendPad(Option_t* option = "")
static Int_t	AssertDir(const char* dirpath)
virtual void	TObject::Browse(TBrowser* b)
static TClass*	Class()
virtual const char*	TObject::ClassName() const
virtual void	TNamed::Clear(Option_t* option = "")
virtual TObject*	TNamed::Clone(const char* newname = "") const
virtual Int_t	TNamed::Compare(const TObject* obj) const
virtual void	TNamed::Copy(TObject& named) 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 void	TNamed::FillBuffer(char*& buffer)
virtual TObject*	TObject::FindObject(const char* name) const
virtual TObject*	TObject::FindObject(const TObject* obj) const
const char*	GetDir(Bool_t raw = kFALSE) const
virtual Option_t*	TObject::GetDrawOption() const
static Long_t	TObject::GetDtorOnly()
TFileCollection*	GetFileCollection()
TFileMerger*	GetFileMerger(Bool_t local = kFALSE)
const char*	GetFileName() const
virtual const char*	TObject::GetIconName() const
const char*	GetLocalHost() const
virtual const char*	TNamed::GetName() const
virtual char*	TObject::GetObjectInfo(Int_t px, Int_t py) const
static Bool_t	TObject::GetObjectStat()
virtual Option_t*	TObject::GetOption() const
const char*	GetOptionsAnchor() const
const char*	GetOutputFileName() const
TProofOutputFile::ERunType	GetRunType() const
virtual const char*	TNamed::GetTitle() const
UInt_t	GetTypeOpt() const
virtual UInt_t	TObject::GetUniqueID() const
const char*	GetWorkerOrdinal() const
virtual Bool_t	TObject::HandleTimer(TTimer* timer)
virtual ULong_t	TNamed::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	IsMerge() const
Bool_t	IsMerged() const
Bool_t	TObject::IsOnHeap() const
Bool_t	IsRegister() const
Bool_t	IsRetrieve() const
virtual Bool_t	TNamed::IsSortable() const
Bool_t	TObject::IsZombie() const
virtual void	TNamed::ls(Option_t* option = "") const
void	TObject::MayNotUse(const char* method) const
Long64_t	Merge(TCollection* list)
virtual Bool_t	TObject::Notify()
void	TObject::Obsolete(const char* method, const char* asOfVers, const char* removedFromVers) const
TFile*	OpenFile(const char* opt)
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 void	TObject::Paint(Option_t* option = "")
virtual void	TObject::Pop()
virtual void	Print(Option_t* option = "") const
virtual Int_t	TObject::Read(const char* name)
virtual void	TObject::RecursiveRemove(TObject* obj)
void	TObject::ResetBit(UInt_t f)
void	ResetFileCollection()
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 void	TObject::SetDrawOption(Option_t* option = "")MENU
static void	TObject::SetDtorOnly(void* obj)
virtual void	TNamed::SetName(const char* name)MENU
virtual void	TNamed::SetNameTitle(const char* name, const char* title)
static void	TObject::SetObjectStat(Bool_t stat)
void	SetOutputFileName(const char* name)
void	SetRetrieve(Bool_t on = kTRUE)
virtual void	TNamed::SetTitle(const char* title = "")MENU
virtual void	TObject::SetUniqueID(UInt_t uid)
virtual void	ShowMembers(TMemberInspector& insp) const
virtual Int_t	TNamed::Sizeof() 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
	TProofOutputFile()
	TProofOutputFile(const char* path, const char* option = "M", const char* dsname = 0)
	TProofOutputFile(const char* path, TProofOutputFile::ERunType type, UInt_t opt = kRemote, const char* dsname = 0)
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 void	TObject::DoError(int level, const char* location, const char* fmt, va_list va) const
void	TObject::MakeZombie()

private:

void	AddFile(TFileMerger* merger, const char* path)
void	Init(const char* path, const char* dsname)
void	NotifyError(const char* errmsg)
TProofOutputFile&	operator=(const TProofOutputFile&)
void	SetDir(const char* dir, Bool_t raw = kFALSE)
void	SetFileName(const char* name)
void	SetMerged(Bool_t merged = kTRUE)
void	SetWorkerOrdinal(const char* ordinal)
	TProofOutputFile(const TProofOutputFile&)
void	Unlink(const char* path)

Data Members

public:

static TObject::<anonymous>	TObject::kBitMask
static TObject::EStatusBits	TObject::kCanDelete
static TObject::EStatusBits	TObject::kCannotPick
static TProofOutputFile::ETypeOpt	kCreate
static TProofOutputFile::ERunType	kDataset
static TObject::EStatusBits	TObject::kHasUUID
static TObject::EStatusBits	TObject::kInvalidObject
static TObject::<anonymous>	TObject::kIsOnHeap
static TObject::EStatusBits	TObject::kIsReferenced
static TProofOutputFile::ETypeOpt	kLocal
static TProofOutputFile::ERunType	kMerge
static TObject::EStatusBits	TObject::kMustCleanup
static TObject::EStatusBits	TObject::kNoContextMenu
static TObject::<anonymous>	TObject::kNotDeleted
static TObject::EStatusBits	TObject::kObjInCanvas
static TProofOutputFile::EStatusBits	kOutputFileNameSet
static TProofOutputFile::ETypeOpt	kOverwrite
static TObject::<anonymous>	TObject::kOverwrite
static TProofOutputFile::ETypeOpt	kRegister
static TProofOutputFile::ETypeOpt	kRemote
static TProofOutputFile::EStatusBits	kRetrieve
static TObject::<anonymous>	TObject::kSingleKey
static TProofOutputFile::EStatusBits	kSwapFile
static TProofOutputFile::ETypeOpt	kVerify
static TObject::<anonymous>	TObject::kWriteDelete
static TObject::<anonymous>	TObject::kZombie

protected:

TString	TNamed::fName	object identifier
TString	TNamed::fTitle	object title

private:

TFileCollection*	fDataSet	Instance of the file collection in 'dataset' mode
TString	fDir	name of the directory to be exported
TString	fFileName
Bool_t	fIsLocal	kTRUE if the file is in the sandbox
TString	fLocalHost	Host where the file was created
Bool_t	fMergeHistosOneGo	If true merge histos in one go (argument to TFileMerger)
Bool_t	fMerged
TFileMerger*	fMerger	Instance of the file merger in 'merge' mode
TString	fOptionsAnchor	options and anchor string including delimiters, e.g. "?myopts#myanchor"
TString	fOutputFileName
TString	fRawDir	name of the local directory where to create the file
TProofOutputFile::ERunType	fRunType	Type of run (see enum ERunType)
UInt_t	fTypeOpt	Option (see enum ETypeOpt)
TString	fWorkerOrdinal

Class Charts

Inheritance Inherited Members Includes Libraries

Function documentation

TProofOutputFile(const char* path, TProofOutputFile::ERunType type, UInt_t opt = kRemote, const char* dsname = 0)

 Main constructor

TProofOutputFile(const char* path, const char* option = "M", const char* dsname = 0)

 Constructor with the old signature, kept for convenience and backard compatibility.
 Options:
             'M'      merge: finally merge the created files
             'L'      local: copy locally the files before merging (implies 'M')
             'D'      dataset: create a TFileCollection
             'R'      register: dataset run with dataset registration
             'O'      overwrite: force dataset replacement during registration
             'V'      verify: verify the registered dataset
             'H'      merge histograms in one go (option to TFileMerger)
 Special 'option' values for backward compatibility:
              ""      equivalent to "M"
         "LOCAL"      equivalent to "ML" or "L"

void Init(const char* path, const char* dsname)

 Initializer. Called by all constructors

~TProofOutputFile()

 Main destructor

void SetOutputFileName(const char* name)

 Set the name of the output file; in the form of an Url.

TFile* OpenFile(const char* opt)

 Open the file using the unique temporary name

Int_t AdoptFile(TFile* f)

 Adopt a file already open.
 Return 0 if OK, -1 in case of failure

Long64_t Merge(TCollection* list)

 Merge objects from the list into this object

void Print(Option_t* option = "") const

 Dump the class content

void NotifyError(const char* errmsg)

 Notify error message

void AddFile(TFileMerger* merger, const char* path)

 Add file to merger, checking the result

void Unlink(const char* path)

 Unlink path

TFileCollection * GetFileCollection()

 Get instance of the file collection to be used in 'dataset' mode

TFileMerger * GetFileMerger(Bool_t local = kFALSE)

 Get instance of the file merger to be used in 'merge' mode

Int_t AssertDir(const char* dirpath)

 Assert directory path 'dirpath', with the ownership of the last already
 existing subpath.
 Return 0 on success, -1 on error

TProofOutputFile(const TProofOutputFile& )

TProofOutputFile& operator=(const TProofOutputFile& )

void SetFileName(const char* name)

{ fFileName = name; }

void SetDir(const char* dir, Bool_t raw = kFALSE)

void SetMerged(Bool_t merged = kTRUE)

{ fMerged = merged; }

void SetWorkerOrdinal(const char* ordinal)

{ fWorkerOrdinal = ordinal; }

TProofOutputFile()

{ }

const char * GetDir(Bool_t raw = kFALSE) const

{ return (raw) ? fRawDir : fDir; }

const char * GetFileName() const

{ return fFileName; }

const char * GetLocalHost() const

{ return fLocalHost; }

const char * GetOptionsAnchor() const

{ return fOptionsAnchor; }

const char * GetOutputFileName() const

{ return fOutputFileName; }

const char * GetWorkerOrdinal() const

{ return fWorkerOrdinal; }

ERunType GetRunType() const

{ return fRunType; }

UInt_t GetTypeOpt() const

{ return fTypeOpt; }

Bool_t IsMerge() const

{ return (fRunType == kMerge) ? kTRUE : kFALSE; }

Bool_t IsMerged() const

{ return fMerged; }

Bool_t IsRegister() const

{ return ((fTypeOpt & kRegister) || (fTypeOpt & kVerify)) ? kTRUE : kFALSE; }

Bool_t IsRetrieve() const

{ return (TestBit(TProofOutputFile::kRetrieve)) ? kTRUE : kFALSE; }

void SetRetrieve(Bool_t on = kTRUE)

void ResetFileCollection()

{ fDataSet = 0; }