Logo ROOT   6.10/09
Reference Guide
List of all members | Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
TMessageHandler Class Reference

Handle messages that might be generated by the system.

By default a handler only keeps track of the different messages generated for a specific class. By deriving from this class and overriding Notify() one can implement custom message handling. In Notify() one has access to the message id and the object generating the message. One can install more than one message handler per class. A message handler can be removed or again added when needed.

Definition at line 34 of file TMessageHandler.h.

Public Member Functions

 TMessageHandler (const TClass *cl, Bool_t derived=kTRUE)
 Create a new message handler for class cl and add it to the list of message handlers. More...
 
 TMessageHandler (const char *cl, Bool_t derived=kTRUE)
 Create a new message handler for class named cl and add it to the list of message handlers. More...
 
virtual ~TMessageHandler ()
 Clean up the message handler. More...
 
virtual void Add ()
 Add this message handler to the list of messages handlers. More...
 
virtual void Added ()
 
virtual Int_t GetMessageCount (Int_t messId) const
 Return counter for message with ID=messid. More...
 
Int_t GetSize () const
 
virtual Int_t GetTotalMessageCount () const
 Return total number of messages. More...
 
Bool_t HandleDerived () const
 
virtual void HandleMessage (Int_t id, const TObject *obj)
 Store message origin, keep statistics and call Notify(). More...
 
virtual void Notified ()
 
virtual Bool_t Notify ()
 This method must be overridden to handle object notification. More...
 
virtual void Print (Option_t *option="") const
 Print statistics for this message handler. More...
 
virtual void Remove ()
 Remove this message handler from the list of messages handlers. More...
 
virtual void Removed ()
 
- Public Member Functions inherited from TNamed
 TNamed ()
 
 TNamed (const char *name, const char *title)
 
 TNamed (const TString &name, const TString &title)
 
 TNamed (const TNamed &named)
 TNamed copy ctor. More...
 
virtual ~TNamed ()
 
virtual void Clear (Option_t *option="")
 Set name and title to empty strings (""). More...
 
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 two TNamed objects. More...
 
virtual void Copy (TObject &named) const
 Copy this to obj. More...
 
virtual void FillBuffer (char *&buffer)
 Encode TNamed into output buffer. More...
 
virtual const char * GetName () const
 Returns name of object. More...
 
virtual const char * GetTitle () const
 Returns title of object. More...
 
virtual ULong_t Hash () const
 Return hash value for this object. More...
 
virtual Bool_t IsSortable () const
 
virtual void ls (Option_t *option="") const
 List TNamed name and title. More...
 
TNamedoperator= (const TNamed &rhs)
 TNamed assignment operator. More...
 
virtual void SetName (const char *name)
 Set the name of the TNamed. More...
 
virtual void SetNameTitle (const char *name, const char *title)
 Set all the TNamed parameters (name and title). More...
 
virtual void SetTitle (const char *title="")
 Set the title of the TNamed. More...
 
virtual Int_t Sizeof () const
 Return size of the TNamed part of the TObject. More...
 
- 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...
 
virtual const char * ClassName () const
 Returns name of class to which the object belongs. 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 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 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 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...
 
Bool_t IsOnHeap () const
 
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). 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 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, Bool_t set)
 Set or unset the user status bits as specified in f. More...
 
void SetBit (UInt_t f)
 
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...
 
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...
 
- Public Member Functions inherited from TQObject
 TQObject ()
 TQObject Constructor. More...
 
virtual ~TQObject ()
 TQObject Destructor. More...
 
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. More...
 
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. More...
 
virtual void Connected (const char *)
 
virtual void Destroyed ()
 
Bool_t Disconnect (const char *signal=0, void *receiver=0, const char *slot=0)
 Disconnects signal of this object from slot of receiver. More...
 
virtual void Disconnected (const char *)
 
template<typename T >
void Emit (const char *signal, const T &arg)
 Activate signal with single parameter. More...
 
void Emit (const char *signal)
 Acitvate signal without args. More...
 
template<typename... T>
void EmitVA (const char *signal_name, Int_t, const T &... params)
 Emit a signal with a varying number of arguments. More...
 
TListGetListOfClassSignals () const
 Returns pointer to list of signals of this class. More...
 
TListGetListOfConnections () const
 
TListGetListOfSignals () const
 
virtual Bool_t HasConnection (const char *signal_name) const
 Return true if there is any object connected to this signal. More...
 
virtual void HighPriority (const char *signal_name, const char *slot_name=0)
 
virtual void LowPriority (const char *signal_name, const char *slot_name=0)
 
virtual void Message (const char *msg)
 
virtual Int_t NumberOfConnections () const
 Return number of connections for this object. More...
 
virtual Int_t NumberOfSignals () const
 Return number of signals for this object. More...
 

Protected Member Functions

voidGetSender ()
 
- 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 ()
 
- Protected Member Functions inherited from TQObject
virtual const char * GetSenderClassName () const
 

Protected Attributes

const TClassfClass
 
Int_tfCnts
 
Bool_t fDerived
 
Int_t fMessId
 
Int_tfMessIds
 
const TObjectfMessObj
 
Int_t fSize
 
- Protected Attributes inherited from TNamed
TString fName
 
TString fTitle
 
- Protected Attributes inherited from TQObject
TListfListOfConnections
 list of signals from this object More...
 
TListfListOfSignals
 
Bool_t fSignalsBlocked
 list of connections to this object More...
 

Additional Inherited Members

- Public Types inherited from TObject
enum  { kIsOnHeap = 0x01000000, kNotDeleted = 0x02000000, kZombie = 0x04000000, kBitMask = 0x00ffffff }
 
enum  { kSingleKey = BIT(0), kOverwrite = BIT(1), kWriteDelete = BIT(2) }
 
enum  EStatusBits {
  kCanDelete = BIT(0), kMustCleanup = BIT(3), kObjInCanvas = BIT(3), kIsReferenced = BIT(4),
  kHasUUID = BIT(5), kCannotPick = BIT(6), kNoContextMenu = BIT(8), kInvalidObject = BIT(13)
}
 
- 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...
 
- Static Public Member Functions inherited from TQObject
static Bool_t AreAllSignalsBlocked ()
 Returns true if all signals are blocked. More...
 
static Bool_t BlockAllSignals (Bool_t b)
 Block or unblock all signals. Returns the previous block status. More...
 
static Bool_t Connect (TQObject *sender, const char *signal, const char *receiver_class, void *receiver, const char *slot)
 Create connection between sender and receiver. More...
 
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. More...
 
static Bool_t Disconnect (TQObject *sender, const char *signal=0, void *receiver=0, const char *slot=0)
 Disconnects signal in object sender from slot_method in object receiver. More...
 
static Bool_t Disconnect (const char *class_name, const char *signal, void *receiver=0, const char *slot=0)
 Disconnects "class signal". More...
 
- 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 consitency of sender/receiver methods/arguments. More...
 
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. More...
 
static Bool_t ConnectToClass (TQObject *sender, const char *signal, TClass *receiver_class, void *receiver, const char *slot)
 Create connection between sender and receiver. More...
 
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. More...
 
- Static Protected Attributes inherited from TQObject
static Bool_t fgAllSignalsBlocked = kFALSE
 flag used for suppression of signals More...
 

#include <TMessageHandler.h>

Inheritance diagram for TMessageHandler:
[legend]

Constructor & Destructor Documentation

◆ TMessageHandler() [1/2]

TMessageHandler::TMessageHandler ( const TClass cl,
Bool_t  derived = kTRUE 
)

Create a new message handler for class cl and add it to the list of message handlers.

Definition at line 41 of file TMessageHandler.cxx.

◆ TMessageHandler() [2/2]

TMessageHandler::TMessageHandler ( const char *  cl,
Bool_t  derived = kTRUE 
)

Create a new message handler for class named cl and add it to the list of message handlers.

Definition at line 63 of file TMessageHandler.cxx.

◆ ~TMessageHandler()

TMessageHandler::~TMessageHandler ( )
virtual

Clean up the message handler.

Definition at line 82 of file TMessageHandler.cxx.

Member Function Documentation

◆ Add()

void TMessageHandler::Add ( )
virtual

Add this message handler to the list of messages handlers.

Definition at line 93 of file TMessageHandler.cxx.

◆ Added()

virtual void TMessageHandler::Added ( )
inlinevirtual

Definition at line 64 of file TMessageHandler.h.

◆ GetMessageCount()

Int_t TMessageHandler::GetMessageCount ( Int_t  messId) const
virtual

Return counter for message with ID=messid.

Definition at line 108 of file TMessageHandler.cxx.

◆ GetSender()

void* TMessageHandler::GetSender ( )
inlineprotectedvirtual

Reimplemented from TQObject.

Definition at line 45 of file TMessageHandler.h.

◆ GetSize()

Int_t TMessageHandler::GetSize ( ) const
inline

Definition at line 52 of file TMessageHandler.h.

◆ GetTotalMessageCount()

Int_t TMessageHandler::GetTotalMessageCount ( ) const
virtual

Return total number of messages.

Definition at line 120 of file TMessageHandler.cxx.

◆ HandleDerived()

Bool_t TMessageHandler::HandleDerived ( ) const
inline

Definition at line 55 of file TMessageHandler.h.

◆ HandleMessage()

void TMessageHandler::HandleMessage ( Int_t  id,
const TObject obj 
)
virtual

Store message origin, keep statistics and call Notify().

Definition at line 133 of file TMessageHandler.cxx.

◆ Notified()

virtual void TMessageHandler::Notified ( )
inlinevirtual

Definition at line 66 of file TMessageHandler.h.

◆ Notify()

Bool_t TMessageHandler::Notify ( )
virtual

This method must be overridden to handle object notification.

Reimplemented from TObject.

Definition at line 184 of file TMessageHandler.cxx.

◆ Print()

void TMessageHandler::Print ( Option_t option = "") const
virtual

Print statistics for this message handler.

Reimplemented from TNamed.

Definition at line 200 of file TMessageHandler.cxx.

◆ Remove()

void TMessageHandler::Remove ( )
virtual

Remove this message handler from the list of messages handlers.

Definition at line 235 of file TMessageHandler.cxx.

◆ Removed()

virtual void TMessageHandler::Removed ( )
inlinevirtual

Definition at line 65 of file TMessageHandler.h.

Member Data Documentation

◆ fClass

const TClass* TMessageHandler::fClass
protected

Definition at line 37 of file TMessageHandler.h.

◆ fCnts

Int_t* TMessageHandler::fCnts
protected

Definition at line 41 of file TMessageHandler.h.

◆ fDerived

Bool_t TMessageHandler::fDerived
protected

Definition at line 43 of file TMessageHandler.h.

◆ fMessId

Int_t TMessageHandler::fMessId
protected

Definition at line 39 of file TMessageHandler.h.

◆ fMessIds

Int_t* TMessageHandler::fMessIds
protected

Definition at line 42 of file TMessageHandler.h.

◆ fMessObj

const TObject* TMessageHandler::fMessObj
protected

Definition at line 38 of file TMessageHandler.h.

◆ fSize

Int_t TMessageHandler::fSize
protected

Definition at line 40 of file TMessageHandler.h.


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