BS_NMSP::Log Class Reference

Simple logging class. More...

#include <bsLog.h>

List of all members.

Public Member Functions

 Log ()
 Constructor.
void addEntry (const String &str)
 Add an entry to the log.
void clear ()
 Clears the log.
const String & getFirstEntry () const
 Returns the first message in the log.
const String & getNextEntry () const
 Returns the next message in the log.

Static Public Attributes

static const String END
 This value is used to signify the end of a series of log messages.


Detailed Description

Simple logging class.

This class holds errors, warnings and general messages from bulletscript. When an error is signalled by bulletscript, it is generally a good idea to check the log to see if there is any information about it.


Member Function Documentation

void BS_NMSP::Log::addEntry ( const String &  str  ) 

Add an entry to the log.

Parameters:
str message as a string.

const String& BS_NMSP::Log::getFirstEntry (  )  const

Returns the first message in the log.

Returns:
the message, or Log::END if the log is empty.

const String& BS_NMSP::Log::getNextEntry (  )  const

Returns the next message in the log.

getFirstEntry() must be called before this, else the result will be undefined.

Returns:
the message, or Log::END if there are no more messages left.


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

Generated on Wed Mar 31 12:49:05 2010 for bulletscript by  doxygen 1.5.9