Logo ROOT  
Reference Guide
 
Loading...
Searching...
No Matches
TMVA::MsgLogger Class Reference

ostringstream derivative to redirect and format output

Definition at line 57 of file MsgLogger.h.

Public Member Functions

 MsgLogger (const MsgLogger &parent)
 copy constructor
 
 MsgLogger (const std::string &source, EMsgType minType=kINFO)
 constructor
 
 MsgLogger (const TObject *source, EMsgType minType=kINFO)
 constructor
 
 MsgLogger (EMsgType minType=kINFO)
 constructor
 
 ~MsgLogger ()
 destructor
 
std::string GetFormattedSource () const
 make sure the source name is no longer than fgMaxSourceSize:
 
EMsgType GetMinType () const
 
std::string GetPrintedSource () const
 the full logger prefix
 
std::string GetSource () const
 
virtual TClassIsA () const
 
MsgLoggeroperator<< (EMsgType type)
 
MsgLoggeroperator<< (MsgLogger &(*_f)(MsgLogger &))
 
MsgLoggeroperator<< (std::ios &(*_f)(std::ios &))
 
MsgLoggeroperator<< (std::ostream &(*_f)(std::ostream &))
 
template<class T >
MsgLoggeroperator<< (T arg)
 
MsgLoggeroperator= (const MsgLogger &parent)
 assignment operator
 
void SetMinType (EMsgType minType)
 
void SetSource (const std::string &source)
 
virtual void Streamer (TBuffer &)
 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 Clear (Option_t *="")
 
virtual TObjectClone (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 TObjectDrawClone (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 TObjectFindObject (const char *name) const
 Must be redefined in derived classes.
 
virtual TObjectFindObject (const TObject *obj) const
 Must be redefined in derived classes.
 
virtual Option_tGetDrawOption () 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_tGetOption () 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)
 
TObjectoperator= (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 void Print (Option_t *option="") const
 This method must be overridden when a class wants to print itself.
 
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 TClassClass ()
 
static const char * Class_Name ()
 
static constexpr Version_t Class_Version ()
 
static const char * DeclFileName ()
 
static void EnableOutput ()
 
static MsgLoggerEndmsg (MsgLogger &logger)
 end line
 
static UInt_t GetMaxSourceSize ()
 returns the maximum source size
 
static void InhibitOutput ()
 
- Static Public Member Functions inherited from TObject
static TClassClass ()
 
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.
 

Private Member Functions

void InitMaps ()
 Create the message type and color maps.
 
void Send ()
 activates the logger writer
 
void WriteMsg (EMsgType type, const std::string &line) const
 putting the output string, the message type, and the color switcher together into a single string
 

Private Attributes

EMsgType fActiveType
 active type
 
EMsgType fMinType
 minimum type for output
 
const TObjectfObjSource
 the source TObject (used for name)
 
std::string fStrSource
 alternative string source
 

Static Private Attributes

static std::atomic< const std::map< EMsgType, std::string > * > fgColorMap {0}
 matches output types with terminal colors
 
static std::atomic< Bool_tfgInhibitOutput {kFALSE}
 flag to suppress all output
 
static const UInt_t fgMaxSourceSize = 25
 maximum length of source name
 
static std::atomic< Bool_tfgOutputSupressed
 disable the output globally (used by generic booster)
 
static const std::string fgPrefix = ""
 the prefix of the source name
 
static const std::string fgSuffix = ": "
 suffix following source name
 
static std::atomic< const std::map< EMsgType, std::string > * > fgTypeMap {0}
 matches output types with strings
 

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 )) }
 
- 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 ()
 

#include <TMVA/MsgLogger.h>

Inheritance diagram for TMVA::MsgLogger:
[legend]

Constructor & Destructor Documentation

◆ MsgLogger() [1/4]

TMVA::MsgLogger::MsgLogger ( const TObject source,
EMsgType  minType = kINFO 
)

constructor

Definition at line 72 of file MsgLogger.cxx.

◆ MsgLogger() [2/4]

TMVA::MsgLogger::MsgLogger ( const std::string &  source,
EMsgType  minType = kINFO 
)

constructor

Definition at line 84 of file MsgLogger.cxx.

◆ MsgLogger() [3/4]

TMVA::MsgLogger::MsgLogger ( EMsgType  minType = kINFO)

constructor

Definition at line 96 of file MsgLogger.cxx.

◆ MsgLogger() [4/4]

TMVA::MsgLogger::MsgLogger ( const MsgLogger parent)

copy constructor

Definition at line 108 of file MsgLogger.cxx.

◆ ~MsgLogger()

TMVA::MsgLogger::~MsgLogger ( )

destructor

Definition at line 121 of file MsgLogger.cxx.

Member Function Documentation

◆ Class()

static TClass * TMVA::MsgLogger::Class ( )
static
Returns
TClass describing this class

◆ Class_Name()

static const char * TMVA::MsgLogger::Class_Name ( )
static
Returns
Name of this class

◆ Class_Version()

static constexpr Version_t TMVA::MsgLogger::Class_Version ( )
inlinestaticconstexpr
Returns
Version of this class

Definition at line 121 of file MsgLogger.h.

◆ DeclFileName()

static const char * TMVA::MsgLogger::DeclFileName ( )
inlinestatic
Returns
Name of the file containing the class declaration

Definition at line 121 of file MsgLogger.h.

◆ EnableOutput()

void TMVA::MsgLogger::EnableOutput ( )
static

Definition at line 68 of file MsgLogger.cxx.

◆ Endmsg()

TMVA::MsgLogger & TMVA::MsgLogger::Endmsg ( MsgLogger logger)
static

end line

Definition at line 261 of file MsgLogger.cxx.

◆ GetFormattedSource()

std::string TMVA::MsgLogger::GetFormattedSource ( ) const

make sure the source name is no longer than fgMaxSourceSize:

Definition at line 143 of file MsgLogger.cxx.

◆ GetMaxSourceSize()

UInt_t TMVA::MsgLogger::GetMaxSourceSize ( )
static

returns the maximum source size

Definition at line 165 of file MsgLogger.cxx.

◆ GetMinType()

EMsgType TMVA::MsgLogger::GetMinType ( ) const
inline

Definition at line 69 of file MsgLogger.h.

◆ GetPrintedSource()

std::string TMVA::MsgLogger::GetPrintedSource ( ) const

the full logger prefix

Definition at line 173 of file MsgLogger.cxx.

◆ GetSource()

std::string TMVA::MsgLogger::GetSource ( ) const
inline

Definition at line 71 of file MsgLogger.h.

◆ InhibitOutput()

void TMVA::MsgLogger::InhibitOutput ( )
static

Definition at line 67 of file MsgLogger.cxx.

◆ InitMaps()

void TMVA::MsgLogger::InitMaps ( )
private

Create the message type and color maps.

Definition at line 270 of file MsgLogger.cxx.

◆ IsA()

virtual TClass * TMVA::MsgLogger::IsA ( ) const
inlinevirtual
Returns
TClass describing current object

Reimplemented from TObject.

Definition at line 121 of file MsgLogger.h.

◆ operator<<() [1/5]

MsgLogger & TMVA::MsgLogger::operator<< ( EMsgType  type)
inline

Definition at line 141 of file MsgLogger.h.

◆ operator<<() [2/5]

MsgLogger & TMVA::MsgLogger::operator<< ( MsgLogger &(*)(MsgLogger &)  _f)
inline

Definition at line 124 of file MsgLogger.h.

◆ operator<<() [3/5]

MsgLogger & TMVA::MsgLogger::operator<< ( std::ios &(*)(std::ios &)  _f)
inline

Definition at line 135 of file MsgLogger.h.

◆ operator<<() [4/5]

MsgLogger & TMVA::MsgLogger::operator<< ( std::ostream &(*)(std::ostream &)  _f)
inline

Definition at line 129 of file MsgLogger.h.

◆ operator<<() [5/5]

template<class T >
MsgLogger & TMVA::MsgLogger::operator<< ( arg)
inline

Definition at line 92 of file MsgLogger.h.

◆ operator=()

TMVA::MsgLogger & TMVA::MsgLogger::operator= ( const MsgLogger parent)

assignment operator

Definition at line 128 of file MsgLogger.cxx.

◆ Send()

void TMVA::MsgLogger::Send ( )
private

activates the logger writer

Definition at line 185 of file MsgLogger.cxx.

◆ SetMinType()

void TMVA::MsgLogger::SetMinType ( EMsgType  minType)
inline

Definition at line 70 of file MsgLogger.h.

◆ SetSource()

void TMVA::MsgLogger::SetSource ( const std::string &  source)
inline

Definition at line 68 of file MsgLogger.h.

◆ Streamer()

virtual void TMVA::MsgLogger::Streamer ( TBuffer R__b)
virtual

Stream an object of class TObject.

Reimplemented from TObject.

◆ StreamerNVirtual()

void TMVA::MsgLogger::StreamerNVirtual ( TBuffer ClassDef_StreamerNVirtual_b)
inline

Definition at line 121 of file MsgLogger.h.

◆ WriteMsg()

void TMVA::MsgLogger::WriteMsg ( EMsgType  type,
const std::string &  line 
) const
private

putting the output string, the message type, and the color switcher together into a single string

Definition at line 220 of file MsgLogger.cxx.

Member Data Documentation

◆ fActiveType

EMsgType TMVA::MsgLogger::fActiveType
private

active type

Definition at line 112 of file MsgLogger.h.

◆ fgColorMap

std::atomic< const std::map< TMVA::EMsgType, std::string > * > TMVA::MsgLogger::fgColorMap {0}
staticprivate

matches output types with terminal colors

Definition at line 118 of file MsgLogger.h.

◆ fgInhibitOutput

std::atomic< Bool_t > TMVA::MsgLogger::fgInhibitOutput {kFALSE}
staticprivate

flag to suppress all output

Definition at line 115 of file MsgLogger.h.

◆ fgMaxSourceSize

const UInt_t TMVA::MsgLogger::fgMaxSourceSize = 25
staticprivate

maximum length of source name

Definition at line 113 of file MsgLogger.h.

◆ fgOutputSupressed

std::atomic<Bool_t> TMVA::MsgLogger::fgOutputSupressed
staticprivate

disable the output globally (used by generic booster)

Definition at line 114 of file MsgLogger.h.

◆ fgPrefix

const std::string TMVA::MsgLogger::fgPrefix = ""
staticprivate

the prefix of the source name

Definition at line 110 of file MsgLogger.h.

◆ fgSuffix

const std::string TMVA::MsgLogger::fgSuffix = ": "
staticprivate

suffix following source name

Definition at line 111 of file MsgLogger.h.

◆ fgTypeMap

std::atomic< const std::map< TMVA::EMsgType, std::string > * > TMVA::MsgLogger::fgTypeMap {0}
staticprivate

matches output types with strings

Definition at line 117 of file MsgLogger.h.

◆ fMinType

EMsgType TMVA::MsgLogger::fMinType
private

minimum type for output

Definition at line 119 of file MsgLogger.h.

◆ fObjSource

const TObject* TMVA::MsgLogger::fObjSource
private

the source TObject (used for name)

Definition at line 108 of file MsgLogger.h.

◆ fStrSource

std::string TMVA::MsgLogger::fStrSource
private

alternative string source

Definition at line 109 of file MsgLogger.h.

Libraries for TMVA::MsgLogger:

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