Logo ROOT  
Reference Guide
 
All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Modules Pages
Loading...
Searching...
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 = (1ULL << ( 15 )) }
 
- 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

 TStatus ()
 Default constructor.
 
 ~TStatus () override
 
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
 
TClassIsA () const override
 
Bool_t IsOk () const
 
virtual Int_t Merge (TCollection *list)
 PROOF Merge() function.
 
const char * NextMesg ()
 Return the next message or 0.
 
void Print (Option_t *option="") const override
 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.
 
void Streamer (TBuffer &) override
 Stream an object of class TStatus.
 
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.
 

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 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.
 

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

- 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 <TStatus.h>

Inheritance diagram for TStatus:
[legend]

Member Enumeration Documentation

◆ EProcStatus

Enumerator
kNotOk 

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

TStatus::~TStatus ( )
inlineoverride

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.

◆ Class()

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

◆ Class_Name()

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

◆ Class_Version()

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

Definition at line 69 of file TStatus.h.

◆ DeclFileName()

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

Definition at line 69 of file TStatus.h.

◆ GetExitStatus()

Int_t TStatus::GetExitStatus ( ) const
inline

Definition at line 62 of file TStatus.h.

◆ GetResMemMax()

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

Definition at line 63 of file TStatus.h.

◆ GetVirtMemMax()

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

Definition at line 64 of file TStatus.h.

◆ IsA()

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

Reimplemented from TNamed.

Definition at line 69 of file TStatus.h.

◆ IsOk()

Bool_t TStatus::IsOk ( ) const
inline

Definition at line 54 of file TStatus.h.

◆ Merge()

Int_t TStatus::Merge ( TCollection * list)
virtual

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
overridevirtual

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

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.

◆ Streamer()

void TStatus::Streamer ( TBuffer & R__b)
overridevirtual

Stream an object of class TStatus.

Reimplemented from TNamed.

Definition at line 174 of file TStatus.cxx.

◆ StreamerNVirtual()

void TStatus::StreamerNVirtual ( TBuffer & ClassDef_StreamerNVirtual_b)
inline

Definition at line 69 of file TStatus.h.

Member Data Documentation

◆ fExitStatus

Int_t TStatus::fExitStatus
private

Definition at line 44 of file TStatus.h.

◆ fInfoMsgs

THashList TStatus::fInfoMsgs
private

iterator in messages

Definition at line 42 of file TStatus.h.

◆ fIter

TIter TStatus::fIter
private

Definition at line 41 of file TStatus.h.

◆ fMsgs

TList TStatus::fMsgs
private

Definition at line 40 of file TStatus.h.

◆ fResMaxMst

Long_t TStatus::fResMaxMst
private

Definition at line 48 of file TStatus.h.

◆ fResMemMax

Long_t TStatus::fResMemMax
private

Definition at line 46 of file TStatus.h.

◆ fVirtMaxMst

Long_t TStatus::fVirtMaxMst
private

Definition at line 47 of file TStatus.h.

◆ fVirtMemMax

Long_t TStatus::fVirtMemMax
private

Definition at line 45 of file TStatus.h.

  • proof/proofplayer/inc/TStatus.h
  • proof/proofplayer/src/TStatus.cxx