Logo ROOT  
Reference Guide
TVirtualPerfStats Class Referenceabstract

Provides the interface for the PROOF internal performance measurement and event tracing.

Definition at line 32 of file TVirtualPerfStats.h.

Public Types

enum  EEventType {
  kUnDefined , kPacket , kStart , kStop ,
  kFile , kFileOpen , kFileRead , kRate ,
  kNumEventType
}
 
- 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

virtual ~TVirtualPerfStats ()
 
virtual void FileEvent (const char *slave, const char *slavename, const char *nodename, const char *filename, Bool_t isStart)=0
 
virtual void FileOpenEvent (TFile *file, const char *filename, Double_t start)=0
 
virtual void FileReadEvent (TFile *file, Int_t len, Double_t start)=0
 
virtual Long64_t GetBytesRead () const =0
 
virtual Long64_t GetNumEvents () const =0
 
virtual void PacketEvent (const char *slave, const char *slavename, const char *filename, Long64_t eventsprocessed, Double_t latency, Double_t proctime, Double_t cputime, Long64_t bytesRead)=0
 
virtual void PrintBasketInfo (Option_t *option="") const =0
 
virtual void RateEvent (Double_t proctime, Double_t deltatime, Long64_t eventsprocessed, Long64_t bytesRead)=0
 
virtual void SetBytesRead (Long64_t num)=0
 
virtual void SetLoaded (size_t bi, size_t basketNumber)=0
 
virtual void SetLoaded (TBranch *b, size_t basketNumber)=0
 
virtual void SetLoadedMiss (size_t bi, size_t basketNumber)=0
 
virtual void SetLoadedMiss (TBranch *b, size_t basketNumber)=0
 
virtual void SetMissed (size_t bi, size_t basketNumber)=0
 
virtual void SetMissed (TBranch *b, size_t basketNumber)=0
 
virtual void SetNumEvents (Long64_t num)=0
 
virtual void SetUsed (size_t bi, size_t basketNumber)=0
 
virtual void SetUsed (TBranch *b, size_t basketNumber)=0
 
virtual void SimpleEvent (EEventType type)=0
 
virtual void UnzipEvent (TObject *tree, Long64_t pos, Double_t start, Int_t complen, Int_t objlen)=0
 
virtual void UpdateBranchIndices (TObjArray *branches)=0
 
- 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 Clear (Option_t *="")
 
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 abstract method. More...
 
virtual void Copy (TObject &object) const
 Copy this to obj. 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 const char * GetName () const
 Returns 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 const char * GetTitle () const
 Returns title of object. More...
 
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...
 
virtual ULong_t Hash () const
 Return hash value for this object. 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
 
virtual Bool_t IsSortable () const
 
R__ALWAYS_INLINE Bool_t IsZombie () const
 
virtual void ls (Option_t *option="") const
 The ls function lists the contents of a class on stdout. More...
 
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 void Print (Option_t *option="") const
 This method must be overridden when a class wants to print itself. 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 TVirtualPerfStats *& CurrentPerfStats ()
 Return the current ROOT perf stats if any. More...
 
static const char * EventType (EEventType type)
 Return the name of the event type. 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...
 

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 ()
 

#include <TVirtualPerfStats.h>

Inheritance diagram for TVirtualPerfStats:
[legend]

Member Enumeration Documentation

◆ EEventType

Enumerator
kUnDefined 
kPacket 
kStart 
kStop 
kFile 
kFileOpen 
kFileRead 
kRate 
kNumEventType 

Definition at line 37 of file TVirtualPerfStats.h.

Constructor & Destructor Documentation

◆ ~TVirtualPerfStats()

virtual TVirtualPerfStats::~TVirtualPerfStats ( )
inlinevirtual

Definition at line 35 of file TVirtualPerfStats.h.

Member Function Documentation

◆ CurrentPerfStats()

TVirtualPerfStats *& TVirtualPerfStats::CurrentPerfStats ( )
static

Return the current ROOT perf stats if any.

Definition at line 41 of file TVirtualPerfStats.cxx.

◆ EventType()

const char * TVirtualPerfStats::EventType ( EEventType  type)
static

Return the name of the event type.

Definition at line 54 of file TVirtualPerfStats.cxx.

◆ FileEvent()

virtual void TVirtualPerfStats::FileEvent ( const char *  slave,
const char *  slavename,
const char *  nodename,
const char *  filename,
Bool_t  isStart 
)
pure virtual

Implemented in TTreePerfStats, and TPerfStats.

◆ FileOpenEvent()

virtual void TVirtualPerfStats::FileOpenEvent ( TFile file,
const char *  filename,
Double_t  start 
)
pure virtual

Implemented in TTreePerfStats, and TPerfStats.

◆ FileReadEvent()

virtual void TVirtualPerfStats::FileReadEvent ( TFile file,
Int_t  len,
Double_t  start 
)
pure virtual

Implemented in TPerfStats, and TTreePerfStats.

◆ GetBytesRead()

virtual Long64_t TVirtualPerfStats::GetBytesRead ( ) const
pure virtual

Implemented in TPerfStats, and TTreePerfStats.

◆ GetNumEvents()

virtual Long64_t TVirtualPerfStats::GetNumEvents ( ) const
pure virtual

Implemented in TPerfStats, and TTreePerfStats.

◆ PacketEvent()

virtual void TVirtualPerfStats::PacketEvent ( const char *  slave,
const char *  slavename,
const char *  filename,
Long64_t  eventsprocessed,
Double_t  latency,
Double_t  proctime,
Double_t  cputime,
Long64_t  bytesRead 
)
pure virtual

Implemented in TTreePerfStats, and TPerfStats.

◆ PrintBasketInfo()

virtual void TVirtualPerfStats::PrintBasketInfo ( Option_t option = "") const
pure virtual

Implemented in TPerfStats, and TTreePerfStats.

◆ RateEvent()

virtual void TVirtualPerfStats::RateEvent ( Double_t  proctime,
Double_t  deltatime,
Long64_t  eventsprocessed,
Long64_t  bytesRead 
)
pure virtual

Implemented in TPerfStats, and TTreePerfStats.

◆ SetBytesRead()

virtual void TVirtualPerfStats::SetBytesRead ( Long64_t  num)
pure virtual

Implemented in TTreePerfStats, and TPerfStats.

◆ SetLoaded() [1/2]

virtual void TVirtualPerfStats::SetLoaded ( size_t  bi,
size_t  basketNumber 
)
pure virtual

Implemented in TTreePerfStats, and TPerfStats.

◆ SetLoaded() [2/2]

virtual void TVirtualPerfStats::SetLoaded ( TBranch b,
size_t  basketNumber 
)
pure virtual

Implemented in TPerfStats, and TTreePerfStats.

◆ SetLoadedMiss() [1/2]

virtual void TVirtualPerfStats::SetLoadedMiss ( size_t  bi,
size_t  basketNumber 
)
pure virtual

Implemented in TTreePerfStats, and TPerfStats.

◆ SetLoadedMiss() [2/2]

virtual void TVirtualPerfStats::SetLoadedMiss ( TBranch b,
size_t  basketNumber 
)
pure virtual

Implemented in TPerfStats, and TTreePerfStats.

◆ SetMissed() [1/2]

virtual void TVirtualPerfStats::SetMissed ( size_t  bi,
size_t  basketNumber 
)
pure virtual

Implemented in TTreePerfStats, and TPerfStats.

◆ SetMissed() [2/2]

virtual void TVirtualPerfStats::SetMissed ( TBranch b,
size_t  basketNumber 
)
pure virtual

Implemented in TPerfStats, and TTreePerfStats.

◆ SetNumEvents()

virtual void TVirtualPerfStats::SetNumEvents ( Long64_t  num)
pure virtual

Implemented in TPerfStats, and TTreePerfStats.

◆ SetUsed() [1/2]

virtual void TVirtualPerfStats::SetUsed ( size_t  bi,
size_t  basketNumber 
)
pure virtual

Implemented in TTreePerfStats, and TPerfStats.

◆ SetUsed() [2/2]

virtual void TVirtualPerfStats::SetUsed ( TBranch b,
size_t  basketNumber 
)
pure virtual

Implemented in TPerfStats, and TTreePerfStats.

◆ SimpleEvent()

virtual void TVirtualPerfStats::SimpleEvent ( EEventType  type)
pure virtual

Implemented in TPerfStats, and TTreePerfStats.

◆ UnzipEvent()

virtual void TVirtualPerfStats::UnzipEvent ( TObject tree,
Long64_t  pos,
Double_t  start,
Int_t  complen,
Int_t  objlen 
)
pure virtual

Implemented in TPerfStats, and TTreePerfStats.

◆ UpdateBranchIndices()

virtual void TVirtualPerfStats::UpdateBranchIndices ( TObjArray branches)
pure virtual

Implemented in TPerfStats, and TTreePerfStats.


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