Main Page | Class Hierarchy | Class List | Directories | File List | Class Members | File Members
krmuo::LoggingUnit

krmuo::LoggingUnit Class Reference

class for managing logging messages More...

#include <muo_logging.h>

List of all members.

Public Member Functions

 LoggingUnit (const unsigned int pMaxVisibleMessageLevel, FILE *pScreen)
 constructor for LoggingUnits without fileentries
 LoggingUnit (const unsigned int pMaxVisibleMessageLevel, const string &pLogFileName, const bool pUsesSharedLoggingFile)
 constructor for LoggingUnits without screenentries
 LoggingUnit (const unsigned int pMaxVisibleMessageLevel, FILE *pScreen, const string &pLogFileName, const bool pUsesSharedLoggingFile)
 constructor for LoggingUnits with screen- and fileentries
 ~LoggingUnit ()
 class-destructor
void turnOffScreenWriting ()
 set mScreen to Null
void makeEntry (const string &pLogString, const unsigned int pLogEntryLevel) const
 write one-string-message into the LoggingUnit
void makeEntry (const string &pLogString1, const string &pLogString2, const unsigned int pLogEntryLevel) const
 write two2one-string-message into the LoggingUnit
void makeEntry (const string &pLogString1, const string &pLogString2, const string &pLogString3, const unsigned int pLogEntryLevel) const
 write three2one-string-message into the LoggingUnit
void makeEntry (const string &pLogString1, const string &pLogString2, const unsigned int pLogEntryLevel, bool pTwoLine) const
 write two2oneOrTwo-string-message into the LoggingUnit
void makeEntry (const string &pLogString1, const string &pLogString2, const string &pLogString3, const unsigned int pLogEntryLevel, bool pTwoLine) const
 write three2oneOrTwo-string-message into the LoggingUnit
void makeEntry (const string &pLogString, const unsigned int pLogUInt, const unsigned int pLogEntryLevel) const
 write string-uint-2-one-string-message into the LoggingUnit
void makeEntry (const string &pLogString, const int pLogInt, const unsigned int pLogEntryLevel) const
 write string-int-2-one-string-message into the LoggingUnit

Detailed Description

class for managing logging messages

instances of the class LoggingSuitcase have the task to write logging messages into a file and/or onto the screen

Definition at line 75 of file muo_logging.h.

Constructor & Destructor Documentation

LoggingUnit::LoggingUnit (  const unsigned int  pMaxVisibleMessageLevel,
FILE *  pScreen
) 
 

constructor for LoggingUnits without fileentries

Constructor for LoggingUnits beeing able to write messages onto the screen

Parameters:
pMaxVisibleMessageLevel :- {SHOW_NM(=0),SHOW_SM(=1),SHOW_SMADM(=2),SHOW_SMADMAHM(=3)}
pScreen :- { stdout, stderr }

Definition at line 51 of file muo_logging.cc.

LoggingUnit::LoggingUnit (  const unsigned int  pMaxVisibleMessageLevel,
const string &  pLogFileName,
const bool  pUsesSharedLoggingFile
) 
 

constructor for LoggingUnits without screenentries

Logging Unit beeing able to write messages into a logfile

Parameters:
pMaxVisibleMessageLevel :- {SHOW_NM(=0),SHOW_SM(=1),SHOW_SMADM(=2),SHOW_SMADMAHM(=3)}
pLogFileName = name of the logfile
pUsesSharedLoggingFile :- { USE_SHARED_LOGFILE, USE_OWN_LOGFILE }

Definition at line 70 of file muo_logging.cc.

LoggingUnit::LoggingUnit (  const unsigned int  pMaxVisibleMessageLevel,
FILE *  pScreen,
const string &  pLogFileName,
const bool  pUsesSharedLoggingFile
) 
 

constructor for LoggingUnits with screen- and fileentries

LoggingUnit beeing able to write messages onto the screen and into a logfile

Parameters:
pMaxVisibleMessageLevel :- {SHOW_NM(=0),SHOW_SM(=1),SHOW_SMADM(=2),SHOW_SMADMAHM(=3)}
pScreen :- { stdout, stderr }
pLogFileName = name of the logfile
pUsesSharedLoggingFile :- { USE_SHARED_LOGFILE, USE_OWN_LOGFILE }

Definition at line 100 of file muo_logging.cc.

LoggingUnit::~LoggingUnit (   ) 
 

class-destructor

class-destructor which closes the logginfiles if nescessary

Definition at line 126 of file muo_logging.cc.

Member Function Documentation

void LoggingUnit::makeEntry (  const string &  pLogString,
const int  pLogInt,
const unsigned int  pLogEntryLevel
)  const
 

write string-int-2-one-string-message into the LoggingUnit

write string-int-message as one-string-message into the LoggingUnit (= into file and/or onto screen)

Parameters:
pLogString :- string part of the message
pLogInt :- signed value for the message
pLogEntryLevel :- { SMESS,DMESS, HMESS }

Definition at line 414 of file muo_logging.cc.

void LoggingUnit::makeEntry (  const string &  pLogString,
const unsigned int  pLogUint,
const unsigned int  pLogEntryLevel
)  const
 

write string-uint-2-one-string-message into the LoggingUnit

write string-uint-message as one-string-message into the LoggingUnit (= into file and/or onto screen)

Parameters:
pLogString :- string part of the message
pLogUint :- unsigned value of the message
pLogEntryLevel :- { SMESS,DMESS, HMESS }

Definition at line 374 of file muo_logging.cc.

void LoggingUnit::makeEntry (  const string &  pLogString1,
const string &  pLogString2,
const string &  pLogString3,
const unsigned int  pLogEntryLevel,
bool  pTwoLine
)  const
 

write three2oneOrTwo-string-message into the LoggingUnit

write string-string-message as one- or two-string message into the LoggingUnit (= into file and/or onto screen)

Parameters:
pLogString1 :- first part of the message
pLogString2 :- second-a part of the message
pLogString3 :- second-b part of the message
pLogEntryLevel :- { SMESS,DMESS, HMESS }
pTwoLine :- { USE_TWOLINES, USE_ONELINE }

Definition at line 318 of file muo_logging.cc.

void LoggingUnit::makeEntry (  const string &  pLogString1,
const string &  pLogString2,
const unsigned int  pLogEntryLevel,
bool  pTwoLine
)  const
 

write two2oneOrTwo-string-message into the LoggingUnit

write string-string-message as one- or two-string message into the LoggingUnit (= into file and/or onto screen)

Parameters:
pLogString1 :- first part of the message
pLogString2 :- second part of the message
pLogEntryLevel :- { SMESS,DMESS, HMESS }
pTwoLine :- { USE_TWOLINES, USE_ONELINE }

Definition at line 269 of file muo_logging.cc.

void LoggingUnit::makeEntry (  const string &  pLogString1,
const string &  pLogString2,
const string &  pLogString3,
const unsigned int  pLogEntryLevel
)  const
 

write three2one-string-message into the LoggingUnit

write string-string-message as one-string-message into the LoggingUnit (= into file and/or onto screen)

Parameters:
pLogString1 :- first part of the message
pLogString2 :- second-a part of the message
pLogString3 :- second-b part of the message
pLogEntryLevel :- { SMESS,DMESS, HMESS }

Definition at line 223 of file muo_logging.cc.

void LoggingUnit::makeEntry (  const string &  pLogString1,
const string &  pLogString2,
const unsigned int  pLogEntryLevel
)  const
 

write two2one-string-message into the LoggingUnit

write string-string-message as one-string-message into the LoggingUnit (= into file and/or onto screen)

Parameters:
pLogString1 :- first part of the message
pLogString2 :- second part of the message
pLogEntryLevel :- { SMESS,DMESS, HMESS }

Definition at line 182 of file muo_logging.cc.

void LoggingUnit::makeEntry (  const string &  pLogString,
const unsigned int  pLogEntryLevel
)  const
 

write one-string-message into the LoggingUnit

write one-string-message into the LoggingUnit (= into file and/or onto screen)

Parameters:
pLogString :- the message
pLogEntryLevel :- { SMESS,DMESS, HMESS }

Definition at line 144 of file muo_logging.cc.

Referenced by mrprj::Calendar::Calendar(), mrprj::Day::Day(), mrprj::DayType::DayType(), mrprj::Interval::Interval(), krmuo::LoggingSuitcase::makeActionLogEntry(), krmuo::LoggingSuitcase::makeErrorLogEntry(), krmuo::LoggingSuitcase::makeWarnLogEntry(), mrprj::OverriddenDayType::OverriddenDayType(), mrprj::Phase::Phase(), mrprj::Task::Task(), mrprj::Calendar::~Calendar(), mrprj::Day::~Day(), mrprj::DayType::~DayType(), mrprj::Interval::~Interval(), mrprj::OverriddenDayType::~OverriddenDayType(), mrprj::Phase::~Phase(), mrprj::Property::~Property(), and mrprj::Task::~Task().

void krmuo::LoggingUnit::turnOffScreenWriting (   )  [inline]
 

set mScreen to Null

for sending no longer screenmessages

Definition at line 146 of file muo_logging.h.

Referenced by krmuo::LoggingSuitcase::turnOffScreenWriting().

The documentation for this class was generated from the following files:
Generated on Sat Mar 4 11:55:16 2006 for MRPROJEXT by  doxygen 1.4.1