The class RooMsgService is a singleton that organizes messages generated in RooFit.

Each message has a message level RooFit::MsgLevel (DEBUG,INFO,PROGRESS,WARNING,ERROR or FATAL), an source object, and a RooFit::MsgTopic. RooMsgService allows to filter and redirect messages into streams according to message level, topic, (base) class of originating object, name of originating object and based on attribute labels attached to individual objects. The current default configuration creates streams for all messages at WARNING level or higher (e.g. ERROR and FATAL) and for all INFO message on topics Generation,Plotting, Integration and Minimization and redirects them to stdout. Users can create additional streams for logging of e.g. DEBUG messages on particular topics or objects and/or redirect streams to C++ streams or files.

The singleton instance is accessible through RooMsgService::instance().

Temporarily change the message level

There is a helper, RooHelpers::LocalChangeMsgLevel, that overrides the default message levels as long as it is alive. To suppress everything below WARNING:

RooHelpers::LocalChangeMessageLevel changeMsgLvl(RooFit::WARNING);

[ statements that normally generate a lot of output ]

a

#define a(i)

Definition RSha256.hxx:99

RooFit::WARNING

@ WARNING

Definition RooGlobalFunc.h:67

output

static void output(int code)

Definition gifencode.c:226

Temporarily capture a message stream

RooHelpers::HijackMessageStream allows to fully capture a message stream in a std::stringstream. With this, RooFit messages can be evaluated or suppressed.

PyROOT

Some member functions of RooMsgService that take a RooCmdArg as argument also support keyword arguments. So far, this applies to RooMsgService::addStream. For example, the following code is equivalent in PyROOT:

# Directly passing a RooCmdArg:
ROOT.RooMsgService.instance().addStream(ROOT.RooFit.DEBUG, ROOT.RooFit.Topic(ROOT.RooFit.Tracing), ROOT.RooFit.ClassName("RooGaussian"))
 
# With keyword arguments:
ROOT.RooMsgService.instance().addStream(ROOT.RooFit.DEBUG, Topic = ROOT.RooFit.Tracing, ClassName = "RooGaussian")

Definition at line 106 of file RooMsgService.h.

Classes
struct	StreamConfig

Public Member Functions
virtual	~RooMsgService ()
	Destructor.

Int_t	addStream (RooFit::MsgLevel level, const RooCmdArg &arg1=RooCmdArg(), const RooCmdArg &arg2=RooCmdArg(), const RooCmdArg &arg3=RooCmdArg(), const RooCmdArg &arg4=RooCmdArg(), const RooCmdArg &arg5=RooCmdArg(), const RooCmdArg &arg6=RooCmdArg())
	Add a message logging stream for message with given RooFit::MsgLevel or higher.

void	clearErrorCount ()

Int_t &	debugCode ()

RooWorkspace *	debugWorkspace ()

void	deleteStream (Int_t id)
	Delete stream with given unique ID code.

Int_t	errorCount () const

StreamConfig &	getStream (Int_t id)

Bool_t	getStreamStatus (Int_t id) const
	Get activation status of stream with given unique ID.

RooFit::MsgLevel	globalKillBelow () const

Bool_t	isActive (const RooAbsArg *self, RooFit::MsgTopic facility, RooFit::MsgLevel level)
	Check if logging is active for given object/topic/RooFitMsgLevel combination.

Bool_t	isActive (const TObject *self, RooFit::MsgTopic facility, RooFit::MsgLevel level)
	Check if logging is active for given object/topic/RooFitMsgLevel combination.

std::ostream &	log (const RooAbsArg *self, RooFit::MsgLevel level, RooFit::MsgTopic facility, Bool_t forceSkipPrefix=kFALSE)
	Log error message associated with RooAbsArg object self at given level and topic.

std::ostream &	log (const TObject *self, RooFit::MsgLevel level, RooFit::MsgTopic facility, Bool_t forceSkipPrefix=kFALSE)
	Log error message associated with TObject object self at given level and topic.

Int_t	numStreams () const

void	Print (Option_t *options=0) const
	Print configuration of message service.

void	reset ()

void	restoreState ()
	Restore last saved state of message service.

void	saveState ()
	Save current state of message service.

void	setGlobalKillBelow (RooFit::MsgLevel level)

void	setSilentMode (Bool_t flag)

void	setStreamStatus (Int_t id, Bool_t active)
	(De)Activate stream with given unique ID

void	showPid (Bool_t flag)

Bool_t	silentMode () const

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	Clear (Option_t *="")

virtual TObject *	Clone (const char *newname="") const
	Make a clone of an object using the Streamer facility.

virtual Int_t	Compare (const TObject *obj) const
	Compare abstract method.

virtual void	Copy (TObject &object) const
	Copy this to obj.

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 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 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 const char *	GetName () const
	Returns 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 const char *	GetTitle () const
	Returns title of object.

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.

virtual ULong_t	Hash () const
	Return hash value for this object.

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

virtual Bool_t	IsSortable () const

R__ALWAYS_INLINE Bool_t	IsZombie () const

virtual void	ls (Option_t *option="") const
	The ls function lists the contents of a class on stdout.

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

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.

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.

Static Public Member Functions
static Bool_t	anyDebug ()
	Returns true if any debug level stream is active.

static RooMsgService &	instance ()
	Return reference to singleton instance.

Static Public Member Functions inherited from TObject
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.

Public Attributes
std::map< int, std::string >	_levelNames

std::map< int, std::string >	_topicNames

Static Public Attributes
static Int_t	_debugCount = 0

Protected Member Functions
	RooMsgService ()
	Constructor.

	RooMsgService (const RooMsgService &)

Int_t	activeStream (const RooAbsArg *self, RooFit::MsgTopic facility, RooFit::MsgLevel level)
	Find appropriate logging stream for message from given object with given topic and message level.

Int_t	activeStream (const TObject *self, RooFit::MsgTopic facility, RooFit::MsgLevel level)
	Find appropriate logging stream for message from given object with given topic and message level.

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
Int_t	_debugCode

RooWorkspace *	_debugWorkspace

std::ostream *	_devnull

Int_t	_errorCount

std::map< std::string, std::ostream * >	_files

RooFit::MsgLevel	_globMinLevel

RooFit::MsgLevel	_lastMsgLevel

Bool_t	_showPid

Bool_t	_silentMode

std::vector< StreamConfig >	_streams

std::stack< std::vector< StreamConfig > >	_streamsSaved

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

Protected Types inherited from TObject
enum	{ kOnlyPrepStep = BIT(3) }

#include <RooMsgService.h>

Inheritance diagram for RooMsgService:

[legend]

Constructor & Destructor Documentation

◆ ~RooMsgService()

RooMsgService::~RooMsgService ( )

virtual

Destructor.

Definition at line 139 of file RooMsgService.cxx.

◆ RooMsgService() [1/2]

RooMsgService::RooMsgService ( )

protected

Constructor.

Defines names of message levels and mapping of topic codes to topic names Install default message streams.

Definition at line 80 of file RooMsgService.cxx.

◆ RooMsgService() [2/2]

RooMsgService::RooMsgService ( const RooMsgService & )

protected

Member Function Documentation

◆ activeStream() [1/2]

Int_t RooMsgService::activeStream	(	const RooAbsArg *	self,
		RooFit::MsgTopic	facility,
		RooFit::MsgLevel	level
	)

protected

Find appropriate logging stream for message from given object with given topic and message level.

Definition at line 416 of file RooMsgService.cxx.

◆ activeStream() [2/2]

Int_t RooMsgService::activeStream	(	const TObject *	self,
		RooFit::MsgTopic	facility,
		RooFit::MsgLevel	level
	)

protected

Find appropriate logging stream for message from given object with given topic and message level.

Definition at line 431 of file RooMsgService.cxx.

◆ addStream()

RooMsgService::addStream	(	RooFit::MsgLevel	level,
		const RooCmdArg &	arg1 = `RooCmdArg()`,
		const RooCmdArg &	arg2 = `RooCmdArg()`,
		const RooCmdArg &	arg3 = `RooCmdArg()`,
		const RooCmdArg &	arg4 = `RooCmdArg()`,
		const RooCmdArg &	arg5 = `RooCmdArg()`,
		const RooCmdArg &	arg6 = `RooCmdArg()`
	)

Add a message logging stream for message with given RooFit::MsgLevel or higher.

Higher means that messages with higher priority/severity are issued.

This method accepts the following arguments to configure the stream:

Output Style options
Prefix(Bool_t flag=kTRUE)	Prefix all messages in this stream with Topic/Originator information
Filtering options
Topic()	Restrict stream to messages on given topic
ObjectName(const char*)	Restrict stream to messages from object with given name
ClassName(const char*)	Restrict stream to messages from objects with given class name
BaseClassName(const char*)	Restrict stream to messages from objects with given base class name
LabelName(const chat*)	Restrict stream to messages from objects setAtrribute(const char*) tag with given name
Output redirection options
OutputFile(const char*)	Send output to file with given name. Multiple streams can write to same file.
OutputStream(ostream&)	Send output to given C++ stream. Multiple message streams can write to same c++ stream

The return value is the unique ID of the defined stream.

PyROOT

The RooMsgService::addStream() function is pythonized with the command argument pythonization. The keywords must correspond to the CmdArg of the function.

Definition at line 198 of file RooMsgService.cxx.

◆ anyDebug()

Bool_t RooMsgService::anyDebug ( )

static

Returns true if any debug level stream is active.

Definition at line 159 of file RooMsgService.cxx.

◆ clearErrorCount()

void RooMsgService::clearErrorCount ( )

inline

Definition at line 181 of file RooMsgService.h.

◆ debugCode()

Int_t & RooMsgService::debugCode ( )

inline

Definition at line 188 of file RooMsgService.h.

◆ debugWorkspace()

RooWorkspace * RooMsgService::debugWorkspace ( )

Definition at line 168 of file RooMsgService.cxx.

◆ deleteStream()

void RooMsgService::deleteStream ( Int_t id )

Delete stream with given unique ID code.

Definition at line 314 of file RooMsgService.cxx.

◆ errorCount()

Int_t RooMsgService::errorCount ( ) const

inline

Definition at line 180 of file RooMsgService.h.

◆ getStream()

StreamConfig & RooMsgService::getStream ( Int_t id )

inline

Definition at line 152 of file RooMsgService.h.

◆ getStreamStatus()

Bool_t RooMsgService::getStreamStatus ( Int_t id ) const

Get activation status of stream with given unique ID.

Definition at line 352 of file RooMsgService.cxx.

◆ globalKillBelow()

RooFit::MsgLevel RooMsgService::globalKillBelow ( ) const

inline

Definition at line 161 of file RooMsgService.h.

◆ instance()

RooMsgService & RooMsgService::instance ( )

static

Return reference to singleton instance.

Definition at line 366 of file RooMsgService.cxx.

◆ isActive() [1/2]

Bool_t RooMsgService::isActive	(	const RooAbsArg *	self,
		RooFit::MsgTopic	facility,
		RooFit::MsgLevel	level
	)

Check if logging is active for given object/topic/RooFitMsgLevel combination.

Definition at line 398 of file RooMsgService.cxx.

◆ isActive() [2/2]

Bool_t RooMsgService::isActive	(	const TObject *	self,
		RooFit::MsgTopic	facility,
		RooFit::MsgLevel	level
	)

Check if logging is active for given object/topic/RooFitMsgLevel combination.

Definition at line 407 of file RooMsgService.cxx.

◆ log() [1/2]

ostream & RooMsgService::log	(	const RooAbsArg *	self,
		RooFit::MsgLevel	level,
		RooFit::MsgTopic	topic,
		Bool_t	skipPrefix = `kFALSE`
	)

Log error message associated with RooAbsArg object self at given level and topic.

If skipPrefix is true the standard RooMsgService prefix is not added.

Definition at line 487 of file RooMsgService.cxx.

◆ log() [2/2]

ostream & RooMsgService::log	(	const TObject *	self,
		RooFit::MsgLevel	level,
		RooFit::MsgTopic	topic,
		Bool_t	skipPrefix = `kFALSE`
	)

Log error message associated with TObject object self at given level and topic.

If skipPrefix is true the standard RooMsgService prefix is not added.

Definition at line 524 of file RooMsgService.cxx.

◆ numStreams()

Int_t RooMsgService::numStreams ( ) const

inline

Definition at line 154 of file RooMsgService.h.

◆ Print()

void RooMsgService::Print ( Option_t * options = 0 ) const

virtual

Print configuration of message service.

If "v" option is given also inactive streams are listed

Reimplemented from TObject.

Definition at line 554 of file RooMsgService.cxx.

◆ reset()

void RooMsgService::reset ( )

Definition at line 113 of file RooMsgService.cxx.

◆ restoreState()

void RooMsgService::restoreState ( )

Restore last saved state of message service.

Definition at line 387 of file RooMsgService.cxx.

◆ saveState()

void RooMsgService::saveState ( )

Save current state of message service.

Definition at line 377 of file RooMsgService.cxx.

◆ setGlobalKillBelow()

void RooMsgService::setGlobalKillBelow ( RooFit::MsgLevel level )

inline

Definition at line 160 of file RooMsgService.h.

◆ setSilentMode()

void RooMsgService::setSilentMode ( Bool_t flag )

inline

Definition at line 178 of file RooMsgService.h.

◆ setStreamStatus()

void RooMsgService::setStreamStatus	(	Int_t	id,
		Bool_t	active
	)

(De)Activate stream with given unique ID

Definition at line 332 of file RooMsgService.cxx.

◆ showPid()

void RooMsgService::showPid ( Bool_t flag )

inline

Definition at line 164 of file RooMsgService.h.

◆ silentMode()

Bool_t RooMsgService::silentMode ( ) const

inline

Definition at line 177 of file RooMsgService.h.

Member Data Documentation

◆ _debugCode

Int_t RooMsgService::_debugCode

protected

Definition at line 214 of file RooMsgService.h.

◆ _debugCount

Int_t RooMsgService::_debugCount = 0

static

Definition at line 172 of file RooMsgService.h.

◆ _debugWorkspace

RooWorkspace* RooMsgService::_debugWorkspace

protected

Definition at line 212 of file RooMsgService.h.

◆ _devnull

std::ostream* RooMsgService::_devnull

protected

Definition at line 197 of file RooMsgService.h.

◆ _errorCount

Int_t RooMsgService::_errorCount

protected

Definition at line 206 of file RooMsgService.h.

◆ _files

std::map<std::string,std::ostream*> RooMsgService::_files

protected

Definition at line 199 of file RooMsgService.h.

◆ _globMinLevel

RooFit::MsgLevel RooMsgService::_globMinLevel

protected

Definition at line 200 of file RooMsgService.h.

◆ _lastMsgLevel

RooFit::MsgLevel RooMsgService::_lastMsgLevel

protected

Definition at line 201 of file RooMsgService.h.

◆ _levelNames

std::map<int,std::string> RooMsgService::_levelNames

Definition at line 173 of file RooMsgService.h.

◆ _showPid

Bool_t RooMsgService::_showPid

protected

Definition at line 204 of file RooMsgService.h.

◆ _silentMode

Bool_t RooMsgService::_silentMode

protected

Definition at line 203 of file RooMsgService.h.

◆ _streams

std::vector<StreamConfig> RooMsgService::_streams

protected

Definition at line 195 of file RooMsgService.h.

◆ _streamsSaved

std::stack<std::vector<StreamConfig> > RooMsgService::_streamsSaved

protected

Definition at line 196 of file RooMsgService.h.

◆ _topicNames

std::map<int,std::string> RooMsgService::_topicNames

Definition at line 174 of file RooMsgService.h.

Libraries for RooMsgService:

[legend]

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

roofit/roofitcore/inc/RooMsgService.h
roofit/roofitcore/src/RooMsgService.cxx
/home/sftnight/build/workspace/root-makedoc-v626/rootspi/rdoc/v626_TMP/pyzdoc/_roofit.pyzdoc

Temporarily change the message level

Temporarily capture a message stream

PyROOT

Classes

Public Member Functions

Static Public Member Functions

Public Attributes

Static Public Attributes

Protected Member Functions

Protected Attributes

Additional Inherited Members

Constructor & Destructor Documentation

◆ ~RooMsgService()

◆ RooMsgService() [1/2]

◆ RooMsgService() [2/2]

Member Function Documentation

◆ activeStream() [1/2]

◆ activeStream() [2/2]

◆ addStream()

PyROOT

◆ anyDebug()

◆ clearErrorCount()

◆ debugCode()

◆ debugWorkspace()

◆ deleteStream()

◆ errorCount()

◆ getStream()

◆ getStreamStatus()

◆ globalKillBelow()

◆ instance()

◆ isActive() [1/2]

◆ isActive() [2/2]

◆ log() [1/2]

◆ log() [2/2]

◆ numStreams()

◆ Print()

◆ reset()

◆ restoreState()

◆ saveState()

◆ setGlobalKillBelow()

◆ setSilentMode()

◆ setStreamStatus()

◆ showPid()

◆ silentMode()

Member Data Documentation

◆ _debugCode

◆ _debugCount

◆ _debugWorkspace

◆ _devnull

◆ _errorCount

◆ _files

◆ _globMinLevel

◆ _lastMsgLevel

◆ _levelNames

◆ _showPid

◆ _silentMode

◆ _streams

◆ _streamsSaved

◆ _topicNames