Cortex  10.0.0-a4
Public Types | Public Member Functions | List of all members
IECoreHoudini::MessageHandler Class Reference

#include <MessageHandler.h>

+ Inheritance diagram for IECoreHoudini::MessageHandler:

Public Types

typedef boost::function< void(const char *m)> HandlerFn
 
- Public Types inherited from IECore::MessageHandler
enum  Level {
  Error = 0, Warning = 1, Info = 2, Debug = 3,
  Invalid = 4
}
 
- Public Types inherited from IECore::RefCounted
typedef size_t RefCount
 

Public Member Functions

 IE_CORE_DECLAREMEMBERPTR (MessageHandler)
 
 MessageHandler (HandlerFn errorFn=0, HandlerFn warningFn=0, HandlerFn infoFn=0, HandlerFn debugFn=0)
 
virtual void handle (Level level, const std::string &context, const std::string &message)
 
- Public Member Functions inherited from IECore::MessageHandler
 IE_CORE_DECLAREMEMBERPTR (MessageHandler)
 
- Public Member Functions inherited from IECore::RefCounted
 IE_CORE_DECLAREMEMBERPTR (RefCounted)
 
void addRef () const
 Add a reference to the current object.
 
void removeRef () const
 Remove a reference from the current object.
 
RefCount refCount () const
 Returns the current reference count.
 

Additional Inherited Members

- Static Public Member Functions inherited from IECore::MessageHandler
static MessageHandlercurrentHandler ()
 
static void output (Level level, const std::string &context, const std::string &message)
 Output a message to the current handler.
 
static void output (Level level, const std::string &context, const boost::format &message)
 Output a message to the current handler.
 
static void setDefaultHandler (const MessageHandlerPtr &handler)
 
static MessageHandlergetDefaultHandler ()
 
static std::string levelAsString (Level level)
 Returns a readable string representation of the specified message level.
 
static Level stringAsLevel (const std::string &level)
 Returns a message level based on the specified string (case is ignored).
 

Detailed Description

A generic MessageHandler for Houdini.

Todo:
: make this threadsafe

Member Function Documentation

virtual void IECoreHoudini::MessageHandler::handle ( Level  level,
const std::string &  context,
const std::string &  message 
)
virtual

Must be implemented by subclasses to output the message appropriately. Client code should use MessageHandler::output() rather than call this directly.

Implements IECore::MessageHandler.


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