Mitsuba Renderer  0.5.0
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
mitsuba::Appender Class Referenceabstract

This class defines an abstract destination for logging-relevant information. More...

#include <mitsuba/core/appender.h>

+ Inheritance diagram for mitsuba::Appender:

Public Member Functions

virtual void append (ELogLevel level, const std::string &text)=0
 Append a line of text with the given log level. More...
 
virtual void logProgress (Float progress, const std::string &name, const std::string &formatted, const std::string &eta, const void *ptr)=0
 Process a progress message. More...
 
virtual const ClassgetClass () const
 Retrieve this object's class. More...
 
- Public Member Functions inherited from Object
 Object ()
 Construct a new object. More...
 
int getRefCount () const
 Return the current reference count. More...
 
void incRef () const
 Increase the reference count of the object by one. More...
 
void decRef (bool autoDeallocate=true) const
 Decrease the reference count of the object and possibly deallocate it. More...
 
virtual std::string toString () const
 Return a human-readable string representation of the object's contents. More...
 

Static Public Attributes

static Classm_theClass
 
- Static Public Attributes inherited from Object
static Classm_theClass
 Pointer to the object's class descriptor. More...
 

Protected Member Functions

virtual ~Appender ()
 Virtual destructor. More...
 
- Protected Member Functions inherited from Object
virtual ~Object ()
 Virtual private deconstructor. (Will only be called by ref) More...
 

Additional Inherited Members

- Static Public Member Functions inherited from Object
static void staticInitialization ()
 Initializes the built-in reference count debugger (if enabled) More...
 
static void staticShutdown ()
 Free the memory taken by staticInitialization() More...
 

Detailed Description

This class defines an abstract destination for logging-relevant information.

Constructor & Destructor Documentation

virtual mitsuba::Appender::~Appender ( )
inlineprotectedvirtual

Virtual destructor.

Member Function Documentation

virtual void mitsuba::Appender::append ( ELogLevel  level,
const std::string &  text 
)
pure virtual

Append a line of text with the given log level.

Implemented in mitsuba::UnbufferedAppender, and mitsuba::StreamAppender.

virtual const Class* mitsuba::Appender::getClass ( ) const
virtual

Retrieve this object's class.

Reimplemented from Object.

Reimplemented in mitsuba::UnbufferedAppender, and mitsuba::StreamAppender.

virtual void mitsuba::Appender::logProgress ( Float  progress,
const std::string &  name,
const std::string &  formatted,
const std::string &  eta,
const void *  ptr 
)
pure virtual

Process a progress message.

Parameters
progressPercentage value in [0,100]
nameTitle of the progress message
formattedFormatted string representation of the message
etaEstimated time until 100% is reached.
ptrCustom pointer payload. This is used to express the context of a progress message. When rendering a scene, it will usually contain a pointer to the associated RenderJob.
Remarks
The ptr argument is missing in the Python bindings

Implemented in mitsuba::UnbufferedAppender, and mitsuba::StreamAppender.

Member Data Documentation

Class* mitsuba::Appender::m_theClass
static

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