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 34 of file TMessageHandler.h.

Public Member Functions
	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.

	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.

virtual	~TMessageHandler ()
	Clean up the message handler.

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

virtual void	Added ()

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

Int_t	GetSize () const

virtual Int_t	GetTotalMessageCount () const
	Return total number of messages.

Bool_t	HandleDerived () const

virtual void	HandleMessage (Long_t id, const TObject *obj)
	Store message origin, keep statistics and call Notify().

TClass *	IsA () const override

virtual void	Notified ()

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

void	Print (Option_t *option="") const override
	Print statistics for this message handler.

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

virtual void	Removed ()

void	Streamer (TBuffer &) override
	Stream an object of class TObject.

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

TObject *	Clone (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.

TClass *	IsA () const override

Bool_t	IsSortable () const override

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

TNamed &	operator= (const TNamed &rhs)
	TNamed assignment operator.

void	Print (Option_t *option="") const override
	Print TNamed name and title.

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	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	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 TObject *	DrawClone (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 TObject *	FindObject (const char *name) const
	Must be redefined in derived classes.

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

virtual Option_t *	GetDrawOption () 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_t *	GetOption () 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).

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)

TObject &	operator= (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.

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

virtual	~TQObject ()
	TQObject Destructor.

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.

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.

virtual void	Connected (const char *)

virtual void	Destroyed ()

Bool_t	Disconnect (const char signal=nullptr, void receiver=nullptr, const char *slot=nullptr)
	Disconnects signal of this object from slot of receiver.

virtual void	Disconnected (const char *)

void	Emit (const char *signal)
	Activate signal without args.

template<typename T >
void	Emit (const char *signal, const T &arg)
	Activate signal with single parameter.

template<typename... T>
void	EmitVA (const char *signal_name, Int_t, const T &... params)
	Emit a signal with a varying number of arguments.

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

TList *	GetListOfConnections () const

TList *	GetListOfSignals () const

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

virtual void	HighPriority (const char signal_name, const char slot_name=nullptr)

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

virtual void	Message (const char *msg)

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

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

void	StreamerNVirtual (TBuffer &ClassDef_StreamerNVirtual_b)

Static Public Member Functions
static TClass *	Class ()

static const char *	Class_Name ()

static constexpr Version_t	Class_Version ()

static const char *	DeclFileName ()

Static Public Member Functions inherited from TNamed
static TClass *	Class ()

static const char *	Class_Name ()

static constexpr Version_t	Class_Version ()

static const char *	DeclFileName ()

Static Public Member Functions inherited from TObject
static TClass *	Class ()

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.

Static Public Member Functions inherited from TQObject
static Bool_t	AreAllSignalsBlocked ()
	Returns true if all signals are blocked.

static Bool_t	BlockAllSignals (Bool_t b)
	Block or unblock all signals. Returns the previous block status.

static TClass *	Class ()

static const char *	Class_Name ()

static constexpr Version_t	Class_Version ()

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.

static Bool_t	Connect (TQObject sender, const char signal, const char receiver_class, void receiver, const char *slot)
	Create connection between sender and receiver.

static const char *	DeclFileName ()

static Bool_t	Disconnect (const char class_name, const char signal, void receiver=nullptr, const char slot=nullptr)
	Disconnects "class signal".

static Bool_t	Disconnect (TQObject sender, const char signal=nullptr, void receiver=nullptr, const char slot=nullptr)
	Disconnects signal in object sender from slot_method in object receiver.

Protected Member Functions
void *	GetSender () override

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

Protected Attributes
const TClass *	fClass

Int_t *	fCnts

Bool_t	fDerived

Long_t	fMessId

Long_t *	fMessIds

const TObject *	fMessObj

Int_t	fSize

Protected Attributes inherited from TNamed
TString	fName

TString	fTitle

Protected Attributes inherited from TQObject
TList *	fListOfConnections
	list of signals from this object

TList *	fListOfSignals

Bool_t	fSignalsBlocked
	list of connections to this object

Additional Inherited Members
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 )) }

Protected Types inherited from TObject
enum	{ kOnlyPrepStep = (1ULL << ( 3 )) }

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 consistency of sender/receiver methods/arguments.

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.

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.

static Bool_t	ConnectToClass (TQObject sender, const char signal, TClass receiver_class, void receiver, const char *slot)
	Create connection between sender and receiver.

Static Protected Attributes inherited from TQObject
static Bool_t	fgAllSignalsBlocked = kFALSE
	flag used for suppression of signals

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

◆ Class()

static TClass * TMessageHandler::Class ( )

static

Returns: TClass describing this class

◆ Class_Name()

static const char * TMessageHandler::Class_Name ( )

static

Returns: Name of this class

◆ Class_Version()

static constexpr Version_t TMessageHandler::Class_Version ( )

inlinestaticconstexpr

Returns: Version of this class

Definition at line 68 of file TMessageHandler.h.

◆ DeclFileName()

static const char * TMessageHandler::DeclFileName ( )

inlinestatic

Returns: Name of the file containing the class declaration

Definition at line 68 of file TMessageHandler.h.

◆ GetMessageCount()

Int_t TMessageHandler::GetMessageCount ( Long_t messId ) const

virtual

Return counter for message with ID=messid.

Definition at line 108 of file TMessageHandler.cxx.

◆ GetSender()

void * TMessageHandler::GetSender ( )

inlineoverrideprotectedvirtual

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	(	Long_t	id,
		const TObject *	obj
	)

virtual

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

Definition at line 133 of file TMessageHandler.cxx.

◆ IsA()

TClass * TMessageHandler::IsA ( ) const

inlineoverridevirtual

Returns: TClass describing current object

Reimplemented from TObject.

Definition at line 68 of file TMessageHandler.h.

◆ Notified()

virtual void TMessageHandler::Notified ( )

inlinevirtual

Definition at line 66 of file TMessageHandler.h.

◆ Notify()

Bool_t TMessageHandler::Notify ( )

overridevirtual

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

overridevirtual

Print statistics for this message handler.

Reimplemented from TObject.

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

◆ Removed()

virtual void TMessageHandler::Removed ( )

inlinevirtual

Definition at line 65 of file TMessageHandler.h.

◆ Streamer()

void TMessageHandler::Streamer ( TBuffer & R__b )

overridevirtual

Stream an object of class TObject.

Reimplemented from TObject.

◆ StreamerNVirtual()

void TMessageHandler::StreamerNVirtual ( TBuffer & ClassDef_StreamerNVirtual_b )

inline

Definition at line 68 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

Long_t TMessageHandler::fMessId

protected

Definition at line 39 of file TMessageHandler.h.

◆ fMessIds

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

Libraries for TMessageHandler:

[legend]

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

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

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Constructor & Destructor Documentation

◆ TMessageHandler() [1/2]

◆ TMessageHandler() [2/2]

◆ ~TMessageHandler()

Member Function Documentation

◆ Add()

◆ Added()

◆ Class()

◆ Class_Name()

◆ Class_Version()

◆ DeclFileName()

◆ GetMessageCount()

◆ GetSender()

◆ GetSize()

◆ GetTotalMessageCount()

◆ HandleDerived()

◆ HandleMessage()

◆ IsA()

◆ Notified()

◆ Notify()

◆ Print()

◆ Remove()

◆ Removed()

◆ Streamer()

◆ StreamerNVirtual()

Member Data Documentation

◆ fClass

◆ fCnts

◆ fDerived

◆ fMessId

◆ fMessIds

◆ fMessObj

◆ fSize