Cortex  10.0.0-a4
Public Member Functions | Public Attributes | List of all members
IECore.CapturingMessageHandler Class Reference

The CapturingMessageHandler simply stores all messages passed to it in an attribute called messages. More...

+ Inheritance diagram for IECore.CapturingMessageHandler:

Public Member Functions

def __init__ (self)
 
def handle (self, level, context, message)
 
- Public Member Functions inherited from IECore::MessageHandler
 IE_CORE_DECLAREMEMBERPTR (MessageHandler)
 
virtual void handle (Level level, const std::string &context, const std::string &message)=0
 
- 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.
 

Public Attributes

 messages
 

Additional Inherited Members

- 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
 
- 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

The CapturingMessageHandler simply stores all messages passed to it in an attribute called messages.

It's useful for verifying expected message output during testing. Each message in the messages list is a Struct with "level", "context" and "message" attributes.


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