ROOT 6.10/09 Reference Guide |
The RooMsgService class is a singleton class that organizes informational, debugging, warning and errors messages generated by the RooFit core code.
Each message generated by the core has a message level (DEBUG,INFO,PROGRESS,WARNING,ERROR or FATAL), an originating object, and a 'topic'. Currently implemented topics are "Generation","Plotting", "Integration", "Minimization" and "Workspace" and "ChangeTracking". The RooMsgService class 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() ;
Definition at line 104 of file RooMsgService.h.
Classes | |
struct | StreamConfig |
Public Member Functions | |
virtual | ~RooMsgService () |
Destructor. More... | |
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 (i.e. More... | |
void | clearErrorCount () |
Int_t & | debugCode () |
RooWorkspace * | debugWorkspace () |
void | deleteStream (Int_t id) |
Delete stream with given unique ID code. More... | |
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. More... | |
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/RooFit::MsgLevel combination. More... | |
Bool_t | isActive (const TObject *self, RooFit::MsgTopic facility, RooFit::MsgLevel level) |
Check if logging is active for given object/topic/RooFit::MsgLevel combination. More... | |
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. More... | |
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. More... | |
Int_t | numStreams () const |
void | Print (Option_t *options=0) const |
Print configuration of message service. More... | |
void | reset () |
void | restoreState () |
Restore last saved state of message service. More... | |
void | saveState () |
Save current state of message service. More... | |
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 More... | |
void | showPid (Bool_t flag) |
Bool_t | silentMode () const |
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 | Clear (Option_t *="") |
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 abstract method. More... | |
virtual void | Copy (TObject &object) const |
Copy this to obj. 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 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 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 const char * | GetIconName () const |
Returns mime type name of object. More... | |
virtual const char * | GetName () const |
Returns 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_t * | GetOption () const |
virtual const char * | GetTitle () const |
Returns title of object. More... | |
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 ULong_t | Hash () const |
Return hash value for this object. 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 |
virtual Bool_t | IsSortable () const |
Bool_t | IsZombie () const |
virtual void | ls (Option_t *option="") const |
The ls function lists the contents of a class on stdout. 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... | |
virtual Bool_t | Notify () |
This method must be overridden to handle object notification. 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... | |
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. 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... | |
Static Public Member Functions | |
static Bool_t | anyDebug () |
Returns true if any debug level stream is active. More... | |
static void | cleanup () |
Cleanup function called by atexit() handler installed by RooSentinel to delete all global object upon program termination. More... | |
static RooMsgService & | instance () |
Return reference to singleton instance. More... | |
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... | |
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. More... | |
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. More... | |
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. More... | |
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 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 |
Static Protected Attributes | |
static RooMsgService * | _instance = 0 |
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) } |
#include <RooMsgService.h>
|
virtual |
Destructor.
Definition at line 137 of file RooMsgService.cxx.
|
protected |
Constructor.
Defines names of message levels and mapping of topic codes to topic names Install default message streams.
Definition at line 90 of file RooMsgService.cxx.
|
protected |
|
protected |
Find appropriate logging stream for message from given object with given topic and message level.
Definition at line 414 of file RooMsgService.cxx.
|
protected |
Find appropriate logging stream for message from given object with given topic and message level.
Definition at line 429 of file RooMsgService.cxx.
Int_t 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 (i.e.
more severe) This method accepts the following arguments to configure the stream
Prefix(Bool_t flag=kTRUE) – Prefix all messages in this stream with Topic/Originator information
Topic(const char*) – 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
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 code of the defined stream
Definition at line 199 of file RooMsgService.cxx.
|
static |
Returns true if any debug level stream is active.
Definition at line 157 of file RooMsgService.cxx.
|
static |
Cleanup function called by atexit() handler installed by RooSentinel to delete all global object upon program termination.
Definition at line 75 of file RooMsgService.cxx.
|
inline |
Definition at line 181 of file RooMsgService.h.
|
inline |
Definition at line 188 of file RooMsgService.h.
RooWorkspace * RooMsgService::debugWorkspace | ( | ) |
Definition at line 166 of file RooMsgService.cxx.
Delete stream with given unique ID code.
Definition at line 309 of file RooMsgService.cxx.
|
inline |
Definition at line 180 of file RooMsgService.h.
|
inline |
Definition at line 150 of file RooMsgService.h.
Get activation status of stream with given unique ID.
Definition at line 347 of file RooMsgService.cxx.
|
inline |
Definition at line 159 of file RooMsgService.h.
|
static |
Return reference to singleton instance.
Definition at line 361 of file RooMsgService.cxx.
Bool_t RooMsgService::isActive | ( | const RooAbsArg * | self, |
RooFit::MsgTopic | facility, | ||
RooFit::MsgLevel | level | ||
) |
Check if logging is active for given object/topic/RooFit::MsgLevel combination.
Definition at line 396 of file RooMsgService.cxx.
Bool_t RooMsgService::isActive | ( | const TObject * | self, |
RooFit::MsgTopic | facility, | ||
RooFit::MsgLevel | level | ||
) |
Check if logging is active for given object/topic/RooFit::MsgLevel combination.
Definition at line 405 of file RooMsgService.cxx.
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 485 of file RooMsgService.cxx.
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 522 of file RooMsgService.cxx.
|
inline |
Definition at line 152 of file RooMsgService.h.
Print configuration of message service.
If "v" option is given also inactive streams are listed
Reimplemented from TObject.
Definition at line 552 of file RooMsgService.cxx.
|
inline |
Definition at line 156 of file RooMsgService.h.
void RooMsgService::restoreState | ( | ) |
Restore last saved state of message service.
Definition at line 385 of file RooMsgService.cxx.
void RooMsgService::saveState | ( | ) |
Save current state of message service.
Definition at line 375 of file RooMsgService.cxx.
|
inline |
Definition at line 158 of file RooMsgService.h.
Definition at line 178 of file RooMsgService.h.
(De)Activate stream with given unique ID
Definition at line 327 of file RooMsgService.cxx.
Definition at line 162 of file RooMsgService.h.
|
inline |
Definition at line 177 of file RooMsgService.h.
|
protected |
Definition at line 216 of file RooMsgService.h.
|
static |
Definition at line 170 of file RooMsgService.h.
|
protected |
Definition at line 214 of file RooMsgService.h.
|
protected |
Definition at line 197 of file RooMsgService.h.
|
protected |
Definition at line 206 of file RooMsgService.h.
|
protected |
Definition at line 199 of file RooMsgService.h.
|
protected |
Definition at line 200 of file RooMsgService.h.
|
staticprotected |
Definition at line 212 of file RooMsgService.h.
|
protected |
Definition at line 201 of file RooMsgService.h.
std::map<int,std::string> RooMsgService::_levelNames |
Definition at line 171 of file RooMsgService.h.
|
protected |
Definition at line 204 of file RooMsgService.h.
|
protected |
Definition at line 203 of file RooMsgService.h.
|
protected |
Definition at line 195 of file RooMsgService.h.
|
protected |
Definition at line 196 of file RooMsgService.h.
std::map<int,std::string> RooMsgService::_topicNames |
Definition at line 172 of file RooMsgService.h.