Main Page   Namespace List   Class Hierarchy   Compound List   File List   Namespace Members   Compound Members   File Members   Related Pages  

log4cpp::PatternLayout Class Reference

PatternLayout is a simple fixed format Layout implementation. More...

#include <PatternLayout.hh>

Inheritance diagram for log4cpp::PatternLayout:

Inheritance graph
[legend]
Collaboration diagram for log4cpp::PatternLayout:

Collaboration graph
[legend]
List of all members.

Public Methods

 PatternLayout ()
virtual ~PatternLayout ()
virtual std::string format (const LoggingEvent &event)
 Formats the LoggingEvent in the style set by the setConversionPattern call. More...

bool setConversionPattern (std::string conversionPattern)
 Sets the format of log lines handled by this PatternLayout. More...


Detailed Description

PatternLayout is a simple fixed format Layout implementation.


Constructor & Destructor Documentation

log4cpp::PatternLayout::PatternLayout  
 

log4cpp::PatternLayout::~PatternLayout   [virtual]
 


Member Function Documentation

std::string log4cpp::PatternLayout::format const LoggingEvent   event [virtual]
 

Formats the LoggingEvent in the style set by the setConversionPattern call.

By default, set to "%m%n"

Implements log4cpp::Layout.

bool log4cpp::PatternLayout::setConversionPattern std::string    conversionPattern
 

Sets the format of log lines handled by this PatternLayout.

By default, set to "%m%n".
Format characters are as follows:

  • %% - a single percent sign
  • %c - the category
  • %d - the date
    Date format: The date format character may be followed by a date format specifier enclosed between braces. For example, %d{%H:%M:%S,%l} or %d{%d %m %Y %H:%M:%S,%l}. If no date format specifier is given then the following format is used: "Wed Jan 02 02:03:55 1980". The date format specifier admits the same syntax as the ANSI C function strftime, with 1 addition. The addition is the specifier %l for milliseconds, padded with zeros to make 3 digits.
  • %D - seconds since 1970
  • %m - the message
  • %n - the platform specific line separator
  • %p - the priority
  • %r - milliseconds since this layout was created.
  • %R - seconds since Jan 1, 1970
  • %u - clock ticks since process start
  • %x - the NDC
    Parameters:
    conversionPattern  the conversion pattern
    Returns:
    true if conversionPattern is a valid conversion pattern, false if it's invalid

  • The documentation for this class was generated from the following files:
    Generated on Thu Aug 15 00:00:50 2002 for log4cpp by doxygen1.2.14 written by Dimitri van Heesch, © 1997-2002