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

#include <CompoundMessageHandler.h>

+ Inheritance diagram for IECore::CompoundMessageHandler:

Public Member Functions

 IE_CORE_DECLAREMEMBERPTR (CompoundMessageHandler)
 
 CompoundMessageHandler (const std::set< MessageHandlerPtr > &initialHandlers)
 
void handle (Level level, const std::string &context, const std::string &message) override
 
- 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.
 

Public Attributes

std::set< MessageHandlerPtr > handlers
 

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 CompoundMessageHandler class allows the use of multiple message handlers at once. It forwards all messages to a set containing an arbitrary number of child message handlers.

Member Function Documentation

void IECore::CompoundMessageHandler::handle ( Level  level,
const std::string &  context,
const std::string &  message 
)
overridevirtual

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

Implements IECore::MessageHandler.

Member Data Documentation

std::set<MessageHandlerPtr> IECore::CompoundMessageHandler::handlers

The handlers to which this handler will pass all it's messages. This is a public member so that it can be modified to add and remove handlers.


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