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.

All Root "Warnings" are logged as message 1001
All Root "Errors" are logged as message 1002
All Root "SysErrors" are logged as message 1003
All Root "Fatals" are logged as message 1004

Definition at line 38 of file TMessageHandler.h.

Public Member Functions
	TMessageHandler (const TClass *cl, Bool_t derived=kTRUE)

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

Int_t	GetSize () const

virtual Int_t	GetMessageCount (Int_t messId) const
	Return counter for message with ID=messid. More...

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	Print (Option_t *option="") const
	Print statistics for this message handler. More...

virtual void	Add ()
	Add this message handler to the list of messages handlers. More...

virtual void	Remove ()
	Remove this message handler from the list of messages handlers. More...

virtual Bool_t	Notify ()
	This method must be overridden to handle object notification. More...

virtual void	Added ()

virtual void	Removed ()

virtual void	Notified ()

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 &	operator= (const TNamed &rhs)
	TNamed assignment operator. More...

virtual	~TNamed ()

virtual void	Clear (Option_t *option="")
	Set name and title to empty strings (""). More...

virtual TObject *	Clone (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	SetName (const char *name)
	Change (i.e. More...

virtual void	SetNameTitle (const char name, const char title)
	Change (i.e. set) all the TNamed parameters (name and title). More...

virtual void	SetTitle (const char *title="")
	Change (i.e. set) the title of the TNamed. More...

virtual void	ls (Option_t *option="") const
	List TNamed name and title. More...

virtual Int_t	Sizeof () const
	Return size of the TNamed part of the TObject. More...

Public Member Functions inherited from TObject
	TObject ()

	TObject (const TObject &object)
	TObject copy ctor. More...

TObject &	operator= (const TObject &rhs)
	TObject assignment operator. More...

virtual	~TObject ()
	TObject destructor. 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 TObject *	DrawClone (Option_t *option="") const
	Draw a clone of this object in the current pad. More...

virtual void	Dump () const
	Dump contents of object on stdout. 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 TObject *	FindObject (const char *name) const
	Must be redefined in derived classes. More...

virtual TObject *	FindObject (const TObject *obj) const
	Must be redefined in derived classes. More...

virtual Option_t *	GetDrawOption () const
	Get option used by the graphics system to draw this object. More...

virtual UInt_t	GetUniqueID () const
	Return the unique object id. More...

virtual const char *	GetIconName () const
	Returns mime type name of object. More...

virtual Option_t *	GetOption () const

virtual char *	GetObjectInfo (Int_t px, Int_t py) const
	Returns string containing info about the object at position (px,py). More...

virtual Bool_t	HandleTimer (TTimer *timer)
	Execute action in response of a timer timing out. 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...

virtual Bool_t	IsFolder () const
	Returns kTRUE in case object contains browsable objects (like containers or lists of other objects). More...

virtual Bool_t	IsEqual (const TObject *obj) const
	Default equal comparison (objects are equal if they have the same address in memory). More...

Bool_t	IsOnHeap () const

Bool_t	IsZombie () const

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

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

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	UseCurrentStyle ()
	Set current style settings in this object This function is called when either TCanvas::UseCurrentStyle or TROOT::ForceStyle have been invoked. 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...

void *	operator new (size_t sz)

void *	operator new[] (size_t sz)

void *	operator new (size_t sz, void *vp)

void *	operator new[] (size_t sz, void *vp)

void	operator delete (void *ptr)
	Operator delete. More...

void	operator delete[] (void *ptr)
	Operator delete []. 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)

void	ResetBit (UInt_t f)

Bool_t	TestBit (UInt_t f) const

Int_t	TestBits (UInt_t f) const

void	InvertBit (UInt_t f)

virtual void	Info (const char method, const char msgfmt,...) const
	Issue info message. More...

virtual void	Warning (const char method, const char msgfmt,...) const
	Issue warning message. More...

virtual void	Error (const char method, const char msgfmt,...) const
	Issue error message. More...

virtual void	SysError (const char method, const char msgfmt,...) const
	Issue system error message. More...

virtual void	Fatal (const char method, const char msgfmt,...) const
	Issue fatal error message. 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...

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

Public Member Functions inherited from TQObject
	TQObject ()
	TQObject Constructor. More...

virtual	~TQObject ()
	TQObject Destructor. More...

TList *	GetListOfClassSignals () const
	Returns pointer to list of signals of this class. More...

TList *	GetListOfSignals () const

TList *	GetListOfConnections () const

Bool_t	AreSignalsBlocked () const

Bool_t	BlockSignals (Bool_t b)

void	CollectClassSignalLists (TList &list, TClass *cls)
	Collect class signal lists from class cls and all its base-classes. More...

template<typename... T>
void	EmitVA (const char *signal_name, Int_t, const T &...params)

void	EmitVA (const char *signal, Int_t nargs, va_list va)=delete

void	Emit (const char *signal)
	Acitvate signal without args. More...

void	Emit (const char signal, Long_t paramArr)
	Emit a signal with a varying number of arguments, paramArr is an array of the parameters. More...

void	Emit (const char signal, const char params)
	Activate signal with parameter text string. More...

void	Emit (const char *signal, Double_t param)
	Activate signal with single parameter. More...

void	Emit (const char *signal, Long_t param)
	Activate signal with single parameter. More...

void	Emit (const char *signal, Long64_t param)
	Activate signal with single parameter. More...

void	Emit (const char *signal, Bool_t param)

void	Emit (const char *signal, Char_t param)

void	Emit (const char *signal, UChar_t param)

void	Emit (const char *signal, Short_t param)

void	Emit (const char *signal, UShort_t param)

void	Emit (const char *signal, Int_t param)

void	Emit (const char *signal, UInt_t param)

void	Emit (const char *signal, ULong_t param)

void	Emit (const char *signal, ULong64_t param)

void	Emit (const char *signal, Float_t param)

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

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	HighPriority (const char signal_name, const char slot_name=0)

virtual void	LowPriority (const char signal_name, const char slot_name=0)

virtual Bool_t	HasConnection (const char *signal_name) const
	Return true if there is any object connected to this signal. More...

virtual Int_t	NumberOfSignals () const
	Return number of signals for this object. More...

virtual Int_t	NumberOfConnections () const
	Return number of connections for this object. More...

virtual void	Connected (const char *)

virtual void	Disconnected (const char *)

virtual void	Destroyed ()

virtual void	ChangedBy (const char *method)

virtual void	Message (const char *msg)

Protected Member Functions
void *	GetSender ()

Protected Member Functions inherited from TObject
void	MakeZombie ()

virtual void	DoError (int level, const char location, const char fmt, va_list va) const
	Interface to ErrorHandler (protected). More...

Protected Member Functions inherited from TQObject
virtual const char *	GetSenderClassName () const

Protected Attributes
const TClass *	fClass

const TObject *	fMessObj

Int_t	fMessId

Int_t	fSize

Int_t *	fCnts

Int_t *	fMessIds

Bool_t	fDerived

Protected Attributes inherited from TNamed
TString	fName

TString	fTitle

Protected Attributes inherited from TQObject
TList *	fListOfSignals

TList *	fListOfConnections
	list of signals from this object More...

Bool_t	fSignalsBlocked
	list of connections to this object More...

Additional Inherited Members
Public Types inherited from TObject
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) }

enum	{ kIsOnHeap = 0x01000000, kNotDeleted = 0x02000000, kZombie = 0x04000000, kBitMask = 0x00ffffff }

enum	{ kSingleKey = BIT(0), kOverwrite = BIT(1), kWriteDelete = BIT(2) }

Static Public Member Functions inherited from TObject
static Long_t	GetDtorOnly ()
	Return destructor only flag. More...

static void	SetDtorOnly (void *obj)
	Set destructor only flag. More...

static Bool_t	GetObjectStat ()
	Get status of object stat 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	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 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 Protected Member Functions inherited from TQObject
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 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)

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:

Collaboration diagram for TMessageHandler:

Constructor & Destructor Documentation

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

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 62 of file TMessageHandler.cxx.

TMessageHandler::~TMessageHandler ( )

virtual

Clean up the message handler.

Definition at line 81 of file TMessageHandler.cxx.

Member Function Documentation

void TMessageHandler::Add ( )

virtual

Add this message handler to the list of messages handlers.

Definition at line 92 of file TMessageHandler.cxx.

Referenced by TMessageHandler().

virtual void TMessageHandler::Added ( )

inlinevirtual

Definition at line 68 of file TMessageHandler.h.

Referenced by Add().

Int_t TMessageHandler::GetMessageCount ( Int_t messId ) const

virtual

Return counter for message with ID=messid.

Definition at line 107 of file TMessageHandler.cxx.

void* TMessageHandler::GetSender ( )

inlineprotectedvirtual

Reimplemented from TQObject.

Definition at line 49 of file TMessageHandler.h.

Int_t TMessageHandler::GetSize ( ) const

inline

Definition at line 56 of file TMessageHandler.h.

Int_t TMessageHandler::GetTotalMessageCount ( ) const

virtual

Return total number of messages.

Definition at line 119 of file TMessageHandler.cxx.

Referenced by Print().

Bool_t TMessageHandler::HandleDerived ( ) const

inline

Definition at line 59 of file TMessageHandler.h.

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

virtual

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

Definition at line 132 of file TMessageHandler.cxx.

Referenced by TROOT::Message().

virtual void TMessageHandler::Notified ( )

inlinevirtual

Definition at line 70 of file TMessageHandler.h.

Referenced by Notify().

Bool_t TMessageHandler::Notify ( )

virtual

This method must be overridden to handle object notification.

Reimplemented from TObject.

Definition at line 183 of file TMessageHandler.cxx.

Referenced by HandleMessage().

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

virtual

Print statistics for this message handler.

Reimplemented from TNamed.

Definition at line 199 of file TMessageHandler.cxx.

void TMessageHandler::Remove ( )

virtual

Remove this message handler from the list of messages handlers.

Definition at line 234 of file TMessageHandler.cxx.

Referenced by ~TMessageHandler().

virtual void TMessageHandler::Removed ( )

inlinevirtual

Definition at line 69 of file TMessageHandler.h.

Referenced by Remove().

Member Data Documentation

const TClass* TMessageHandler::fClass

protected

Definition at line 41 of file TMessageHandler.h.

Referenced by Add(), HandleMessage(), Notify(), Print(), and TMessageHandler().

Int_t* TMessageHandler::fCnts

protected

Definition at line 45 of file TMessageHandler.h.

Referenced by GetMessageCount(), GetTotalMessageCount(), HandleMessage(), Print(), TMessageHandler(), and ~TMessageHandler().

Bool_t TMessageHandler::fDerived

protected

Definition at line 47 of file TMessageHandler.h.

Referenced by HandleDerived(), HandleMessage(), and TMessageHandler().

Int_t TMessageHandler::fMessId

protected

Definition at line 43 of file TMessageHandler.h.

Referenced by HandleMessage(), Notify(), and TMessageHandler().

Int_t* TMessageHandler::fMessIds

protected

Definition at line 46 of file TMessageHandler.h.

Referenced by GetMessageCount(), HandleMessage(), Print(), TMessageHandler(), and ~TMessageHandler().

const TObject* TMessageHandler::fMessObj

protected

Definition at line 42 of file TMessageHandler.h.

Referenced by HandleMessage(), Notify(), and TMessageHandler().

Int_t TMessageHandler::fSize

protected

Definition at line 44 of file TMessageHandler.h.

Referenced by GetMessageCount(), GetSize(), GetTotalMessageCount(), HandleMessage(), Print(), TMessageHandler(), and ~TMessageHandler().

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

core/base/inc/TMessageHandler.h
core/base/src/TMessageHandler.cxx

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation