Quick Links: ROOT Homepage Class Index Class Hierarchy

Source: header file source file inheritance tree (.pdf)

Sections: class description function members data members class charts

class AliLog: public TObject


class for logging debug, info and error messages

The AliLog class is a singleton class. It allows to steer the output
level and output streams for different types of messages via static
methods.

It also handles the messages produces by the preprocessor macros defined
in the header file: AliDebug, AliInfo, AliWarning, AliError, AliFatal.

More details about the message logging can be found on the ALICE Offline
web page.

Function Members (Methods)

public:

void	TObject::AbstractMethod(const char* method) const
virtual void	TObject::AppendPad(Option_t* option = "")
virtual void	TObject::Browse(TBrowser* b)
static TClass*	Class()
virtual const char*	TObject::ClassName() const
virtual void	TObject::Clear(Option_t* = "")
static void	ClearClassDebugLevel(const char* className)
static void	ClearModuleDebugLevel(const char* module)
virtual TObject*	TObject::Clone(const char* newname = "") const
virtual Int_t	TObject::Compare(const TObject* obj) const
virtual void	TObject::Copy(TObject& object) const
static void	Debug(UInt_t level, const char* message, const char* module, const char* className, const char* function, const char* file, Int_t line)
virtual void	TObject::Delete(Option_t* option = "")MENU
static void	DeleteRootLogger()
virtual Int_t	TObject::DistancetoPrimitive(Int_t px, Int_t py)
virtual void	TObject::Draw(Option_t* option = "")
virtual void	TObject::DrawClass() constMENU
virtual TObject*	TObject::DrawClone(Option_t* option = "") constMENU
virtual void	TObject::Dump() constMENU
static void	EnableCoreDump(Bool_t enabled)
static void	EnableDebug(Bool_t enabled)
virtual void	TObject::Error(const char* method, const char* msgfmt) const
virtual void	TObject::Execute(const char* method, const char* params, Int_t* error = 0)
virtual void	TObject::Execute(TMethod* method, TObjArray* params, Int_t* error = 0)
virtual void	TObject::ExecuteEvent(Int_t event, Int_t px, Int_t py)
virtual void	TObject::Fatal(const char* method, const char* msgfmt) const
virtual TObject*	TObject::FindObject(const char* name) const
virtual TObject*	TObject::FindObject(const TObject* obj) const
static void	Flush()
static Int_t	GetDebugLevel(const char* module, const char* className)
virtual Option_t*	TObject::GetDrawOption() const
static Long_t	TObject::GetDtorOnly()
static Int_t	GetGlobalDebugLevel()
static Int_t	GetGlobalLogLevel()
virtual const char*	TObject::GetIconName() const
virtual const char*	TObject::GetName() const
virtual char*	TObject::GetObjectInfo(Int_t px, Int_t py) const
static Bool_t	TObject::GetObjectStat()
virtual Option_t*	TObject::GetOption() const
static AliLog*	GetRootLogger()
virtual const char*	TObject::GetTitle() const
virtual UInt_t	TObject::GetUniqueID() const
virtual Bool_t	TObject::HandleTimer(TTimer* timer)
virtual ULong_t	TObject::Hash() const
virtual void	TObject::Info(const char* method, const char* msgfmt) const
virtual Bool_t	TObject::InheritsFrom(const char* classname) const
virtual Bool_t	TObject::InheritsFrom(const TClass* cl) const
virtual void	TObject::Inspect() constMENU
void	TObject::InvertBit(UInt_t f)
virtual TClass*	IsA() const
static Bool_t	IsDebugEnabled()
virtual Bool_t	TObject::IsEqual(const TObject* obj) const
virtual Bool_t	TObject::IsFolder() const
Bool_t	TObject::IsOnHeap() const
virtual Bool_t	TObject::IsSortable() const
Bool_t	TObject::IsZombie() const
virtual void	TObject::ls(Option_t* option = "") const
static void	MakeCoreDump(const char* fout)
void	TObject::MayNotUse(const char* method) const
static void	Message(UInt_t level, const char* message, const char* module, const char* className, const char* function, const char* file, Int_t line)
virtual Bool_t	TObject::Notify()
void	TObject::Obsolete(const char* method, const char* asOfVers, const char* removedFromVers) const
static void	TObject::operator delete(void* ptr)
static void	TObject::operator delete(void* ptr, void* vp)
static void	TObject::operator delete[](void* ptr)
static void	TObject::operator delete[](void* ptr, void* vp)
void*	TObject::operator new(size_t sz)
void*	TObject::operator new(size_t sz, void* vp)
void*	TObject::operator new[](size_t sz)
void*	TObject::operator new[](size_t sz, void* vp)
virtual void	TObject::Paint(Option_t* option = "")
virtual void	TObject::Pop()
virtual void	TObject::Print(Option_t* option = "") const
virtual Int_t	TObject::Read(const char* name)
virtual void	TObject::RecursiveRemove(TObject* obj)
static Int_t	RedirectStderrTo(AliLog::EType_t type, UInt_t level, const char* module, const char* className, const char* function, const char* file, Int_t line, Bool_t print)
static Int_t	RedirectStdoutTo(AliLog::EType_t type, UInt_t level, const char* module, const char* className, const char* function, const char* file, Int_t line, Bool_t print)
void	TObject::ResetBit(UInt_t f)
static void	RestoreStderr(Int_t original)
static void	RestoreStdout(Int_t original)
virtual void	TObject::SaveAs(const char* filename = "", Option_t* option = "") constMENU
virtual void	TObject::SavePrimitive(basic_ostream<char,char_traits<char> >& out, Option_t* option = "")
void	TObject::SetBit(UInt_t f)
void	TObject::SetBit(UInt_t f, Bool_t set)
static void	SetClassDebugLevel(const char* className, Int_t level)
virtual void	TObject::SetDrawOption(Option_t* option = "")MENU
static void	TObject::SetDtorOnly(void* obj)
static void	SetErrorOutput()
static void	SetErrorOutput(AliLog::EType_t type)
static void	SetFileOutput(const char* fileName)
static void	SetFileOutput(AliLog::EType_t type, const char* fileName)
static void	SetGlobalDebugLevel(Int_t level)
static void	SetGlobalLogLevel(AliLog::EType_t type)
static void	SetHandleRootMessages(Bool_t on)
static void	SetLogNotification(AliLog::AliLogNotification pCallBack)
static void	SetLogNotification(AliLog::EType_t type, AliLog::AliLogNotification pCallBack)
static void	SetModuleDebugLevel(const char* module, Int_t level)
static void	TObject::SetObjectStat(Bool_t stat)
static void	SetPrintLocation(Bool_t on)
static void	SetPrintLocation(AliLog::EType_t type, Bool_t on)
static void	SetPrintModule(Bool_t on)
static void	SetPrintModule(AliLog::EType_t type, Bool_t on)
static void	SetPrintRepetitions(Bool_t on)
static void	SetPrintScope(Bool_t on)
static void	SetPrintScope(AliLog::EType_t type, Bool_t on)
static void	SetPrintType(Bool_t on)
static void	SetPrintType(AliLog::EType_t type, Bool_t on)
static void	SetStandardOutput()
static void	SetStandardOutput(AliLog::EType_t type)
static void	SetStreamOutput(ostream* stream)
static void	SetStreamOutput(AliLog::EType_t type, ostream* stream)
virtual void	TObject::SetUniqueID(UInt_t uid)
virtual void	ShowMembers(TMemberInspector&)
static ostream&	Stream(AliLog::EType_t type, UInt_t level, const char* module, const char* className, const char* function, const char* file, Int_t line)
virtual void	Streamer(TBuffer&)
void	StreamerNVirtual(TBuffer& ClassDef_StreamerNVirtual_b)
virtual void	TObject::SysError(const char* method, const char* msgfmt) const
Bool_t	TObject::TestBit(UInt_t f) const
Int_t	TObject::TestBits(UInt_t f) const
static void	TestException(Int_t level = 10)
virtual void	TObject::UseCurrentStyle()
virtual void	TObject::Warning(const char* method, const char* msgfmt) const
virtual Int_t	TObject::Write(const char* name = 0, Int_t option = 0, Int_t bufsize = 0)
virtual Int_t	TObject::Write(const char* name = 0, Int_t option = 0, Int_t bufsize = 0) const
static void	WriteToFile(const char* name, Int_t option = 0)

protected:

virtual void	TObject::DoError(int level, const char* location, const char* fmt, va_list va) const
void	TObject::MakeZombie()

private:

	AliLog()
	AliLog(const AliLog& log)
(unknown)	()
void	CloseFile(Int_t type)
UInt_t	GetLogLevel(const char* module, const char* className) const
FILE*	GetOutputStream(Int_t type)
ostream&	GetStream(AliLog::EType_t type, UInt_t level, const char* module, const char* className, const char* function, const char* file, Int_t line)
AliLog&	operator=(const AliLog& log)
void	PrintMessage(UInt_t type, const char* message, const char* module, const char* className, const char* function, const char* file, Int_t line)
void	PrintRepetitions()
void	PrintString(Int_t type, FILE* stream, const char* format)
void	ReadEnvSettings()
Int_t	RedirectTo(FILE* stream, AliLog::EType_t type, UInt_t level, const char* module, const char* className, const char* function, const char* file, Int_t line, Bool_t print)
static void	RootErrorHandler(Int_t level, Bool_t abort, const char* location, const char* message)

Data Members

public:

enum EType_t {	kFatal
	kError
	kWarning
	kInfo
	kDebug
	kMaxType
};
enum {	kDebugOffset
};
enum TObject::EStatusBits {	kCanDelete
	kMustCleanup
	kObjInCanvas
	kIsReferenced
	kHasUUID
	kCannotPick
	kNoContextMenu
	kInvalidObject
};
enum TObject::[unnamed] {	kIsOnHeap
	kNotDeleted
	kZombie
	kBitMask
	kSingleKey
	kOverwrite
	kWriteDelete
};

private:

void*	fCallBacks[5]	! external notification callback
TObjArray	fClassDebugLevels	debug levels for classes
TString	fFileNames[5]	file names
UInt_t	fGlobalLogLevel	global logging level
TString	fLastClassName	! class name of last message
TString	fLastFile	! file name of last message
TString	fLastFunction	! function name of last message
Int_t	fLastLine	! line number of last message
TString	fLastMessage	! last message
TString	fLastModule	! module name of last message
UInt_t	fLastType	! type of last message
TObjArray	fModuleDebugLevels	debug levels for modules
FILE*	fOutputFiles[5]	! log output files
ostream*	fOutputStreams[5]	! log output streams
Int_t	fOutputTypes[5]	types of output streams
Bool_t	fPrintLocation[5]	print file and line on/off
Bool_t	fPrintModule[5]	print module on/off
Bool_t	fPrintRepetitions	print number of repetitions instead of repeated message on/off
Bool_t	fPrintScope[5]	print scope/class name on/off
Bool_t	fPrintType[5]	print type on/off
Int_t	fRepetitions	! counter of repetitions
static Bool_t	fgCoreEnabled	flag for core dump en-/disabling
static Bool_t	fgDebugEnabled	flag for debug en-/disabling
static AliLog*	fgInstance	! pointer to current instance

Class Charts

Inheritance Chart:

TObject

←

AliLog

Function documentation

AliLog * GetRootLogger()

void DeleteRootLogger()

AliLog()

 default constructor: set default values

AliLog(const AliLog& log)

 copy constructor

void ReadEnvSettings()

 load settings from the root configuration file (.rootrc)
 and from environment variables

void RootErrorHandler(Int_t level, Bool_t abort, const char* location, const char* message)

 new error handler for messages from root

void EnableDebug(Bool_t enabled)

 enable or disable debug output

void EnableCoreDump(Bool_t enabled)

 enable or disable debug output

void SetGlobalLogLevel(AliLog::EType_t type)

 set the global debug level

Int_t GetGlobalLogLevel()

 get the global debug level

void SetGlobalDebugLevel(Int_t level)

 set the global debug level

Int_t GetGlobalDebugLevel()

 get the global debug level

void SetModuleDebugLevel(const char* module, Int_t level)

 set the debug level for the given module

void ClearModuleDebugLevel(const char* module)

 remove the setting of the debug level for the given module

void SetClassDebugLevel(const char* className, Int_t level)

 set the debug level for the given class

void ClearClassDebugLevel(const char* className)

 remove the setting of the debug level for the given class

void SetStandardOutput()

 write all log messages to the standard output (stdout)

void SetStandardOutput(AliLog::EType_t type)

 write log messages of the given type to the standard output (stdout)

void SetErrorOutput()

 write all log messages to the error output (stderr)

void SetErrorOutput(AliLog::EType_t type)

 write log messages of the given type to the error output (stderr)

void SetFileOutput(const char* fileName)

 write all log messages to the given file

void SetFileOutput(AliLog::EType_t type, const char* fileName)

 write log messages of the given type to the given file

void CloseFile(Int_t type)

 close the file for the given type if needed

FILE* GetOutputStream(Int_t type)

 get the output stream for the given type of messages

void Flush()

 flush the output streams

void SetHandleRootMessages(Bool_t on)

 enable or disable the handling of messages form root

void SetPrintType(Bool_t on)

 switch on or off the printing of the message type for all message types

void SetPrintType(AliLog::EType_t type, Bool_t on)

 switch on or off the printing of the message type for the given message type

void SetPrintModule(Bool_t on)

 switch on or off the printing of the module for all message types

void SetPrintModule(AliLog::EType_t type, Bool_t on)

 switch on or off the printing of the module for the given message type

void SetPrintScope(Bool_t on)

 switch on or off the printing of the scope/class name for all message types

void SetPrintScope(AliLog::EType_t type, Bool_t on)

 switch on or off the printing of the scope/class name
 for the given message type

void SetPrintLocation(Bool_t on)

 switch on or off the printing of the file name and line number
 for all message types

void SetPrintLocation(AliLog::EType_t type, Bool_t on)

 switch on or off the printing of the file name and line number
 for the given message type

void SetPrintRepetitions(Bool_t on)

 switch on or off the printing of the number of repetitions of a message
 instead of repeating the same message

void WriteToFile(const char* name, Int_t option = 0)

 write the log object with the given name and option to the current file

UInt_t GetLogLevel(const char* module, const char* className) const

 get the logging level for the given module and class

Int_t GetDebugLevel(const char* module, const char* className)

 get the debug level for the given module and class

void PrintMessage(UInt_t type, const char* message, const char* module, const char* className, const char* function, const char* file, Int_t line)

 print the given message

void PrintRepetitions()

 print number of repetitions

void Message(UInt_t level, const char* message, const char* module, const char* className, const char* function, const char* file, Int_t line)

 print a log message

void Debug(UInt_t level, const char* message, const char* module, const char* className, const char* function, const char* file, Int_t line)

 print a debug message

Int_t RedirectStdoutTo(AliLog::EType_t type, UInt_t level, const char* module, const char* className, const char* function, const char* file, Int_t line, Bool_t print)

 redirect the standard output to the stream of the given type

Int_t RedirectStderrTo(AliLog::EType_t type, UInt_t level, const char* module, const char* className, const char* function, const char* file, Int_t line, Bool_t print)

 redirect the standard error output to the stream of the given type

Int_t RedirectTo(FILE* stream, AliLog::EType_t type, UInt_t level, const char* module, const char* className, const char* function, const char* file, Int_t line, Bool_t print)

 redirect the standard (error) output stream to the stream of the given type

void RestoreStdout(Int_t original)

 restore the standard output

void RestoreStderr(Int_t original)

 restore the standard error output

ostream& Stream(AliLog::EType_t type, UInt_t level, const char* module, const char* className, const char* function, const char* file, Int_t line)

 get the stream object for the given output type

ostream& GetStream(AliLog::EType_t type, UInt_t level, const char* module, const char* className, const char* function, const char* file, Int_t line)

 get the stream object for the given output type

void SetStreamOutput(ostream* stream)

 set an external stream as target for log messages of all types
 the external stream is completely handled by the caller, the
 AliLog class just writes to it

void SetStreamOutput(AliLog::EType_t type, ostream* stream)

 set an external stream as target for log messages of the given type
 the external stream is completely handled by the caller, the
 AliLog class just writes to it

void SetLogNotification(AliLog::AliLogNotification pCallBack)

 set a notification callback function for log messages of all types

void SetLogNotification(AliLog::EType_t type, AliLog::AliLogNotification pCallBack)

 set a notifications call back function for log messages of all types
 the callback fuction is invoced whenever an output was written
 Note: does not work for c++ streamer classes, the external stream
 has to handle this diectly (e.g. custom implementation of endl)

void PrintString(Int_t type, FILE* stream, const char* format, ...)

 this is the general method to print a log message using variadac args
 to the FILE* like (C - like) streams, e.g. stdout, stderr, or files
 opened by fopen.
 Only in case of an external c++ ostream type output, the message is
 written to that stream and the notifictaion callback is called.
 The message is printed by a normal vfprintf function otherwise

void MakeCoreDump(const char* fout)

 Functionality to make a program snapshot
   gcore - Generate a core file for a running process
   gcore dmake a current snapshot, program can continue further
   We assum that gcore is installed
   for details see:  man gcore

 Example use - make default core file for current process:  AliLog::MakeCoreDump(0)


 Automatic core dump creation in case of the AliFatal can be specified using
 static void  EnableCoreDump(Bool_t enabled);
 Core dump is created in addition to the stack trace ()
 marian.ivanov@cern.ch

void TestException(Int_t level = 10)

 Dummy function to throw exception

Bool_t IsDebugEnabled()

 the following public methods are used by the preprocessor macros
 and should not be called directly

{return fgDebugEnabled;}