Singleton class 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().
There is a helper, RooHelpers::LocalChangeMsgLevel, that overrides the default message levels as long as it is alive. To suppress everything below WARNING:
RooHelpers::HijackMessageStream allows to fully capture a message stream in a std::stringstream. With this, RooFit messages can be evaluated or suppressed.
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:
Definition at line 110 of file RooMsgService.h.
Classes | |
struct | StreamConfig |
Public Member Functions | |
~RooMsgService () override | |
Int_t | addStream (RooFit::MsgLevel level, const RooCmdArg &arg1={}, const RooCmdArg &arg2={}, const RooCmdArg &arg3={}, const RooCmdArg &arg4={}, const RooCmdArg &arg5={}, const RooCmdArg &arg6={}) |
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 | getStreamStatus (Int_t id) const |
Get activation status of stream with given unique ID. | |
RooFit::MsgLevel | globalKillBelow () const |
TClass * | IsA () const override |
template<class T > | |
bool | isActive (T self, RooFit::MsgTopic topic, RooFit::MsgLevel level) |
Check if logging is active for given object/topic/RooFit::MsgLevel combination. | |
std::ostream & | log (const RooAbsArg *self, RooFit::MsgLevel level, RooFit::MsgTopic facility, bool forceSkipPrefix=false) |
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 forceSkipPrefix=false) |
Log error message associated with TObject object self at given level and topic. | |
std::ostream & | log (std::nullptr_t, RooFit::MsgLevel level, RooFit::MsgTopic facility, bool forceSkipPrefix=false) |
Int_t | numStreams () const |
void | Print (Option_t *options=nullptr) const override |
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 flag) |
void | setStreamStatus (Int_t id, bool active) |
(De)Activate stream with given unique ID | |
void | showPid (bool flag) |
bool | silentMode () const |
void | Streamer (TBuffer &) override |
Stream an object of class TObject. | |
void | StreamerNVirtual (TBuffer &ClassDef_StreamerNVirtual_b) |
![]() | |
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 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 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 (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) |
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. | |
Static Public Member Functions | |
static bool | anyDebug () |
Returns true if any debug level stream is active. | |
static TClass * | Class () |
static const char * | Class_Name () |
static constexpr Version_t | Class_Version () |
static const char * | DeclFileName () |
static RooMsgService & | instance () |
Return reference to singleton instance. | |
![]() | |
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. | |
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 &) | |
template<class T > | |
Int_t | activeStream (T self, RooFit::MsgTopic topic, RooFit::MsgLevel level) |
Find appropriate logging stream for message from given object with given topic and message level. | |
![]() | |
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 |
std::unique_ptr< RooWorkspace > | _debugWorkspace |
std::unique_ptr< std::ofstream > | _devnull |
Int_t | _errorCount |
std::map< std::string, std::unique_ptr< std::ostream > > | _files |
RooFit::MsgLevel | _globMinLevel |
RooFit::MsgLevel | _lastMsgLevel |
bool | _showPid |
bool | _silentMode |
std::vector< StreamConfig > | _streams |
std::stack< std::vector< StreamConfig > > | _streamsSaved |
Additional Inherited Members | |
![]() | |
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 )) } |
![]() | |
enum | { kOnlyPrepStep = (1ULL << ( 3 )) } |
#include <RooMsgService.h>
|
overridedefault |
|
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.
|
protected |
|
inlineprotected |
Find appropriate logging stream for message from given object with given topic and message level.
Definition at line 213 of file RooMsgService.h.
RooMsgService::addStream | ( | RooFit::MsgLevel | level, |
const RooCmdArg & | arg1 = {}, | ||
const RooCmdArg & | arg2 = {}, | ||
const RooCmdArg & | arg3 = {}, | ||
const RooCmdArg & | arg4 = {}, | ||
const RooCmdArg & | arg5 = {}, | ||
const RooCmdArg & | arg6 = {} ) |
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 flag=true) | 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 setAttribute(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.
The RooMsgService::addStream() function is pythonized with the command argument pythonization. The keywords must correspond to the CmdArg of the function.
Definition at line 177 of file RooMsgService.cxx.
|
static |
Returns true if any debug level stream is active.
Definition at line 138 of file RooMsgService.cxx.
Definition at line 246 of file RooMsgService.h.
|
inline |
Definition at line 200 of file RooMsgService.h.
|
inline |
Definition at line 207 of file RooMsgService.h.
RooWorkspace * RooMsgService::debugWorkspace | ( | ) |
Definition at line 147 of file RooMsgService.cxx.
Definition at line 246 of file RooMsgService.h.
void RooMsgService::deleteStream | ( | Int_t | id | ) |
Delete stream with given unique ID code.
Definition at line 293 of file RooMsgService.cxx.
|
inline |
Definition at line 199 of file RooMsgService.h.
|
inline |
Definition at line 161 of file RooMsgService.h.
Get activation status of stream with given unique ID.
Definition at line 331 of file RooMsgService.cxx.
|
inline |
Definition at line 170 of file RooMsgService.h.
|
static |
Return reference to singleton instance.
Definition at line 345 of file RooMsgService.cxx.
|
inlineoverridevirtual |
Reimplemented from TObject.
Definition at line 246 of file RooMsgService.h.
|
inline |
Check if logging is active for given object/topic/RooFit::MsgLevel combination.
Definition at line 186 of file RooMsgService.h.
ostream & RooMsgService::log | ( | const RooAbsArg * | self, |
RooFit::MsgLevel | level, | ||
RooFit::MsgTopic | topic, | ||
bool | skipPrefix = false ) |
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 419 of file RooMsgService.cxx.
ostream & RooMsgService::log | ( | const TObject * | self, |
RooFit::MsgLevel | level, | ||
RooFit::MsgTopic | topic, | ||
bool | skipPrefix = false ) |
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 456 of file RooMsgService.cxx.
|
inline |
Definition at line 180 of file RooMsgService.h.
|
inline |
Definition at line 163 of file RooMsgService.h.
|
overridevirtual |
Print configuration of message service.
If "v" option is given also inactive streams are listed
Reimplemented from TObject.
Definition at line 486 of file RooMsgService.cxx.
void RooMsgService::reset | ( | ) |
Definition at line 113 of file RooMsgService.cxx.
void RooMsgService::restoreState | ( | ) |
Restore last saved state of message service.
Definition at line 366 of file RooMsgService.cxx.
void RooMsgService::saveState | ( | ) |
Save current state of message service.
Definition at line 356 of file RooMsgService.cxx.
|
inline |
Definition at line 169 of file RooMsgService.h.
|
inline |
Definition at line 197 of file RooMsgService.h.
(De)Activate stream with given unique ID
Definition at line 311 of file RooMsgService.cxx.
|
inline |
Definition at line 173 of file RooMsgService.h.
|
inline |
Definition at line 196 of file RooMsgService.h.
|
overridevirtual |
|
inline |
Definition at line 246 of file RooMsgService.h.
|
protected |
Definition at line 244 of file RooMsgService.h.
|
static |
Definition at line 191 of file RooMsgService.h.
|
protected |
Definition at line 242 of file RooMsgService.h.
|
protected |
Definition at line 227 of file RooMsgService.h.
|
protected |
Definition at line 236 of file RooMsgService.h.
|
protected |
Definition at line 229 of file RooMsgService.h.
|
protected |
Definition at line 230 of file RooMsgService.h.
|
protected |
Definition at line 231 of file RooMsgService.h.
std::map<int,std::string> RooMsgService::_levelNames |
Definition at line 192 of file RooMsgService.h.
|
protected |
Definition at line 234 of file RooMsgService.h.
|
protected |
Definition at line 233 of file RooMsgService.h.
|
protected |
Definition at line 225 of file RooMsgService.h.
|
protected |
Definition at line 226 of file RooMsgService.h.
std::map<int,std::string> RooMsgService::_topicNames |
Definition at line 193 of file RooMsgService.h.