Logo ROOT  
Reference Guide
TProofOutputFile Class Reference

Class to steer the merging of files produced on the workers

Definition at line 33 of file TProofOutputFile.h.

Public Types

enum  ERunType { kMerge = 1, kDataset = 2 }
 
enum  EStatusBits { kOutputFileNameSet = BIT(16), kRetrieve = BIT(17), kSwapFile = BIT(18) }
 
enum  ETypeOpt {
  kRemote = 1, kLocal = 2, kCreate = 4, kRegister = 8,
  kOverwrite = 16, kVerify = 32
}
 
- Public Types inherited from TObject
enum  {
  kIsOnHeap = 0x01000000, kNotDeleted = 0x02000000, kZombie = 0x04000000, kInconsistent = 0x08000000,
  kBitMask = 0x00ffffff
}
 
enum  { kSingleKey = BIT(0), kOverwrite = BIT(1), kWriteDelete = BIT(2) }
 
enum  EDeprecatedStatusBits { kObjInCanvas = BIT(3) }
 
enum  EStatusBits {
  kCanDelete = BIT(0), kMustCleanup = BIT(3), kIsReferenced = BIT(4), kHasUUID = BIT(5),
  kCannotPick = BIT(6), kNoContextMenu = BIT(8), kInvalidObject = BIT(13)
}
 

Public Member Functions

 TProofOutputFile ()
 
 TProofOutputFile (const char *path, const char *option="M", const char *dsname=0)
 Constructor with the old signature, kept for convenience and backard compatibility. More...
 
 TProofOutputFile (const char *path, ERunType type, UInt_t opt=kRemote, const char *dsname=0)
 Main constructor. More...
 
virtual ~TProofOutputFile ()
 Main destructor. More...
 
Int_t AdoptFile (TFile *f)
 Adopt a file already open. More...
 
const char * GetDir (Bool_t raw=kFALSE) const
 
TFileCollectionGetFileCollection ()
 Get instance of the file collection to be used in 'dataset' mode. More...
 
TFileMergerGetFileMerger (Bool_t local=kFALSE)
 Get instance of the file merger to be used in 'merge' mode. More...
 
const char * GetFileName () const
 
const char * GetLocalHost () const
 
const char * GetOptionsAnchor () const
 
const char * GetOutputFileName () const
 
ERunType GetRunType () const
 
UInt_t GetTypeOpt () const
 
const char * GetWorkerOrdinal () const
 
Bool_t IsMerge () const
 
Bool_t IsMerged () const
 
Bool_t IsRegister () const
 
Bool_t IsRetrieve () const
 
Long64_t Merge (TCollection *list)
 Merge objects from the list into this object. More...
 
TFileOpenFile (const char *opt)
 Open the file using the unique temporary name. More...
 
void Print (Option_t *option="") const
 Dump the class content. More...
 
void ResetFileCollection ()
 
void SetOutputFileName (const char *name)
 Set the name of the output file; in the form of an Url. More...
 
void SetRetrieve (Bool_t on=kTRUE)
 
- Public Member Functions inherited from TNamed
 TNamed ()
 
 TNamed (const char *name, const char *title)
 
 TNamed (const TNamed &named)
 TNamed copy ctor. More...
 
 TNamed (const TString &name, const TString &title)
 
virtual ~TNamed ()
 TNamed destructor. More...
 
virtual void Clear (Option_t *option="")
 Set name and title to empty strings (""). More...
 
virtual TObjectClone (const char *newname="") const
 Make a clone of an object using the Streamer facility. More...
 
virtual Int_t Compare (const TObject *obj) const
 Compare two TNamed objects. More...
 
virtual void Copy (TObject &named) const
 Copy this to obj. More...
 
virtual void FillBuffer (char *&buffer)
 Encode TNamed into output buffer. More...
 
virtual const char * GetName () const
 Returns name of object. More...
 
virtual const char * GetTitle () const
 Returns title of object. More...
 
virtual ULong_t Hash () const
 Return hash value for this object. More...
 
virtual Bool_t IsSortable () const
 
virtual void ls (Option_t *option="") const
 List TNamed name and title. More...
 
TNamedoperator= (const TNamed &rhs)
 TNamed assignment operator. More...
 
virtual void SetName (const char *name)
 Set the name of the TNamed. More...
 
virtual void SetNameTitle (const char *name, const char *title)
 Set all the TNamed parameters (name and title). More...
 
virtual void SetTitle (const char *title="")
 Set the title of the TNamed. More...
 
virtual Int_t Sizeof () const
 Return size of the TNamed part of the TObject. More...
 
- Public Member Functions inherited from TObject
 TObject ()
 TObject constructor. More...
 
 TObject (const TObject &object)
 TObject copy ctor. More...
 
virtual ~TObject ()
 TObject destructor. More...
 
void AbstractMethod (const char *method) const
 Use this method to implement an "abstract" method that you don't want to leave purely abstract. More...
 
virtual void AppendPad (Option_t *option="")
 Append graphics object to current pad. More...
 
virtual void Browse (TBrowser *b)
 Browse object. May be overridden for another default action. More...
 
ULong_t CheckedHash ()
 Check and record whether this class has a consistent Hash/RecursiveRemove setup (*) and then return the regular Hash value for this object. More...
 
virtual const char * ClassName () const
 Returns name of class to which the object belongs. More...
 
virtual void Delete (Option_t *option="")
 Delete this object. More...
 
virtual Int_t DistancetoPrimitive (Int_t px, Int_t py)
 Computes distance from point (px,py) to the object. More...
 
virtual void Draw (Option_t *option="")
 Default Draw method for all objects. More...
 
virtual void DrawClass () const
 Draw class inheritance tree of the class to which this object belongs. More...
 
virtual TObjectDrawClone (Option_t *option="") const
 Draw a clone of this object in the current selected pad for instance with: gROOT->SetSelectedPad(gPad). More...
 
virtual void Dump () const
 Dump contents of object on stdout. More...
 
virtual void Error (const char *method, const char *msgfmt,...) const
 Issue error message. More...
 
virtual void Execute (const char *method, const char *params, Int_t *error=0)
 Execute method on this object with the given parameter string, e.g. More...
 
virtual void Execute (TMethod *method, TObjArray *params, Int_t *error=0)
 Execute method on this object with parameters stored in the TObjArray. More...
 
virtual void ExecuteEvent (Int_t event, Int_t px, Int_t py)
 Execute action corresponding to an event at (px,py). More...
 
virtual void Fatal (const char *method, const char *msgfmt,...) const
 Issue fatal error message. More...
 
virtual TObjectFindObject (const char *name) const
 Must be redefined in derived classes. More...
 
virtual TObjectFindObject (const TObject *obj) const
 Must be redefined in derived classes. More...
 
virtual Option_tGetDrawOption () const
 Get option used by the graphics system to draw this object. More...
 
virtual const char * GetIconName () const
 Returns mime type name of object. More...
 
virtual char * GetObjectInfo (Int_t px, Int_t py) const
 Returns string containing info about the object at position (px,py). More...
 
virtual Option_tGetOption () const
 
virtual UInt_t GetUniqueID () const
 Return the unique object id. More...
 
virtual Bool_t HandleTimer (TTimer *timer)
 Execute action in response of a timer timing out. More...
 
Bool_t HasInconsistentHash () const
 Return true is the type of this object is known to have an inconsistent setup for Hash and RecursiveRemove (i.e. More...
 
virtual void Info (const char *method, const char *msgfmt,...) const
 Issue info message. More...
 
virtual Bool_t InheritsFrom (const char *classname) const
 Returns kTRUE if object inherits from class "classname". More...
 
virtual Bool_t InheritsFrom (const TClass *cl) const
 Returns kTRUE if object inherits from TClass cl. More...
 
virtual void Inspect () const
 Dump contents of this object in a graphics canvas. More...
 
void InvertBit (UInt_t f)
 
virtual Bool_t IsEqual (const TObject *obj) const
 Default equal comparison (objects are equal if they have the same address in memory). More...
 
virtual Bool_t IsFolder () const
 Returns kTRUE in case object contains browsable objects (like containers or lists of other objects). More...
 
R__ALWAYS_INLINE Bool_t IsOnHeap () const
 
R__ALWAYS_INLINE Bool_t IsZombie () const
 
void MayNotUse (const char *method) const
 Use this method to signal that a method (defined in a base class) may not be called in a derived class (in principle against good design since a child class should not provide less functionality than its parent, however, sometimes it is necessary). More...
 
virtual Bool_t Notify ()
 This method must be overridden to handle object notification. More...
 
void Obsolete (const char *method, const char *asOfVers, const char *removedFromVers) const
 Use this method to declare a method obsolete. More...
 
void operator delete (void *ptr)
 Operator delete. More...
 
void operator delete[] (void *ptr)
 Operator delete []. More...
 
voidoperator new (size_t sz)
 
voidoperator new (size_t sz, void *vp)
 
voidoperator new[] (size_t sz)
 
voidoperator new[] (size_t sz, void *vp)
 
TObjectoperator= (const TObject &rhs)
 TObject assignment operator. More...
 
virtual void Paint (Option_t *option="")
 This method must be overridden if a class wants to paint itself. More...
 
virtual void Pop ()
 Pop on object drawn in a pad to the top of the display list. More...
 
virtual Int_t Read (const char *name)
 Read contents of object with specified name from the current directory. More...
 
virtual void RecursiveRemove (TObject *obj)
 Recursively remove this object from a list. More...
 
void ResetBit (UInt_t f)
 
virtual void SaveAs (const char *filename="", Option_t *option="") const
 Save this object in the file specified by filename. More...
 
virtual void SavePrimitive (std::ostream &out, Option_t *option="")
 Save a primitive as a C++ statement(s) on output stream "out". More...
 
void SetBit (UInt_t f)
 
void SetBit (UInt_t f, Bool_t set)
 Set or unset the user status bits as specified in f. More...
 
virtual void SetDrawOption (Option_t *option="")
 Set drawing option for object. More...
 
virtual void SetUniqueID (UInt_t uid)
 Set the unique object id. More...
 
virtual void SysError (const char *method, const char *msgfmt,...) const
 Issue system error message. More...
 
R__ALWAYS_INLINE Bool_t TestBit (UInt_t f) const
 
Int_t TestBits (UInt_t f) const
 
virtual void UseCurrentStyle ()
 Set current style settings in this object This function is called when either TCanvas::UseCurrentStyle or TROOT::ForceStyle have been invoked. More...
 
virtual void Warning (const char *method, const char *msgfmt,...) const
 Issue warning message. More...
 
virtual Int_t Write (const char *name=0, Int_t option=0, Int_t bufsize=0)
 Write this object to the current directory. More...
 
virtual Int_t Write (const char *name=0, Int_t option=0, Int_t bufsize=0) const
 Write this object to the current directory. More...
 

Static Public Member Functions

static Int_t AssertDir (const char *dirpath)
 Assert directory path 'dirpath', with the ownership of the last already existing subpath. More...
 
- Static Public Member Functions inherited from TObject
static Long_t GetDtorOnly ()
 Return destructor only flag. More...
 
static Bool_t GetObjectStat ()
 Get status of object stat flag. More...
 
static void SetDtorOnly (void *obj)
 Set destructor only flag. More...
 
static void SetObjectStat (Bool_t stat)
 Turn on/off tracking of objects in the TObjectTable. More...
 

Private Member Functions

 TProofOutputFile (const TProofOutputFile &)
 
void AddFile (TFileMerger *merger, const char *path)
 Add file to merger, checking the result. More...
 
void Init (const char *path, const char *dsname)
 Initializer. Called by all constructors. More...
 
void NotifyError (const char *errmsg)
 Notify error message. More...
 
TProofOutputFileoperator= (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)
 
void Unlink (const char *path)
 Unlink path. More...
 

Private Attributes

TFileCollectionfDataSet
 
TString fDir
 
TString fFileName
 
Bool_t fIsLocal
 
TString fLocalHost
 
Bool_t fMerged
 
Bool_t fMergeHistosOneGo
 
TFileMergerfMerger
 
TString fOptionsAnchor
 
TString fOutputFileName
 
TString fRawDir
 
ERunType fRunType
 
UInt_t fTypeOpt
 
TString fWorkerOrdinal
 

Friends

class TProof
 
class TProofPlayer
 
class TProofPlayerRemote
 

Additional Inherited Members

- Protected Member Functions inherited from TObject
virtual void DoError (int level, const char *location, const char *fmt, va_list va) const
 Interface to ErrorHandler (protected). More...
 
void MakeZombie ()
 
- Protected Attributes inherited from TNamed
TString fName
 
TString fTitle
 

#include <TProofOutputFile.h>

Inheritance diagram for TProofOutputFile:
[legend]

Member Enumeration Documentation

◆ ERunType

Enumerator
kMerge 
kDataset 

Definition at line 40 of file TProofOutputFile.h.

◆ EStatusBits

Enumerator
kOutputFileNameSet 
kRetrieve 
kSwapFile 

Definition at line 82 of file TProofOutputFile.h.

◆ ETypeOpt

Enumerator
kRemote 
kLocal 
kCreate 
kRegister 
kOverwrite 
kVerify 

Definition at line 42 of file TProofOutputFile.h.

Constructor & Destructor Documentation

◆ TProofOutputFile() [1/4]

TProofOutputFile::TProofOutputFile ( const TProofOutputFile )
private

◆ TProofOutputFile() [2/4]

TProofOutputFile::TProofOutputFile ( )
inline

Definition at line 88 of file TProofOutputFile.h.

◆ TProofOutputFile() [3/4]

TProofOutputFile::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"

Definition at line 68 of file TProofOutputFile.cxx.

◆ TProofOutputFile() [4/4]

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

Main constructor.

Definition at line 40 of file TProofOutputFile.cxx.

◆ ~TProofOutputFile()

TProofOutputFile::~TProofOutputFile ( )
virtual

Main destructor.

Definition at line 232 of file TProofOutputFile.cxx.

Member Function Documentation

◆ AddFile()

void TProofOutputFile::AddFile ( TFileMerger merger,
const char *  path 
)
private

Add file to merger, checking the result.

Definition at line 467 of file TProofOutputFile.cxx.

◆ AdoptFile()

Int_t TProofOutputFile::AdoptFile ( TFile f)

Adopt a file already open.

Return 0 if OK, -1 in case of failure

Definition at line 274 of file TProofOutputFile.cxx.

◆ AssertDir()

Int_t TProofOutputFile::AssertDir ( const char *  dirpath)
static

Assert directory path 'dirpath', with the ownership of the last already existing subpath.

Return 0 on success, -1 on error

Definition at line 515 of file TProofOutputFile.cxx.

◆ GetDir()

const char* TProofOutputFile::GetDir ( Bool_t  raw = kFALSE) const
inline

Definition at line 96 of file TProofOutputFile.h.

◆ GetFileCollection()

TFileCollection * TProofOutputFile::GetFileCollection ( )

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

Definition at line 493 of file TProofOutputFile.cxx.

◆ GetFileMerger()

TFileMerger * TProofOutputFile::GetFileMerger ( Bool_t  local = kFALSE)

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

Definition at line 503 of file TProofOutputFile.cxx.

◆ GetFileName()

const char* TProofOutputFile::GetFileName ( ) const
inline

Definition at line 99 of file TProofOutputFile.h.

◆ GetLocalHost()

const char* TProofOutputFile::GetLocalHost ( ) const
inline

Definition at line 100 of file TProofOutputFile.h.

◆ GetOptionsAnchor()

const char* TProofOutputFile::GetOptionsAnchor ( ) const
inline

Definition at line 101 of file TProofOutputFile.h.

◆ GetOutputFileName()

const char* TProofOutputFile::GetOutputFileName ( ) const
inline

Definition at line 102 of file TProofOutputFile.h.

◆ GetRunType()

ERunType TProofOutputFile::GetRunType ( ) const
inline

Definition at line 105 of file TProofOutputFile.h.

◆ GetTypeOpt()

UInt_t TProofOutputFile::GetTypeOpt ( ) const
inline

Definition at line 106 of file TProofOutputFile.h.

◆ GetWorkerOrdinal()

const char* TProofOutputFile::GetWorkerOrdinal ( ) const
inline

Definition at line 103 of file TProofOutputFile.h.

◆ Init()

void TProofOutputFile::Init ( const char *  path,
const char *  dsname 
)
private

Initializer. Called by all constructors.

Definition at line 101 of file TProofOutputFile.cxx.

◆ IsMerge()

Bool_t TProofOutputFile::IsMerge ( ) const
inline

Definition at line 107 of file TProofOutputFile.h.

◆ IsMerged()

Bool_t TProofOutputFile::IsMerged ( ) const
inline

Definition at line 108 of file TProofOutputFile.h.

◆ IsRegister()

Bool_t TProofOutputFile::IsRegister ( ) const
inline

Definition at line 109 of file TProofOutputFile.h.

◆ IsRetrieve()

Bool_t TProofOutputFile::IsRetrieve ( ) const
inline

Definition at line 111 of file TProofOutputFile.h.

◆ Merge()

Long64_t TProofOutputFile::Merge ( TCollection list)

Merge objects from the list into this object.

Definition at line 314 of file TProofOutputFile.cxx.

◆ NotifyError()

void TProofOutputFile::NotifyError ( const char *  errmsg)
private

Notify error message.

Definition at line 450 of file TProofOutputFile.cxx.

◆ OpenFile()

TFile * TProofOutputFile::OpenFile ( const char *  opt)

Open the file using the unique temporary name.

Definition at line 256 of file TProofOutputFile.cxx.

◆ operator=()

TProofOutputFile& TProofOutputFile::operator= ( const TProofOutputFile )
private

◆ Print()

void TProofOutputFile::Print ( Option_t option = "") const
virtual

Dump the class content.

Reimplemented from TNamed.

Definition at line 422 of file TProofOutputFile.cxx.

◆ ResetFileCollection()

void TProofOutputFile::ResetFileCollection ( )
inline

Definition at line 120 of file TProofOutputFile.h.

◆ SetDir()

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

Definition at line 71 of file TProofOutputFile.h.

◆ SetFileName()

void TProofOutputFile::SetFileName ( const char *  name)
inlineprivate

Definition at line 70 of file TProofOutputFile.h.

◆ SetMerged()

void TProofOutputFile::SetMerged ( Bool_t  merged = kTRUE)
inlineprivate

Definition at line 72 of file TProofOutputFile.h.

◆ SetOutputFileName()

void TProofOutputFile::SetOutputFileName ( const char *  name)

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

Definition at line 241 of file TProofOutputFile.cxx.

◆ SetRetrieve()

void TProofOutputFile::SetRetrieve ( Bool_t  on = kTRUE)
inline

Definition at line 112 of file TProofOutputFile.h.

◆ SetWorkerOrdinal()

void TProofOutputFile::SetWorkerOrdinal ( const char *  ordinal)
inlineprivate

Definition at line 73 of file TProofOutputFile.h.

◆ Unlink()

void TProofOutputFile::Unlink ( const char *  path)
private

Unlink path.

Definition at line 479 of file TProofOutputFile.cxx.

Friends And Related Function Documentation

◆ TProof

friend class TProof
friend

Definition at line 35 of file TProofOutputFile.h.

◆ TProofPlayer

friend class TProofPlayer
friend

Definition at line 36 of file TProofOutputFile.h.

◆ TProofPlayerRemote

friend class TProofPlayerRemote
friend

Definition at line 37 of file TProofOutputFile.h.

Member Data Documentation

◆ fDataSet

TFileCollection* TProofOutputFile::fDataSet
private

Definition at line 66 of file TProofOutputFile.h.

◆ fDir

TString TProofOutputFile::fDir
private

Definition at line 53 of file TProofOutputFile.h.

◆ fFileName

TString TProofOutputFile::fFileName
private

Definition at line 55 of file TProofOutputFile.h.

◆ fIsLocal

Bool_t TProofOutputFile::fIsLocal
private

Definition at line 60 of file TProofOutputFile.h.

◆ fLocalHost

TString TProofOutputFile::fLocalHost
private

Definition at line 59 of file TProofOutputFile.h.

◆ fMerged

Bool_t TProofOutputFile::fMerged
private

Definition at line 61 of file TProofOutputFile.h.

◆ fMergeHistosOneGo

Bool_t TProofOutputFile::fMergeHistosOneGo
private

Definition at line 64 of file TProofOutputFile.h.

◆ fMerger

TFileMerger* TProofOutputFile::fMerger
private

Definition at line 67 of file TProofOutputFile.h.

◆ fOptionsAnchor

TString TProofOutputFile::fOptionsAnchor
private

Definition at line 56 of file TProofOutputFile.h.

◆ fOutputFileName

TString TProofOutputFile::fOutputFileName
private

Definition at line 57 of file TProofOutputFile.h.

◆ fRawDir

TString TProofOutputFile::fRawDir
private

Definition at line 54 of file TProofOutputFile.h.

◆ fRunType

ERunType TProofOutputFile::fRunType
private

Definition at line 62 of file TProofOutputFile.h.

◆ fTypeOpt

UInt_t TProofOutputFile::fTypeOpt
private

Definition at line 63 of file TProofOutputFile.h.

◆ fWorkerOrdinal

TString TProofOutputFile::fWorkerOrdinal
private

Definition at line 58 of file TProofOutputFile.h.

Libraries for TProofOutputFile:
[legend]

The documentation for this class was generated from the following files: