Logo
Reference manual - version ored_version
Public Member Functions | Static Public Attributes | List of all members
BufferLogger Class Reference

BufferLogger. More...

#include <ored/utilities/log.hpp>

+ Inheritance diagram for BufferLogger:

Public Member Functions

 BufferLogger (unsigned minLevel=64)
 Constructor.
 
virtual ~BufferLogger ()
 Destructor.
 
virtual void log (unsigned, const std::string &) override
 The log callback.
 
bool hasNext ()
 Checks if Logger has new messages. More...
 
std::string next ()
 Retrieve new messages. More...
 
- Public Member Functions inherited from Logger
virtual ~Logger ()
 Destructor.
 
const std::string & name ()
 Returns the Logger name.
 

Static Public Attributes

static const std::string name
 the name "BufferLogger"
 

Additional Inherited Members

- Protected Member Functions inherited from Logger
 Logger (const std::string &name)
 Constructor. More...
 

Detailed Description

BufferLogger.

This logger stores each log message in an internal buffer, it can then be probed for log messages at a later point. Log messages are always returned in a FIFO order.

Typical usage to display log messages would be

    while (bLogger.hasNext()) {
        MsgBox("Log Message", bLogger.next());
    }
See also
Log

Member Function Documentation

◆ hasNext()

bool hasNext ( )

Checks if Logger has new messages.

Returns
True if this BufferLogger has any new log messages

◆ next()

std::string next ( )

Retrieve new messages.

Retrieve the next new message from the buffer, this will throw if the buffer is empty. Messages are returned in a FIFO order. Messages are deleted from the buffer once returned.

Returns
The next message