Photospp::Log Class Reference

#include <Log.h>

Classes
struct	Pointer

Static Public Member Functions
static void	Summary ()
static void	SummaryAtExit ()
static void	AddDecay (int type)
static ostream &	Debug (unsigned short int code=0, bool count=true)
static ostream &	Info (bool count=true)
static ostream &	Warning (bool count=true)
static ostream &	Error (bool count=true)
static void	LogInfo (bool flag=true)
static void	LogWarning (bool flag=true)
static void	LogError (bool flag=true)
static void	LogAll (bool flag=true)
static void	LogPhlupa (int from, int to)
static void	LogDebug (unsigned short s=0, unsigned short e=65535)
static void	Assert (bool check, char *text=NULL)
static void	Fatal (string text, unsigned short int code=0)
static void	Fatal (unsigned short int code=0)
static void	RedirectOutput (void(*func)(), ostream &where=*out)
static void	RedirectOutput (ostream &where=*out)
static void	RevertOutput ()
static void	IgnoreFailedAssert (bool flag=true)
static void	IgnoreRedirection (bool flag=true)
static void	IgnoreFatal (unsigned short s=0, unsigned short e=65535)
static void	SetOutput (ostream *newOut)
static void	SetOutput (ostream &newOut)
static void	SetWarningLimit (int x)
static void	Summary ()
static void	SummaryAtExit ()
static void	AddDecay (int type)
static ostream &	Debug (unsigned short int code=0, bool count=true)
static ostream &	Info (bool count=true)
static ostream &	Warning (bool count=true)
static ostream &	Error (bool count=true)
static void	LogInfo (bool flag=true)
static void	LogWarning (bool flag=true)
static void	LogError (bool flag=true)
static void	LogAll (bool flag=true)
static void	LogPhlupa (int from, int to)
static void	LogDebug (unsigned short s=0, unsigned short e=65535)
static void	Assert (bool check, char *text=NULL)
static void	Fatal (string text, unsigned short int code=0)
static void	Fatal (unsigned short int code=0)
static void	RedirectOutput (void(*func)(), ostream &where=*out)
static void	RedirectOutput (ostream &where=*out)
static void	RevertOutput ()
static void	IgnoreFailedAssert (bool flag=true)
static void	IgnoreRedirection (bool flag=true)
static void	IgnoreFatal (unsigned short s=0, unsigned short e=65535)
static void	SetOutput (ostream *newOut)
static void	SetOutput (ostream &newOut)
static void	SetWarningLimit (int x)

Static Protected Attributes
static streambuf *	bCout =cout.rdbuf()
static streambuf *	bCerr =cerr.rdbuf()
static ostream *	out =&cout
static stringstream	buf
static int	warnLimit =100
static int	decays [4] = {0}
static int	dCount =0
static int	dRangeS =65535
static int	dRangeE =65534
static int	faCount =0
static int	faRangeS =65535
static int	faRangeE =65534
static int	iCount =0
static int	wCount =0
static int	eCount =0
static int	asCount =0
static int	asFailedCount =0
static bool	iAction =1
static bool	wAction =1
static bool	eAction =1
static bool	asAction =1
static bool	rAction =1
static list< Pointer * > *	PointerList = NULL

Detailed Description

Definition at line 33 of file Log.h.

Member Function Documentation

void Photospp::Log::AddDecay ( int  type )

static

Adds the decay to the counter. The type is: 0 - gun, 1 - no mothers & grandmothers, 2 - no mothers, 3 - ok.

Definition at line 25 of file Log.cxx.

References decays.

{
        decays[type]++;
}

static void Photospp::Log::AddDecay ( int  type )

static

Adds the decay to the counter. The type is: 0 - gun, 1 - no mothers & grandmothers, 2 - no mothers, 3 - ok.

static void Photospp::Log::Assert ( bool  check, char *  text = NULL  )

static

Asserts logical value. If the assertion fails, the default message or 'text' will be printed and the program will terminate. Program termination can be suppressed by Log::IgnoreFailedAsserts();

void Photospp::Log::Assert ( bool  check, char *  text = NULL  )

static

Asserts logical value. If the assertion fails, the default message or 'text' will be printed and the program will terminate. Program termination can be suppressed by Log::IgnoreFailedAsserts();

Definition at line 72 of file Log.cxx.

References asAction, asCount, asFailedCount, exit(), and out.

{
        ++asCount;
        if(check) return;
        ++asFailedCount;
        if(text==NULL)  *out<<"ASSERT from PHOTOS:"<<endl<<"Assertion failed. "<<endl;
        else *out<<"ASSERT from PHOTOS:"<<endl<<"Assertion failed: "<<text<<endl;
        if(asAction) exit(-1);
}

ostream & Photospp::Log::Debug ( unsigned short int  code = 0, bool  count = true  )

static

Four logging entries. Usage: Log::Info()<<"Logging some info: "<<8<<" > "<<7.9<<endl; Use Log::Info(false) if You don't want the message to be counted.

Definition at line 30 of file Log.cxx.

References buf, dCount, dRangeE, dRangeS, and out.

Referenced by Photospp::PhotosBranch::createBranches(), Photospp::PhotosEvent::filterParticles(), Photospp::PhotosRandom::initialize(), Photospp::PhotosBranch::PhotosBranch(), and Photospp::PhotosBranch::process().

{
        if(count) ++dCount;
        if(code>=dRangeS && code<=dRangeE ) return *out<<"DEBUG("<<code<<") from PHOTOS:"<<endl;
        return buf.seekp(0);
}

static ostream& Photospp::Log::Debug ( unsigned short int  code = 0, bool  count = true  )

static

Four logging entries. Usage: Log::Info()<<"Logging some info: "<<8<<" > "<<7.9<<endl; Use Log::Info(false) if You don't want the message to be counted.

static ostream& Photospp::Log::Error ( bool  count = true )

static

ostream & Photospp::Log::Error ( bool  count = true )

static

Definition at line 64 of file Log.cxx.

References buf, eAction, eCount, and out.

Referenced by Photospp::PhotosHepMCParticle::createSelfDecayVertex().

{
        if(count) ++eCount;
        if(eAction) return *out<<"ERROR from PHOTOS:"<<endl;
        buf.seekp(0);
        return buf;
}

static void Photospp::Log::Fatal ( string  text, unsigned short int  code = 0  )

static

Terminates the program with added default message or 'text'. It can be suppressed by Log::IgnoreFatal();

static void Photospp::Log::Fatal ( string  text, unsigned short int  code = 0  )

static

Terminates the program with added default message or 'text'. It can be suppressed by Log::IgnoreFatal();

Referenced by Photospp::PhotosHEPEVTParticle::addDaughter(), Photospp::PhotosHepMCParticle::addDaughter(), Photospp::PhotosRandom::randomReal(), Photospp::PhotosHEPEVTParticle::setDaughters(), Photospp::PhotosHepMCParticle::setDaughters(), Photospp::PhotosHEPEVTParticle::setMothers(), Photospp::PhotosHepMCParticle::setMothers(), and Photospp::PhotosRandom::setSeed().

static void Photospp::Log::Fatal ( unsigned short int  code = 0 )

inlinestatic

Definition at line 77 of file Log.h.

References Fatal().

Referenced by Fatal().

{ Fatal(NULL,code);       }

static void Photospp::Log::Fatal ( unsigned short int  code = 0 )

inlinestatic

Definition at line 77 of file 3.52/src/utilities/Log.h.

References Fatal().

Referenced by Fatal().

{ Fatal(NULL,code);       }

static void Photospp::Log::IgnoreFailedAssert ( bool  flag = true )

inlinestatic

Do not exit when Log::Assert() check is false. The number of failed asserts will be listed in the summary.

Definition at line 94 of file Log.h.

References asAction.

{ asAction=!flag;        }

static void Photospp::Log::IgnoreFailedAssert ( bool  flag = true )

inlinestatic

Do not exit when Log::Assert() check is false. The number of failed asserts will be listed in the summary.

Definition at line 94 of file 3.52/src/utilities/Log.h.

References asAction.

{ asAction=!flag;        }

static void Photospp::Log::IgnoreFatal ( unsigned short  s = 0, unsigned short  e = 65535  )

inlinestatic

Do not exit when Log::Fatal() with the code within the provided range is called. The number of ignored fatal errors will be listed in the summary.

Definition at line 102 of file Log.h.

References faRangeE, faRangeS, and s.

{ faRangeS=s; faRangeE=e; }

static void Photospp::Log::IgnoreFatal ( unsigned short  s = 0, unsigned short  e = 65535  )

inlinestatic

Do not exit when Log::Fatal() with the code within the provided range is called. The number of ignored fatal errors will be listed in the summary.

Definition at line 102 of file 3.52/src/utilities/Log.h.

References faRangeE, faRangeS, and s.

{ faRangeS=s; faRangeE=e; }

static void Photospp::Log::IgnoreRedirection ( bool  flag = true )

inlinestatic

Ignores redirections of functions' output. The function will still be called in a normal way.

Definition at line 98 of file 3.52/src/utilities/Log.h.

References rAction.

{ rAction=!flag;         }

static void Photospp::Log::IgnoreRedirection ( bool  flag = true )

inlinestatic

Ignores redirections of functions' output. The function will still be called in a normal way.

Definition at line 98 of file Log.h.

References rAction.

{ rAction=!flag;         }

ostream & Photospp::Log::Info ( bool  count = true )

static

Definition at line 38 of file Log.cxx.

References buf, iAction, iCount, and out.

Referenced by Photospp::PhotosDebugRandom::print(), Photospp::PhotosHEPEVTEvent::print(), and Photospp::Photos::setStopAtCriticalError().

{
        if(count) ++iCount;
        if(iAction) return *out<<"INFO from PHOTOS:"<<endl;
        return buf.seekp(0);
}

static ostream& Photospp::Log::Info ( bool  count = true )

static

static void Photospp::Log::LogAll ( bool  flag = true )

inlinestatic

Definition at line 60 of file 3.52/src/utilities/Log.h.

References dRangeE, dRangeS, eAction, iAction, and wAction.

{ iAction=wAction=eAction=flag; dRangeS=0; dRangeE=65535; }

static void Photospp::Log::LogAll ( bool  flag = true )

inlinestatic

Definition at line 60 of file Log.h.

References dRangeE, dRangeS, eAction, iAction, and wAction.

{ iAction=wAction=eAction=flag; dRangeS=0; dRangeE=65535; }

static void Photospp::Log::LogDebug ( unsigned short  s = 0, unsigned short  e = 65535  )

inlinestatic

Sets the range of debug codes that will be printed. By default, the debug messages are turned off.

Definition at line 67 of file 3.52/src/utilities/Log.h.

References dRangeE, dRangeS, and s.

{ dRangeS=s; dRangeE=e;   }

static void Photospp::Log::LogDebug ( unsigned short  s = 0, unsigned short  e = 65535  )

inlinestatic

Sets the range of debug codes that will be printed. By default, the debug messages are turned off.

Definition at line 67 of file Log.h.

References dRangeE, dRangeS, and s.

{ dRangeS=s; dRangeE=e;   }

static void Photospp::Log::LogError ( bool  flag = true )

inlinestatic

Definition at line 58 of file 3.52/src/utilities/Log.h.

References eAction.

{ eAction=flag;         }

static void Photospp::Log::LogError ( bool  flag = true )

inlinestatic

Definition at line 58 of file Log.h.

References eAction.

{ eAction=flag;         }

static void Photospp::Log::LogInfo ( bool  flag = true )

inlinestatic

Turns off or on particular types of messages By default, only debugging messages are turned off.

Definition at line 56 of file Log.h.

References iAction.

{ iAction=flag;         }

static void Photospp::Log::LogInfo ( bool  flag = true )

inlinestatic

Turns off or on particular types of messages By default, only debugging messages are turned off.

Definition at line 56 of file 3.52/src/utilities/Log.h.

References iAction.

{ iAction=flag;         }

static void Photospp::Log::LogPhlupa ( int  from, int  to  )

inlinestatic

Definition at line 63 of file 3.52/src/utilities/Log.h.

References phlupy_.

{ phlupy_.ipoinm=from; phlupy_.ipoin=to; }

static void Photospp::Log::LogPhlupa ( int  from, int  to  )

inlinestatic

Definition at line 63 of file Log.h.

References phlupy_.

{ phlupy_.ipoinm=from; phlupy_.ipoin=to; }

static void Photospp::Log::LogWarning ( bool  flag = true )

inlinestatic

Definition at line 57 of file 3.52/src/utilities/Log.h.

References wAction.

{ wAction=flag;         }

static void Photospp::Log::LogWarning ( bool  flag = true )

inlinestatic

Definition at line 57 of file Log.h.

References wAction.

{ wAction=flag;         }

void Photospp::Log::RedirectOutput ( void(*)()  func, ostream &  where = *out  )

static

Redirects output to log. Redirection can be done for a block of code or for one function only. Redirection can be turned off by using Log::IgnoreRedirection(); If the target is one of the log streams (for example): Log::RedirectOutput( someFunction, Log::Info() ); You can turn the function's messages off by turning the apropriate log entries off. The redirected code will still be executed, only messages are redirected.

Definition at line 90 of file Log.cxx.

References bCerr, bCout, func, and rAction.

Referenced by Photospp::PhotosHEPEVTParticle::checkMomentumConservation(), Photospp::PhotosHepMCParticle::checkMomentumConservation(), and Photospp::PhotosDebugRandom::print().

{

        if(!rAction) { func(); return; }
        cout.rdbuf(where.rdbuf());
        cerr.rdbuf(where.rdbuf());
        where<<endl;
        func();
        cout.rdbuf(bCout);
        cerr.rdbuf(bCerr);
}

static void Photospp::Log::RedirectOutput ( void(*)()  func, ostream &  where = *out  )

static

Redirects output to log. Redirection can be done for a block of code or for one function only. Redirection can be turned off by using Log::IgnoreRedirection(); If the target is one of the log streams (for example): Log::RedirectOutput( someFunction, Log::Info() ); You can turn the function's messages off by turning the apropriate log entries off. The redirected code will still be executed, only messages are redirected.

void Photospp::Log::RedirectOutput ( ostream &  where = *out )

static

Definition at line 102 of file Log.cxx.

References rAction.

{
        if(!rAction) return;
        cout.rdbuf(where.rdbuf());
        cerr.rdbuf(where.rdbuf());
        where<<endl;
}

static void Photospp::Log::RedirectOutput ( ostream &  where = *out )

static

static void Photospp::Log::RevertOutput ( )

inlinestatic

WARNING! If You're redirecting more than one function, do not forget to use RevertOutput() afterwards.

Definition at line 90 of file Log.h.

References bCerr, and bCout.

Referenced by Photospp::PhotosHEPEVTParticle::checkMomentumConservation(), Photospp::PhotosHepMCParticle::checkMomentumConservation(), and Photospp::PhotosDebugRandom::print().

{ std::cout.rdbuf(bCout); std::cerr.rdbuf(bCerr); }

static void Photospp::Log::RevertOutput ( )

inlinestatic

WARNING! If You're redirecting more than one function, do not forget to use RevertOutput() afterwards.

Definition at line 90 of file 3.52/src/utilities/Log.h.

References bCerr, and bCout.

{ std::cout.rdbuf(bCout); std::cerr.rdbuf(bCerr); }

static void Photospp::Log::SetOutput ( ostream *  newOut )

inlinestatic

Change the output of the logged messages. Log::SetOutput(cerr); //changes the output to cerr Log::SetOutput(new ofstream("log.txt")); //changes the output to a file "log.txt"

Definition at line 107 of file Log.h.

References out.

{ out=newOut;           }

static void Photospp::Log::SetOutput ( ostream *  newOut )

inlinestatic

Change the output of the logged messages. Log::SetOutput(cerr); //changes the output to cerr Log::SetOutput(new ofstream("log.txt")); //changes the output to a file "log.txt"

Definition at line 107 of file 3.52/src/utilities/Log.h.

References out.

{ out=newOut;           }

static void Photospp::Log::SetOutput ( ostream &  newOut )

inlinestatic

Definition at line 108 of file 3.52/src/utilities/Log.h.

References out.

{ out=&newOut;          }

static void Photospp::Log::SetOutput ( ostream &  newOut )

inlinestatic

Definition at line 108 of file Log.h.

References out.

{ out=&newOut;          }

static void Photospp::Log::SetWarningLimit ( int  x )

inlinestatic

Change the limit of warnings that will be displayed. Set to 0 for no limit.

Definition at line 111 of file Log.h.

References warnLimit, and x.

{ warnLimit=x;          }

static void Photospp::Log::SetWarningLimit ( int  x )

inlinestatic

Change the limit of warnings that will be displayed. Set to 0 for no limit.

Definition at line 111 of file 3.52/src/utilities/Log.h.

References warnLimit, and x.

{ warnLimit=x;          }

static void Photospp::Log::Summary ( )

static

Shows the summary of all messages.

void Photospp::Log::Summary ( )

static

Shows the summary of all messages.

Definition at line 110 of file Log.cxx.

References asAction, asCount, asFailedCount, dCount, decays, dRangeE, dRangeS, eAction, eCount, faCount, faRangeE, faRangeS, iAction, iCount, out, wAction, warnLimit, and wCount.

Referenced by SummaryAtExit().

{
        *out<<"---------------------------- Photos Log Summary ------------------------------"<<endl;
        *out<<" Debug:   \t";
        if(dRangeS>dRangeE) *out<<"(OFF)";
        *out<<"\t\t"<<dCount<<"\t";
        if(dRangeS<=dRangeE) *out<<"Debug range: "<<dRangeS<<" - "<<dRangeE;
        *out<<endl;
        *out<<" Info:    \t";
        if(!iAction) *out<<"(OFF)";
        *out<<"\t\t"<<iCount<<"\t"<<endl;
        *out<<" Warnings:\t";
        if(!wAction) {if(warnLimit>0 && wCount>warnLimit) *out<<"(SUPP.)"; else *out<<"(OFF)";}
        *out<<"\t\t"<<wCount<<"\t"<<endl;
        *out<<" Errors:  \t";
        if(!eAction) *out<<"(OFF)";
        *out<<"\t\t"<<eCount<<"\t"<<endl;
        if(asCount || !asAction || faRangeS<faRangeE) cout<<"-----------------------------------"<<endl;
        if(asCount>0) *out<<" Asserts:\t\t\t"<<asCount<<endl;
        if(!asAction) *out<<" Failed asserts ignored:\t"<<asFailedCount<<endl;
        if(faRangeS<=faRangeE) *out<<" Fatal errors ignored:  \t"<<faCount<<endl;
        cout<<"-----------------------------------"<<endl;
        if(decays[3]) cout<<" Normal decays:                        "<<decays[3]<<endl;
        if(decays[2]) cout<<" Decays without mother:                "<<decays[2]<<endl;
        if(decays[1]) cout<<" Decays without mother & grandmothers: "<<decays[1]<<endl;
        if(decays[0]) cout<<" Decayed using Tauola gun:             "<<decays[0]<<endl;
        *out<<"------------------------------------------------------------------------------"<<endl;
}

static void Photospp::Log::SummaryAtExit ( )

inlinestatic

Shows the summary at the end of the program.

Definition at line 40 of file 3.52/src/utilities/Log.h.

References Summary().

{ atexit(Summary);      }

static void Photospp::Log::SummaryAtExit ( )

inlinestatic

Shows the summary at the end of the program.

Definition at line 40 of file Log.h.

{ atexit(Summary);      }

static ostream& Photospp::Log::Warning ( bool  count = true )

static

ostream & Photospp::Log::Warning ( bool  count = true )

static

Definition at line 46 of file Log.cxx.

References buf, out, wAction, warnLimit, and wCount.

Referenced by Photospp::PhotosHEPEVTParticle::checkMomentumConservation(), Photospp::PhotosHepMCParticle::checkMomentumConservation(), Photospp::Photos::createHistoryEntries(), Photospp::PhotosHEPEVTParticle::createHistoryEntry(), Photospp::PhotosHepMCParticle::createHistoryEntry(), Photospp::PhotosHEPEVTParticle::createSelfDecayVertex(), Photospp::Photos::forceMass(), Photospp::PhotosHEPEVTParticle::getDaughters(), Photospp::Photos::ignoreParticlesOfStatus(), and Photospp::PhotosBranch::PhotosBranch().

{
        if(count) ++wCount;
        if(warnLimit>0 && wCount>=warnLimit)
        {
                if(wAction)
                {
                        *out<<"WARNING from PHOTOS:"<<endl<<"Limit reached ("<<warnLimit<<"). Warnings suppressed."<<endl;
                        wAction=false;
                }
                return buf.seekp(0);
        }
        if(wAction && count) return *out<<"WARNING from PHOTOS:"<<endl;
        if(wAction)          return *out;
        return buf.seekp(0);
}

Member Data Documentation

static bool Photospp::Log::asAction =1

staticprotected

Definition at line 121 of file Log.h.

Referenced by Assert(), IgnoreFailedAssert(), and Summary().

static int Photospp::Log::asCount =0

staticprotected

Definition at line 120 of file Log.h.

Referenced by Assert(), and Summary().

static int Photospp::Log::asFailedCount =0

staticprotected

Definition at line 120 of file Log.h.

Referenced by Assert(), and Summary().

static streambuf * Photospp::Log::bCerr =cerr.rdbuf()

staticprotected

Definition at line 114 of file Log.h.

Referenced by RedirectOutput(), and RevertOutput().

static streambuf * Photospp::Log::bCout =cout.rdbuf()

staticprotected

Definition at line 114 of file Log.h.

Referenced by RedirectOutput(), and RevertOutput().

static stringstream Photospp::Log::buf

staticprotected

Definition at line 116 of file Log.h.

Referenced by Debug(), Error(), Info(), and Warning().

static int Photospp::Log::dCount =0

staticprotected

Definition at line 119 of file Log.h.

Referenced by Debug(), and Summary().

static int Photospp::Log::decays = {0}

staticprotected

Definition at line 118 of file Log.h.

Referenced by AddDecay(), and Summary().

static int Photospp::Log::dRangeE =65534

staticprotected

Definition at line 119 of file Log.h.

Referenced by Debug(), LogAll(), LogDebug(), and Summary().

static int Photospp::Log::dRangeS =65535

staticprotected

Definition at line 119 of file Log.h.

Referenced by Debug(), LogAll(), LogDebug(), and Summary().

static bool Photospp::Log::eAction =1

staticprotected

Definition at line 121 of file Log.h.

Referenced by Error(), LogAll(), LogError(), and Summary().

static int Photospp::Log::eCount =0

staticprotected

Definition at line 120 of file Log.h.

Referenced by Error(), and Summary().

static int Photospp::Log::faCount =0

staticprotected

Definition at line 119 of file Log.h.

Referenced by Summary().

static int Photospp::Log::faRangeE =65534

staticprotected

Definition at line 119 of file Log.h.

Referenced by IgnoreFatal(), and Summary().

static int Photospp::Log::faRangeS =65535

staticprotected

Definition at line 119 of file Log.h.

Referenced by IgnoreFatal(), and Summary().

static bool Photospp::Log::iAction =1

staticprotected

Definition at line 121 of file Log.h.

Referenced by Info(), LogAll(), LogInfo(), and Summary().

static int Photospp::Log::iCount =0

staticprotected

Definition at line 120 of file Log.h.

Referenced by Info(), and Summary().

static ostream * Photospp::Log::out =&cout

staticprotected

Definition at line 115 of file Log.h.

Referenced by Assert(), Debug(), Error(), Info(), SetOutput(), Summary(), and Warning().

static list< Pointer * > * Photospp::Log::PointerList = NULL

staticprotected

Definition at line 134 of file Log.h.

static bool Photospp::Log::rAction =1

staticprotected

Definition at line 121 of file Log.h.

Referenced by IgnoreRedirection(), and RedirectOutput().

static bool Photospp::Log::wAction =1

staticprotected

Definition at line 121 of file Log.h.

Referenced by LogAll(), LogWarning(), Summary(), and Warning().

static int Photospp::Log::warnLimit =100

staticprotected

Definition at line 117 of file Log.h.

Referenced by SetWarningLimit(), Summary(), and Warning().

static int Photospp::Log::wCount =0

staticprotected

Definition at line 120 of file Log.h.

Referenced by Summary(), and Warning().

---

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

• Log.h
• 3.52/src/utilities/Log.h
• Log.cxx