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

#include <LevelFilteredMessageHandler.h>

+ Inheritance diagram for IECore::LevelFilteredMessageHandler:

Public Member Functions

 IE_CORE_DECLAREMEMBERPTR (LevelFilteredMessageHandler)
 
 LevelFilteredMessageHandler (MessageHandlerPtr handler, MessageHandler::Level level)
 
void handle (Level level, const std::string &context, const std::string &message) override
 
MessageHandler::Level getLevel () const
 
void setLevel (MessageHandler::Level level)
 
- Public Member Functions inherited from IECore::FilteredMessageHandler
 IE_CORE_DECLAREMEMBERPTR (FilteredMessageHandler)
 
 FilteredMessageHandler (MessageHandlerPtr handler)
 
- 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.
 

Static Public Member Functions

static MessageHandler::Level defaultLevel ()
 
- 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).
 

Protected Attributes

MessageHandler::Level m_level
 
- Protected Attributes inherited from IECore::FilteredMessageHandler
MessageHandlerPtr m_handler
 

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
 

Detailed Description

This class implements a FilteredMessageHandler that only passes messages which have a Level below a certain threshold.

Constructor & Destructor Documentation

IECore::LevelFilteredMessageHandler::LevelFilteredMessageHandler ( MessageHandlerPtr  handler,
MessageHandler::Level  level 
)

Creates a message handler that filter messages based on the message level, and outputs to another message handler.

Member Function Documentation

static MessageHandler::Level IECore::LevelFilteredMessageHandler::defaultLevel ( )
static

Returns a message level based on the value of the IECORE_LOG_LEVEL environment variable, defaulting to Warning level if it isn't set.

void IECore::LevelFilteredMessageHandler::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.


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