Logo ROOT  
Reference Guide
No Matches
TStatus Class Reference

This class holds the status of an ongoing operation and collects error messages.

It provides a Merge() operation allowing it to be used in PROOF to monitor status in the slaves. No messages indicates success.

Definition at line 32 of file TStatus.h.

Public Types

enum  EProcStatus { kNotOk = BIT(15) }
- 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

 TStatus ()
 Default constructor.
virtual ~TStatus ()
void Add (const char *mesg)
 Add an error message.
void AddInfo (const char *mesg)
 Add an info message.
Int_t GetExitStatus () const
Long_t GetResMemMax (Bool_t master=kFALSE) const
Long_t GetVirtMemMax (Bool_t master=kFALSE) const
Bool_t IsOk () const
virtual Int_t Merge (TCollection *list)
 PROOF Merge() function.
const char * NextMesg ()
 Return the next message or 0.
virtual void Print (Option_t *option="") const
 Standard print function.
void Reset ()
 Reset the iterator on the messages.
void SetExitStatus (Int_t est)
void SetMemValues (Long_t vmem=-1, Long_t rmem=-1, Bool_t master=kFALSE)
 Set max memory values.
- 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.
virtual void Clear (Option_t *option="")
 Set name and title to empty strings ("").
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 two TNamed objects.
virtual void Copy (TObject &named) const
 Copy this to obj.
virtual void FillBuffer (char *&buffer)
 Encode TNamed into output buffer.
virtual const char * GetName () const
 Returns name of object.
virtual const char * GetTitle () const
 Returns title of object.
virtual ULong_t Hash () const
 Return hash value for this object.
virtual Bool_t IsSortable () const
virtual void ls (Option_t *option="") const
 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.
- 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 for instance with: gROOT->SetSelectedPad(gPad).
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=0)
 Execute method on this object with the given parameter string, e.g.
virtual void Execute (TMethod *method, TObjArray *params, Int_t *error=0)
 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)
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.
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)
 Operator delete [].
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.
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.
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=0, Int_t option=0, Int_t bufsize=0)
 Write this object to the current directory.
virtual Int_t Write (const char *name=0, Int_t option=0, Int_t bufsize=0) const
 Write this object to the current directory.

Private Attributes

Int_t fExitStatus
THashList fInfoMsgs
 iterator in messages
TIter fIter
TList fMsgs
Long_t fResMaxMst
Long_t fResMemMax
Long_t fVirtMaxMst
Long_t fVirtMemMax

Additional Inherited Members

- Static Public Member Functions inherited from TObject
static Long_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.
- Protected Types inherited from TObject
enum  { kOnlyPrepStep = BIT(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 <TStatus.h>

Inheritance diagram for TStatus:

Member Enumeration Documentation

◆ EProcStatus


Definition at line 35 of file TStatus.h.

Constructor & Destructor Documentation

◆ TStatus()

TStatus::TStatus ( )

Default constructor.

Definition at line 34 of file TStatus.cxx.

◆ ~TStatus()

virtual TStatus::~TStatus ( )

Definition at line 52 of file TStatus.h.

Member Function Documentation

◆ Add()

void TStatus::Add ( const char *  mesg)

Add an error message.

Definition at line 47 of file TStatus.cxx.

◆ AddInfo()

void TStatus::AddInfo ( const char *  mesg)

Add an info message.

Definition at line 57 of file TStatus.cxx.

◆ GetExitStatus()

Int_t TStatus::GetExitStatus ( ) const

Definition at line 62 of file TStatus.h.

◆ GetResMemMax()

Long_t TStatus::GetResMemMax ( Bool_t  master = kFALSE) const

Definition at line 63 of file TStatus.h.

◆ GetVirtMemMax()

Long_t TStatus::GetVirtMemMax ( Bool_t  master = kFALSE) const

Definition at line 64 of file TStatus.h.

◆ IsOk()

Bool_t TStatus::IsOk ( ) const

Definition at line 54 of file TStatus.h.

◆ Merge()

Int_t TStatus::Merge ( TCollection list)

PROOF Merge() function.

Definition at line 65 of file TStatus.cxx.

◆ NextMesg()

const char * TStatus::NextMesg ( )

Return the next message or 0.

Definition at line 150 of file TStatus.cxx.

◆ Print()

void TStatus::Print ( Option_t option = "") const

Standard print function.

Reimplemented from TNamed.

Definition at line 110 of file TStatus.cxx.

◆ Reset()

void TStatus::Reset ( )

Reset the iterator on the messages.

Definition at line 142 of file TStatus.cxx.

◆ SetExitStatus()

void TStatus::SetExitStatus ( Int_t  est)

Definition at line 66 of file TStatus.h.

◆ SetMemValues()

void TStatus::SetMemValues ( Long_t  vmem = -1,
Long_t  rmem = -1,
Bool_t  master = kFALSE 

Set max memory values.

Definition at line 160 of file TStatus.cxx.

Member Data Documentation

◆ fExitStatus

Int_t TStatus::fExitStatus

Definition at line 44 of file TStatus.h.

◆ fInfoMsgs

THashList TStatus::fInfoMsgs

iterator in messages

Definition at line 42 of file TStatus.h.

◆ fIter

TIter TStatus::fIter

Definition at line 41 of file TStatus.h.

◆ fMsgs

TList TStatus::fMsgs

Definition at line 40 of file TStatus.h.

◆ fResMaxMst

Long_t TStatus::fResMaxMst

Definition at line 48 of file TStatus.h.

◆ fResMemMax

Long_t TStatus::fResMemMax

Definition at line 46 of file TStatus.h.

◆ fVirtMaxMst

Long_t TStatus::fVirtMaxMst

Definition at line 47 of file TStatus.h.

◆ fVirtMemMax

Long_t TStatus::fVirtMemMax

Definition at line 45 of file TStatus.h.

Libraries for TStatus:

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