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 = (1ULL << ( 16 )) , kRetrieve = (1ULL << ( 17 )) , kSwapFile = (1ULL << ( 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 = (1ULL << ( 0 )) , kOverwrite = (1ULL << ( 1 )) , kWriteDelete = (1ULL << ( 2 )) } |
| enum | EDeprecatedStatusBits { kObjInCanvas = (1ULL << ( 3 )) } |
| enum | EStatusBits { kCanDelete = (1ULL << ( 0 )) , kMustCleanup = (1ULL << ( 3 )) , kIsReferenced = (1ULL << ( 4 )) , kHasUUID = (1ULL << ( 5 )) , kCannotPick = (1ULL << ( 6 )) , kNoContextMenu = (1ULL << ( 8 )) , kInvalidObject = (1ULL << ( 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. | |
| TProofOutputFile (const char *path, ERunType type, UInt_t opt=kRemote, const char *dsname=0) | |
| Main constructor. | |
| ~TProofOutputFile () override | |
| Main destructor. | |
| Int_t | AdoptFile (TFile *f) |
| Adopt a file already open. | |
| const char * | GetDir (Bool_t raw=kFALSE) const |
| 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. | |
| 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 |
| TClass * | IsA () const override |
| 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. | |
| TFile * | OpenFile (const char *opt) |
| Open the file using the unique temporary name. | |
| void | Print (Option_t *option="") const override |
| Dump the class content. | |
| void | ResetFileCollection () |
| void | SetOutputFileName (const char *name) |
| Set the name of the output file; in the form of an Url. | |
| void | SetRetrieve (Bool_t on=kTRUE) |
| void | Streamer (TBuffer &) override |
| Stream an object of class TObject. | |
| void | StreamerNVirtual (TBuffer &ClassDef_StreamerNVirtual_b) |
Public Member Functions inherited from TNamed | |
| TNamed () | |
| TNamed (const char *name, const char *title) | |
| TNamed (const TNamed &named) | |
| TNamed copy ctor. | |
| TNamed (const TString &name, const TString &title) | |
| virtual | ~TNamed () |
| TNamed destructor. | |
| void | Clear (Option_t *option="") override |
| Set name and title to empty strings (""). | |
| TObject * | Clone (const char *newname="") const override |
| Make a clone of an object using the Streamer facility. | |
| Int_t | Compare (const TObject *obj) const override |
| Compare two TNamed objects. | |
| void | Copy (TObject &named) const override |
| Copy this to obj. | |
| virtual void | FillBuffer (char *&buffer) |
| Encode TNamed into output buffer. | |
| const char * | GetName () const override |
| Returns name of object. | |
| const char * | GetTitle () const override |
| Returns title of object. | |
| ULong_t | Hash () const override |
| Return hash value for this object. | |
| Bool_t | IsSortable () const override |
| void | ls (Option_t *option="") const override |
| List TNamed name and title. | |
| TNamed & | operator= (const TNamed &rhs) |
| TNamed assignment operator. | |
| virtual void | SetName (const char *name) |
| Set the name of the TNamed. | |
| virtual void | SetNameTitle (const char *name, const char *title) |
| Set all the TNamed parameters (name and title). | |
| virtual void | SetTitle (const char *title="") |
| Set the title of the TNamed. | |
| virtual Int_t | Sizeof () const |
| Return size of the TNamed part of the TObject. | |
| void | StreamerNVirtual (TBuffer &ClassDef_StreamerNVirtual_b) |
Public Member Functions inherited from TObject | |
| TObject () | |
| TObject constructor. | |
| TObject (const TObject &object) | |
| TObject copy ctor. | |
| virtual | ~TObject () |
| TObject destructor. | |
| void | AbstractMethod (const char *method) const |
| Use this method to implement an "abstract" method that you don't want to leave purely abstract. | |
| virtual void | AppendPad (Option_t *option="") |
| Append graphics object to current pad. | |
| virtual void | Browse (TBrowser *b) |
| Browse object. May be overridden for another default action. | |
| 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. | |
| virtual const char * | ClassName () const |
| Returns name of class to which the object belongs. | |
| virtual void | Delete (Option_t *option="") |
| Delete this object. | |
| virtual Int_t | DistancetoPrimitive (Int_t px, Int_t py) |
| Computes distance from point (px,py) to the object. | |
| virtual void | Draw (Option_t *option="") |
| Default Draw method for all objects. | |
| virtual void | DrawClass () const |
| Draw class inheritance tree of the class to which this object belongs. | |
| virtual TObject * | DrawClone (Option_t *option="") const |
Draw a clone of this object in the current selected pad with: gROOT->SetSelectedPad(c1). | |
| virtual void | Dump () const |
| Dump contents of object on stdout. | |
| virtual void | Error (const char *method, const char *msgfmt,...) const |
| Issue error message. | |
| virtual void | Execute (const char *method, const char *params, Int_t *error=nullptr) |
| Execute method on this object with the given parameter string, e.g. | |
| virtual void | Execute (TMethod *method, TObjArray *params, Int_t *error=nullptr) |
| Execute method on this object with parameters stored in the TObjArray. | |
| virtual void | ExecuteEvent (Int_t event, Int_t px, Int_t py) |
| Execute action corresponding to an event at (px,py). | |
| virtual void | Fatal (const char *method, const char *msgfmt,...) const |
| Issue fatal error message. | |
| virtual TObject * | FindObject (const char *name) const |
| Must be redefined in derived classes. | |
| virtual TObject * | FindObject (const TObject *obj) const |
| Must be redefined in derived classes. | |
| virtual Option_t * | GetDrawOption () const |
| Get option used by the graphics system to draw this object. | |
| virtual const char * | GetIconName () const |
| Returns mime type name of object. | |
| virtual char * | GetObjectInfo (Int_t px, Int_t py) const |
| Returns string containing info about the object at position (px,py). | |
| virtual Option_t * | GetOption () const |
| virtual UInt_t | GetUniqueID () const |
| Return the unique object id. | |
| virtual Bool_t | HandleTimer (TTimer *timer) |
| Execute action in response of a timer timing out. | |
| 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. | |
| virtual void | Info (const char *method, const char *msgfmt,...) const |
| Issue info message. | |
| virtual Bool_t | InheritsFrom (const char *classname) const |
| Returns kTRUE if object inherits from class "classname". | |
| virtual Bool_t | InheritsFrom (const TClass *cl) const |
| Returns kTRUE if object inherits from TClass cl. | |
| virtual void | Inspect () const |
| Dump contents of this object in a graphics canvas. | |
| void | InvertBit (UInt_t f) |
| Bool_t | IsDestructed () const |
| IsDestructed. | |
| virtual Bool_t | IsEqual (const TObject *obj) const |
| Default equal comparison (objects are equal if they have the same address in memory). | |
| virtual Bool_t | IsFolder () const |
| Returns kTRUE in case object contains browsable objects (like containers or lists of other objects). | |
| 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). | |
| virtual Bool_t | Notify () |
| This method must be overridden to handle object notification (the base implementation is no-op). | |
| void | Obsolete (const char *method, const char *asOfVers, const char *removedFromVers) const |
| Use this method to declare a method obsolete. | |
| void | operator delete (void *ptr) |
| Operator delete. | |
| void | operator delete (void *ptr, void *vp) |
| Only called by placement new when throwing an exception. | |
| void | operator delete[] (void *ptr) |
| Operator delete []. | |
| void | operator delete[] (void *ptr, void *vp) |
| Only called by placement new[] when throwing an exception. | |
| void * | operator new (size_t sz) |
| void * | operator new (size_t sz, void *vp) |
| void * | operator new[] (size_t sz) |
| void * | operator new[] (size_t sz, void *vp) |
| TObject & | operator= (const TObject &rhs) |
| TObject assignment operator. | |
| virtual void | Paint (Option_t *option="") |
| This method must be overridden if a class wants to paint itself. | |
| virtual void | Pop () |
| Pop on object drawn in a pad to the top of the display list. | |
| virtual Int_t | Read (const char *name) |
| Read contents of object with specified name from the current directory. | |
| virtual void | RecursiveRemove (TObject *obj) |
| Recursively remove this object from a list. | |
| void | ResetBit (UInt_t f) |
| virtual void | SaveAs (const char *filename="", Option_t *option="") const |
| Save this object in the file specified by filename. | |
| virtual void | SavePrimitive (std::ostream &out, Option_t *option="") |
| Save a primitive as a C++ statement(s) on output stream "out". | |
| void | SetBit (UInt_t f) |
| void | SetBit (UInt_t f, Bool_t set) |
| Set or unset the user status bits as specified in f. | |
| virtual void | SetDrawOption (Option_t *option="") |
| Set drawing option for object. | |
| virtual void | SetUniqueID (UInt_t uid) |
| Set the unique object id. | |
| void | StreamerNVirtual (TBuffer &ClassDef_StreamerNVirtual_b) |
| virtual void | SysError (const char *method, const char *msgfmt,...) const |
| Issue system error message. | |
| 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. | |
| virtual void | Warning (const char *method, const char *msgfmt,...) const |
| Issue warning message. | |
| virtual Int_t | Write (const char *name=nullptr, Int_t option=0, Int_t bufsize=0) |
| Write this object to the current directory. | |
| virtual Int_t | Write (const char *name=nullptr, Int_t option=0, Int_t bufsize=0) const |
| Write this object to the current directory. | |
Static Public Member Functions | |
| static Int_t | AssertDir (const char *dirpath) |
| Assert directory path 'dirpath', with the ownership of the last already existing subpath. | |
| static TClass * | Class () |
| static const char * | Class_Name () |
| static constexpr Version_t | Class_Version () |
| static const char * | DeclFileName () |
Static Public Member Functions inherited from TNamed | |
| static TClass * | Class () |
| static const char * | Class_Name () |
| static constexpr Version_t | Class_Version () |
| static const char * | DeclFileName () |
Static Public Member Functions inherited from TObject | |
| static TClass * | Class () |
| static const char * | Class_Name () |
| static constexpr Version_t | Class_Version () |
| static const char * | DeclFileName () |
| static Longptr_t | GetDtorOnly () |
| Return destructor only flag. | |
| static Bool_t | GetObjectStat () |
| Get status of object stat flag. | |
| static void | SetDtorOnly (void *obj) |
| Set destructor only flag. | |
| static void | SetObjectStat (Bool_t stat) |
| Turn on/off tracking of objects in the TObjectTable. | |
Private Member Functions | |
| TProofOutputFile (const TProofOutputFile &) | |
| void | AddFile (TFileMerger *merger, const char *path) |
| Add file to merger, checking the result. | |
| void | Init (const char *path, const char *dsname) |
| Initializer. Called by all constructors. | |
| void | NotifyError (const char *errmsg) |
| Notify error message. | |
| 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) |
| void | Unlink (const char *path) |
| Unlink path. | |
Friends | |
| class | TProof |
| class | TProofPlayer |
| class | TProofPlayerRemote |
Additional Inherited Members | |
Protected Types inherited from TObject | |
| enum | { kOnlyPrepStep = (1ULL << ( 3 )) } |
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). | |
| void | MakeZombie () |
Protected Attributes inherited from TNamed | |
| TString | fName |
| TString | fTitle |
#include <TProofOutputFile.h>
| Enumerator | |
|---|---|
| kMerge | |
| kDataset | |
Definition at line 40 of file TProofOutputFile.h.
| Enumerator | |
|---|---|
| kOutputFileNameSet | |
| kRetrieve | |
| kSwapFile | |
Definition at line 82 of file TProofOutputFile.h.
| Enumerator | |
|---|---|
| kRemote | |
| kLocal | |
| kCreate | |
| kRegister | |
| kOverwrite | |
| kVerify | |
Definition at line 42 of file TProofOutputFile.h.
|
private |
|
inline |
Definition at line 88 of file TProofOutputFile.h.
| 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::TProofOutputFile | ( | const char * | path, |
| ERunType | type, | ||
| UInt_t | opt = kRemote, |
||
| const char * | dsname = 0 |
||
| ) |
Main constructor.
Definition at line 40 of file TProofOutputFile.cxx.
|
override |
Main destructor.
Definition at line 232 of file TProofOutputFile.cxx.
|
private |
Add file to merger, checking the result.
Definition at line 467 of file TProofOutputFile.cxx.
Adopt a file already open.
Return 0 if OK, -1 in case of failure
Definition at line 274 of file TProofOutputFile.cxx.
|
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.
|
static |
|
inlinestaticconstexpr |
Definition at line 124 of file TProofOutputFile.h.
|
inlinestatic |
Definition at line 124 of file TProofOutputFile.h.
Definition at line 96 of file TProofOutputFile.h.
| TFileCollection * TProofOutputFile::GetFileCollection | ( | ) |
Get instance of the file collection to be used in 'dataset' mode.
Definition at line 493 of file TProofOutputFile.cxx.
| 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.
|
inline |
Definition at line 99 of file TProofOutputFile.h.
|
inline |
Definition at line 100 of file TProofOutputFile.h.
|
inline |
Definition at line 101 of file TProofOutputFile.h.
|
inline |
Definition at line 102 of file TProofOutputFile.h.
|
inline |
Definition at line 105 of file TProofOutputFile.h.
|
inline |
Definition at line 106 of file TProofOutputFile.h.
|
inline |
Definition at line 103 of file TProofOutputFile.h.
|
private |
Initializer. Called by all constructors.
Definition at line 101 of file TProofOutputFile.cxx.
|
inlineoverridevirtual |
Reimplemented from TNamed.
Definition at line 124 of file TProofOutputFile.h.
|
inline |
Definition at line 107 of file TProofOutputFile.h.
|
inline |
Definition at line 108 of file TProofOutputFile.h.
|
inline |
Definition at line 109 of file TProofOutputFile.h.
|
inline |
Definition at line 111 of file TProofOutputFile.h.
| Long64_t TProofOutputFile::Merge | ( | TCollection * | list | ) |
Merge objects from the list into this object.
Definition at line 314 of file TProofOutputFile.cxx.
|
private |
Notify error message.
Definition at line 450 of file TProofOutputFile.cxx.
| TFile * TProofOutputFile::OpenFile | ( | const char * | opt | ) |
Open the file using the unique temporary name.
Definition at line 256 of file TProofOutputFile.cxx.
|
private |
|
overridevirtual |
Dump the class content.
Reimplemented from TNamed.
Definition at line 422 of file TProofOutputFile.cxx.
|
inline |
Definition at line 120 of file TProofOutputFile.h.
Definition at line 71 of file TProofOutputFile.h.
|
inlineprivate |
Definition at line 70 of file TProofOutputFile.h.
Definition at line 72 of file TProofOutputFile.h.
| 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.
Definition at line 112 of file TProofOutputFile.h.
|
inlineprivate |
Definition at line 73 of file TProofOutputFile.h.
|
overridevirtual |
|
inline |
Definition at line 124 of file TProofOutputFile.h.
|
private |
Unlink path.
Definition at line 479 of file TProofOutputFile.cxx.
|
friend |
Definition at line 35 of file TProofOutputFile.h.
|
friend |
Definition at line 36 of file TProofOutputFile.h.
|
friend |
Definition at line 37 of file TProofOutputFile.h.
|
private |
Definition at line 66 of file TProofOutputFile.h.
|
private |
Definition at line 53 of file TProofOutputFile.h.
|
private |
Definition at line 55 of file TProofOutputFile.h.
|
private |
Definition at line 60 of file TProofOutputFile.h.
|
private |
Definition at line 59 of file TProofOutputFile.h.
|
private |
Definition at line 61 of file TProofOutputFile.h.
|
private |
Definition at line 64 of file TProofOutputFile.h.
|
private |
Definition at line 67 of file TProofOutputFile.h.
|
private |
Definition at line 56 of file TProofOutputFile.h.
|
private |
Definition at line 57 of file TProofOutputFile.h.
|
private |
Definition at line 54 of file TProofOutputFile.h.
|
private |
Definition at line 62 of file TProofOutputFile.h.
|
private |
Definition at line 63 of file TProofOutputFile.h.
|
private |
Definition at line 58 of file TProofOutputFile.h.