Logo ROOT  
Reference Guide
 
Loading...
Searching...
No Matches
TProofProgressStatus Class Reference

Container class for processing statistics.

Definition at line 25 of file TProofProgressStatus.h.

Public Types

enum  EStatusBits { kFileNotOpen = (1ULL << ( 15 )) , kFileCorrupted = (1ULL << ( 16 )) }
 
- 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

 TProofProgressStatus (Long64_t fEntries=0, Long64_t fBytesRead=0, Long64_t fReadCalls=0, Double_t fProcTime=0, Double_t fCPUTime=0)
 Main and default constructor.
 
Long64_t GetBytesRead () const
 
Double_t GetCPUTime () const
 
Double_t GetCurrentRate () const
 Get current rate. Rteunr the average rate if the current is not defined.
 
Long64_t GetEntries () const
 
Double_t GetLastUpdate () const
 
Double_t GetLearnTime () const
 
Double_t GetProcTime () const
 
Double_t GetRate () const
 
Long64_t GetReadCalls () const
 
void IncBytesRead (Long64_t bytesRead)
 
void IncCPUTime (Double_t procTime)
 
void IncEntries (Long64_t entries=1)
 
void IncProcTime (Double_t procTime)
 
void IncReadCalls (Long64_t readCalls)
 
TClassIsA () const override
 
TProofProgressStatusoperator+= (const TProofProgressStatus &st)
 '+=' operator
 
TProofProgressStatus operator- (TProofProgressStatus &st)
 '-' operator
 
TProofProgressStatusoperator-= (const TProofProgressStatus &st)
 '-=' operator
 
void Print (Option_t *option="") const override
 Dump the content.
 
void Reset ()
 
void SetBytesRead (Long64_t bytesRead)
 
void SetCPUTime (Double_t procTime)
 
void SetEntries (Long64_t entries)
 
void SetLastEntries (Long64_t entries)
 
void SetLastProcTime (Double_t procTime)
 
void SetLastUpdate (Double_t updtTime=0)
 Update time stamp either with the passed value (if > 0) or with the current time.
 
void SetLearnTime (Double_t learnTime)
 
void SetProcTime (Double_t procTime)
 
void SetReadCalls (Long64_t readCalls)
 
void Streamer (TBuffer &) override
 Stream an object of class 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 Clear (Option_t *="")
 
virtual TObjectClone (const char *newname="") const
 Make a clone of an object using the Streamer facility.
 
virtual Int_t Compare (const TObject *obj) const
 Compare abstract method.
 
virtual void Copy (TObject &object) const
 Copy this to obj.
 
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 const char * GetName () const
 Returns 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 const char * GetTitle () const
 Returns title of object.
 
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.
 
virtual ULong_t Hash () const
 Return hash value for this object.
 
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
 
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.
 
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.
 

Static Public Member Functions

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.
 

Private Attributes

Long64_t fBytesRead
 
Double_t fCPUTime
 
Long64_t fEntries
 
Long64_t fLastEntries
 
Double_t fLastProcTime
 
Double_t fLastUpdate
 
Double_t fLearnTime
 
Double_t fProcTime
 
Long64_t fReadCalls
 

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

#include <TProofProgressStatus.h>

Inheritance diagram for TProofProgressStatus:
[legend]

Member Enumeration Documentation

◆ EStatusBits

Enumerator
kFileNotOpen 
kFileCorrupted 

Definition at line 27 of file TProofProgressStatus.h.

Constructor & Destructor Documentation

◆ TProofProgressStatus()

TProofProgressStatus::TProofProgressStatus ( Long64_t  fEntries = 0,
Long64_t  fBytesRead = 0,
Long64_t  fReadCalls = 0,
Double_t  fProcTime = 0,
Double_t  fCPUTime = 0 
)

Main and default constructor.

Definition at line 30 of file TProofProgressStatus.cxx.

Member Function Documentation

◆ Class()

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

◆ Class_Name()

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

◆ Class_Version()

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

Definition at line 76 of file TProofProgressStatus.h.

◆ DeclFileName()

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

Definition at line 76 of file TProofProgressStatus.h.

◆ GetBytesRead()

Long64_t TProofProgressStatus::GetBytesRead ( ) const
inline

Definition at line 48 of file TProofProgressStatus.h.

◆ GetCPUTime()

Double_t TProofProgressStatus::GetCPUTime ( ) const
inline

Definition at line 52 of file TProofProgressStatus.h.

◆ GetCurrentRate()

Double_t TProofProgressStatus::GetCurrentRate ( ) const

Get current rate. Rteunr the average rate if the current is not defined.

Definition at line 117 of file TProofProgressStatus.cxx.

◆ GetEntries()

Long64_t TProofProgressStatus::GetEntries ( ) const
inline

Definition at line 47 of file TProofProgressStatus.h.

◆ GetLastUpdate()

Double_t TProofProgressStatus::GetLastUpdate ( ) const
inline

Definition at line 53 of file TProofProgressStatus.h.

◆ GetLearnTime()

Double_t TProofProgressStatus::GetLearnTime ( ) const
inline

Definition at line 50 of file TProofProgressStatus.h.

◆ GetProcTime()

Double_t TProofProgressStatus::GetProcTime ( ) const
inline

Definition at line 51 of file TProofProgressStatus.h.

◆ GetRate()

Double_t TProofProgressStatus::GetRate ( ) const
inline

Definition at line 54 of file TProofProgressStatus.h.

◆ GetReadCalls()

Long64_t TProofProgressStatus::GetReadCalls ( ) const
inline

Definition at line 49 of file TProofProgressStatus.h.

◆ IncBytesRead()

void TProofProgressStatus::IncBytesRead ( Long64_t  bytesRead)
inline

Definition at line 59 of file TProofProgressStatus.h.

◆ IncCPUTime()

void TProofProgressStatus::IncCPUTime ( Double_t  procTime)
inline

Definition at line 68 of file TProofProgressStatus.h.

◆ IncEntries()

void TProofProgressStatus::IncEntries ( Long64_t  entries = 1)
inline

Definition at line 58 of file TProofProgressStatus.h.

◆ IncProcTime()

void TProofProgressStatus::IncProcTime ( Double_t  procTime)
inline

Definition at line 66 of file TProofProgressStatus.h.

◆ IncReadCalls()

void TProofProgressStatus::IncReadCalls ( Long64_t  readCalls)
inline

Definition at line 61 of file TProofProgressStatus.h.

◆ IsA()

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

Reimplemented from TObject.

Definition at line 76 of file TProofProgressStatus.h.

◆ operator+=()

TProofProgressStatus & TProofProgressStatus::operator+= ( const TProofProgressStatus st)

'+=' operator

Definition at line 50 of file TProofProgressStatus.cxx.

◆ operator-()

TProofProgressStatus TProofProgressStatus::operator- ( TProofProgressStatus st)

'-' operator

Definition at line 84 of file TProofProgressStatus.cxx.

◆ operator-=()

TProofProgressStatus & TProofProgressStatus::operator-= ( const TProofProgressStatus st)

'-=' operator

Definition at line 68 of file TProofProgressStatus.cxx.

◆ Print()

void TProofProgressStatus::Print ( Option_t option = "") const
overridevirtual

Dump the content.

Reimplemented from TObject.

Definition at line 92 of file TProofProgressStatus.cxx.

◆ Reset()

void TProofProgressStatus::Reset ( )
inline

Definition at line 44 of file TProofProgressStatus.h.

◆ SetBytesRead()

void TProofProgressStatus::SetBytesRead ( Long64_t  bytesRead)
inline

Definition at line 60 of file TProofProgressStatus.h.

◆ SetCPUTime()

void TProofProgressStatus::SetCPUTime ( Double_t  procTime)
inline

Definition at line 67 of file TProofProgressStatus.h.

◆ SetEntries()

void TProofProgressStatus::SetEntries ( Long64_t  entries)
inline

Definition at line 57 of file TProofProgressStatus.h.

◆ SetLastEntries()

void TProofProgressStatus::SetLastEntries ( Long64_t  entries)
inline

Definition at line 56 of file TProofProgressStatus.h.

◆ SetLastProcTime()

void TProofProgressStatus::SetLastProcTime ( Double_t  procTime)
inline

Definition at line 64 of file TProofProgressStatus.h.

◆ SetLastUpdate()

void TProofProgressStatus::SetLastUpdate ( Double_t  updtTime = 0)

Update time stamp either with the passed value (if > 0) or with the current time.

Definition at line 104 of file TProofProgressStatus.cxx.

◆ SetLearnTime()

void TProofProgressStatus::SetLearnTime ( Double_t  learnTime)
inline

Definition at line 63 of file TProofProgressStatus.h.

◆ SetProcTime()

void TProofProgressStatus::SetProcTime ( Double_t  procTime)
inline

Definition at line 65 of file TProofProgressStatus.h.

◆ SetReadCalls()

void TProofProgressStatus::SetReadCalls ( Long64_t  readCalls)
inline

Definition at line 62 of file TProofProgressStatus.h.

◆ Streamer()

void TProofProgressStatus::Streamer ( TBuffer R__b)
overridevirtual

Stream an object of class TObject.

Reimplemented from TObject.

◆ StreamerNVirtual()

void TProofProgressStatus::StreamerNVirtual ( TBuffer ClassDef_StreamerNVirtual_b)
inline

Definition at line 76 of file TProofProgressStatus.h.

Member Data Documentation

◆ fBytesRead

Long64_t TProofProgressStatus::fBytesRead
private

Definition at line 33 of file TProofProgressStatus.h.

◆ fCPUTime

Double_t TProofProgressStatus::fCPUTime
private

Definition at line 38 of file TProofProgressStatus.h.

◆ fEntries

Long64_t TProofProgressStatus::fEntries
private

Definition at line 32 of file TProofProgressStatus.h.

◆ fLastEntries

Long64_t TProofProgressStatus::fLastEntries
private

Definition at line 31 of file TProofProgressStatus.h.

◆ fLastProcTime

Double_t TProofProgressStatus::fLastProcTime
private

Definition at line 36 of file TProofProgressStatus.h.

◆ fLastUpdate

Double_t TProofProgressStatus::fLastUpdate
private

Definition at line 39 of file TProofProgressStatus.h.

◆ fLearnTime

Double_t TProofProgressStatus::fLearnTime
private

Definition at line 35 of file TProofProgressStatus.h.

◆ fProcTime

Double_t TProofProgressStatus::fProcTime
private

Definition at line 37 of file TProofProgressStatus.h.

◆ fReadCalls

Long64_t TProofProgressStatus::fReadCalls
private

Definition at line 34 of file TProofProgressStatus.h.

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