ILogSystem. More...

Detailed Description

ILogSystem.

Interface to log your application

Public Member Functions
unsigned char	GetState (void)
	Get log system state. More...

void	Halt ()
	Halt the log output.

void	Init (char filename, char mode, char level, char prgname, char author=NULL, char email=NULL, char *web=NULL)
	Init LogSystem. More...

void	Msg (char level, char *,...)
	Output a log message. More...

void	ProfileBegin (char *name)
	Mark the begin of profile block. More...

void	ProfileEnd (char *name)
	Mark the end of profile block. More...

void	ProfileShow (void)
	Print to log system the samples results table.

void	Resume ()
	Resume a previous halted log system.

void	ShowTime (char)
	Print automatically the time when occurred the event each time you call to Msg(). More...

Member Function Documentation

unsigned char CRM32Pro_ILogSystem::GetState ( void )

Get log system state.

Returns: 0 log system is not activated; 1 log system is activated; 2 log system is halted(active but it needs a Resume())

Init LogSystem.

Parameters

filename	name of log file
mode	LOG_NULL,LOG_CONSOLE,LOG_FILE,LOG_FILEAPPEND,LOG_DRTS. You can use logic OR to combine them.
level	LOG_LOW,LOG_NORMAL,LOG_HIGH
prgname	name of your program
author	author name (none by default)
email	email of author (none by default)
web	web page of your project (none by default)

Examples:: Example01_BasicCode.cpp, Example03_GUI.cpp, Example05_VideoPlayer.cpp, Example08_SpriteCollision.cpp, Example09_LogicRenderRates.cpp, Example10_NetChat.cpp, Example11_NetChat2.cpp, Example12_DRTS.cpp, and SpacePong.cpp.

Output a log message.

Parameters

level	set level requiered to log the message
format	format parameter as printf function

Examples:: Example01_BasicCode.cpp, Example03_GUI.cpp, Example05_VideoPlayer.cpp, Example08_SpriteCollision.cpp, Example09_LogicRenderRates.cpp, Example10_NetChat.cpp, Example11_NetChat2.cpp, Example12_DRTS.cpp, and SpacePong.cpp.

void CRM32Pro_ILogSystem::ProfileBegin ( char * name )

Mark the begin of profile block.

You must use the same name to mark the begin-end of desired block
These blocks can be nested.

Parameters

name	name of your block.

void CRM32Pro_ILogSystem::ProfileEnd ( char * name )

Mark the end of profile block.

You must use the same name to mark the begin-end of desired block
These blocks can be nested.

Parameters

name	name of your block.

void CRM32Pro_ILogSystem::ShowTime ( char m )

Print automatically the time when occurred the event each time you call to Msg().

By default it is disabled.
It only works with LOG_FILE or LOG_FILEAPPEND. It does not display any information to console system.

Parameters

m	0 to disable it or any other value to enable it.

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