Logo ROOT  
Reference Guide
 
All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Modules Pages
Loading...
Searching...
No Matches
TProofLog Class Reference

Implementation of the PROOF session log handler.

Definition at line 32 of file TProofLog.h.

Public Types

enum  ELogLocationBit { kLogToBox = (1ULL << ( 16 )) }
 
enum  ERetrieveOpt { kLeading = 0x1 , kTrailing = 0x2 , kAll = 0x3 , kGrep = 0x4 }
 
- 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

 TProofLog (const char *stag, const char *url, TProofMgr *mgr)
 Constructor.
 
 ~TProofLog () override
 Destructor.
 
void Display (const char *ord="*", Int_t from=-10, Int_t to=-1)
 Display the content associated with worker 'ord' from line 'from' to line 'to' inclusive.
 
TListGetListOfLogs () const
 
Int_t Grep (const char *txt, Int_t from=0)
 Search lines containing 'txt', starting from line 'from'.
 
TClassIsA () const override
 
Bool_t LogToBox ()
 
void Print (Option_t *opt=0) const override
 Print head info about the content.
 
void Prt (const char *what, Bool_t newline=kTRUE)
 Special printing procedure.
 
Int_t Retrieve (const char *ord="*", TProofLog::ERetrieveOpt opt=TProofLog::kTrailing, const char *fname=0, const char *pattern=0)
 Retrieve the content of the log file associated with worker 'ord'.
 
Int_t Save (const char *ord="*", const char *fname=0, Option_t *opt="w")
 Save the content associated with worker 'ord' to finel 'fname'.
 
void SetLogToBox (Bool_t lgbox=kFALSE)
 
TDatime StartTime ()
 
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 ("").
 
TObjectClone (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.
 
TNamedoperator= (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 TObjectDrawClone (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 TObjectFindObject (const char *name) const
 Must be redefined in derived classes.
 
virtual TObjectFindObject (const TObject *obj) const
 Must be redefined in derived classes.
 
virtual Option_tGetDrawOption () 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_tGetOption () 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)
 
TObjectoperator= (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.
 
- Public Member Functions inherited from TQObject
 TQObject ()
 TQObject Constructor.
 
virtual ~TQObject ()
 TQObject Destructor.
 
Bool_t AreSignalsBlocked () const
 
Bool_t BlockSignals (Bool_t b)
 
virtual void ChangedBy (const char *method)
 
void CollectClassSignalLists (TList &list, TClass *cls)
 Collect class signal lists from class cls and all its base-classes.
 
Bool_t Connect (const char *signal, const char *receiver_class, void *receiver, const char *slot)
 Non-static method is used to connect from the signal of this object to the receiver slot.
 
virtual void Connected (const char *)
 
virtual void Destroyed ()
 
Bool_t Disconnect (const char *signal=nullptr, void *receiver=nullptr, const char *slot=nullptr)
 Disconnects signal of this object from slot of receiver.
 
virtual void Disconnected (const char *)
 
void Emit (const char *signal)
 Activate signal without args.
 
template<typename T >
void Emit (const char *signal, const T &arg)
 Activate signal with single parameter.
 
template<typename... T>
void EmitVA (const char *signal_name, Int_t, const T &... params)
 Emit a signal with a varying number of arguments.
 
TListGetListOfClassSignals () const
 Returns pointer to list of signals of this class.
 
TListGetListOfConnections () const
 
TListGetListOfSignals () const
 
virtual Bool_t HasConnection (const char *signal_name) const
 Return true if there is any object connected to this signal.
 
virtual void HighPriority (const char *signal_name, const char *slot_name=nullptr)
 
virtual void LowPriority (const char *signal_name, const char *slot_name=nullptr)
 
virtual void Message (const char *msg)
 
virtual Int_t NumberOfConnections () const
 Return number of connections for this object.
 
virtual Int_t NumberOfSignals () const
 Return number of signals for this object.
 
void StreamerNVirtual (TBuffer &ClassDef_StreamerNVirtual_b)
 

Static Public Member Functions

static TClassClass ()
 
static const char * Class_Name ()
 
static constexpr Version_t Class_Version ()
 
static const char * DeclFileName ()
 
static void SetMaxTransferSize (Long64_t maxsz)
 Set max transfer size.
 
- Static Public Member Functions inherited from TNamed
static TClassClass ()
 
static const char * Class_Name ()
 
static constexpr Version_t Class_Version ()
 
static const char * DeclFileName ()
 
- Static Public Member Functions inherited from TObject
static TClassClass ()
 
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.
 
- Static Public Member Functions inherited from TQObject
static Bool_t AreAllSignalsBlocked ()
 Returns true if all signals are blocked.
 
static Bool_t BlockAllSignals (Bool_t b)
 Block or unblock all signals. Returns the previous block status.
 
static TClassClass ()
 
static const char * Class_Name ()
 
static constexpr Version_t Class_Version ()
 
static Bool_t Connect (const char *sender_class, const char *signal, const char *receiver_class, void *receiver, const char *slot)
 This method allows to make a connection from any object of the same class to a single slot.
 
static Bool_t Connect (TQObject *sender, const char *signal, const char *receiver_class, void *receiver, const char *slot)
 Create connection between sender and receiver.
 
static const char * DeclFileName ()
 
static Bool_t Disconnect (const char *class_name, const char *signal, void *receiver=nullptr, const char *slot=nullptr)
 Disconnects "class signal".
 
static Bool_t Disconnect (TQObject *sender, const char *signal=nullptr, void *receiver=nullptr, const char *slot=nullptr)
 Disconnects signal in object sender from slot_method in object receiver.
 

Private Member Functions

TProofLogElemAdd (const char *ord, const char *url)
 Add new entry to the list of elements.
 

Private Attributes

TListfElem
 
void * fFILE
 
TProofMgrfMgr
 
TDatime fStartTime
 

Friends

class TProofLogElem
 
class TProofMgrLite
 
class TXProofMgr
 

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 Member Functions inherited from TQObject
virtual void * GetSender ()
 
virtual const char * GetSenderClassName () const
 
- Static Protected Member Functions inherited from TQObject
static Int_t CheckConnectArgs (TQObject *sender, TClass *sender_class, const char *signal, TClass *receiver_class, const char *slot)
 Checking of consistency of sender/receiver methods/arguments.
 
static TString CompressName (const char *method_name)
 Removes "const" words and blanks from full (with prototype) method name and resolve any typedefs in the method signature.
 
static Bool_t ConnectToClass (const char *sender_class, const char *signal, TClass *receiver_class, void *receiver, const char *slot)
 This method allows to make connection from any object of the same class to the receiver object.
 
static Bool_t ConnectToClass (TQObject *sender, const char *signal, TClass *receiver_class, void *receiver, const char *slot)
 Create connection between sender and receiver.
 
- Protected Attributes inherited from TNamed
TString fName
 
TString fTitle
 
- Protected Attributes inherited from TQObject
TListfListOfConnections
 list of signals from this object
 
TListfListOfSignals
 
Bool_t fSignalsBlocked
 list of connections to this object
 
- Static Protected Attributes inherited from TQObject
static Bool_t fgAllSignalsBlocked = kFALSE
 flag used for suppression of signals
 

#include <TProofLog.h>

Inheritance diagram for TProofLog:
[legend]

Member Enumeration Documentation

◆ ELogLocationBit

Enumerator
kLogToBox 

Definition at line 48 of file TProofLog.h.

◆ ERetrieveOpt

Enumerator
kLeading 
kTrailing 
kAll 
kGrep 

Definition at line 51 of file TProofLog.h.

Constructor & Destructor Documentation

◆ TProofLog()

TProofLog::TProofLog ( const char * stag,
const char * url,
TProofMgr * mgr )

Constructor.

Definition at line 31 of file TProofLog.cxx.

◆ ~TProofLog()

TProofLog::~TProofLog ( )
override

Destructor.

Definition at line 59 of file TProofLog.cxx.

Member Function Documentation

◆ Add()

TProofLogElem * TProofLog::Add ( const char * ord,
const char * url )
private

Add new entry to the list of elements.

Definition at line 67 of file TProofLog.cxx.

◆ Class()

static TClass * TProofLog::Class ( )
static
Returns
TClass describing this class

◆ Class_Name()

static const char * TProofLog::Class_Name ( )
static
Returns
Name of this class

◆ Class_Version()

static constexpr Version_t TProofLog::Class_Version ( )
inlinestaticconstexpr
Returns
Version of this class

Definition at line 75 of file TProofLog.h.

◆ DeclFileName()

static const char * TProofLog::DeclFileName ( )
inlinestatic
Returns
Name of the file containing the class declaration

Definition at line 75 of file TProofLog.h.

◆ Display()

void TProofLog::Display ( const char * ord = "*",
Int_t from = -10,
Int_t to = -1 )

Display the content associated with worker 'ord' from line 'from' to line 'to' inclusive.

A negative value for 'from' indicates lines counted from the end (tail action); 'to' is ignored in such a case. If 'ord' is "*" (default), all the workers are displayed.

Definition at line 131 of file TProofLog.cxx.

◆ GetListOfLogs()

TList * TProofLog::GetListOfLogs ( ) const
inline

Definition at line 58 of file TProofLog.h.

◆ Grep()

Int_t TProofLog::Grep ( const char * txt,
Int_t from = 0 )

Search lines containing 'txt', starting from line 'from'.

Print the lines where this happens.

Definition at line 261 of file TProofLog.cxx.

◆ IsA()

TClass * TProofLog::IsA ( ) const
inlineoverridevirtual
Returns
TClass describing current object

Reimplemented from TNamed.

Definition at line 75 of file TProofLog.h.

◆ LogToBox()

Bool_t TProofLog::LogToBox ( )
inline

Definition at line 71 of file TProofLog.h.

◆ Print()

void TProofLog::Print ( Option_t * opt = 0) const
overridevirtual

Print head info about the content.

Reimplemented from TNamed.

Definition at line 158 of file TProofLog.cxx.

◆ Prt()

void TProofLog::Prt ( const char * what,
Bool_t newline = kTRUE )

Special printing procedure.

Definition at line 181 of file TProofLog.cxx.

◆ Retrieve()

Int_t TProofLog::Retrieve ( const char * ord = "*",
TProofLog::ERetrieveOpt opt = TProofLog::kTrailing,
const char * fname = 0,
const char * pattern = 0 )

Retrieve the content of the log file associated with worker 'ord'.

If 'ord' is "*" (default), all the workers are retrieved. If 'all' is true, the whole files are retrieved; else a max of fgMaxTransferSize (about 1000 lines) per file is read, starting from the end (i.e. the last ~1000 lines). The received buffer is added to the file fname, if the latter is defined. If opt == TProofLog::kGrep only the lines containing 'pattern' are retrieved (remote grep functionality); to filter out a pattern 'pat' use pattern = "-v pat". Return 0 on success, -1 in case of any error.

Definition at line 87 of file TProofLog.cxx.

◆ Save()

Int_t TProofLog::Save ( const char * ord = "*",
const char * fname = 0,
Option_t * opt = "w" )

Save the content associated with worker 'ord' to finel 'fname'.

If 'ord' is "*" (default), the log from all the workers is saved. If 'opt' is "a" the file is open in append mode; otherwise the file is truncated.

Definition at line 201 of file TProofLog.cxx.

◆ SetLogToBox()

void TProofLog::SetLogToBox ( Bool_t lgbox = kFALSE)
inline

Definition at line 70 of file TProofLog.h.

◆ SetMaxTransferSize()

void TProofLog::SetMaxTransferSize ( Long64_t maxsz)
static

Set max transfer size.

Definition at line 304 of file TProofLog.cxx.

◆ StartTime()

TDatime TProofLog::StartTime ( )
inline

Definition at line 67 of file TProofLog.h.

◆ Streamer()

void TProofLog::Streamer ( TBuffer & R__b)
overridevirtual

Stream an object of class TObject.

Reimplemented from TNamed.

◆ StreamerNVirtual()

void TProofLog::StreamerNVirtual ( TBuffer & ClassDef_StreamerNVirtual_b)
inline

Definition at line 75 of file TProofLog.h.

Friends And Related Symbol Documentation

◆ TProofLogElem

friend class TProofLogElem
friend

Definition at line 34 of file TProofLog.h.

◆ TProofMgrLite

friend class TProofMgrLite
friend

Definition at line 35 of file TProofLog.h.

◆ TXProofMgr

friend class TXProofMgr
friend

Definition at line 36 of file TProofLog.h.

Member Data Documentation

◆ fElem

TList* TProofLog::fElem
private

Definition at line 41 of file TProofLog.h.

◆ fFILE

void* TProofLog::fFILE
private

Definition at line 40 of file TProofLog.h.

◆ fMgr

TProofMgr* TProofLog::fMgr
private

Definition at line 39 of file TProofLog.h.

◆ fStartTime

TDatime TProofLog::fStartTime
private

Definition at line 42 of file TProofLog.h.

  • proof/proof/inc/TProofLog.h
  • proof/proof/src/TProofLog.cxx