Classes | Public Member Functions | Static Public Attributes | Private Types | Private Attributes | List of all members
PatternLayout Class Reference

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

#include <PatternLayout.hh>

Inheritance diagram for PatternLayout:
Inheritance graph
[legend]

Classes

class  PatternComponent
 

Public Member Functions

virtual void clearConversionPattern ()
 
virtual std::string format (const LoggingEvent &event)
 Formats the LoggingEvent in the style set by the setConversionPattern call. More...
 
virtual std::string getConversionPattern () const
 
 PatternLayout ()
 
virtual void setConversionPattern (const std::string &conversionPattern)
 Sets the format of log lines handled by this PatternLayout. More...
 
virtual void setConversionPattern (const char *conversionPattern)
 
virtual ~PatternLayout ()
 
- Public Member Functions inherited from Layout
virtual ~Layout ()
 Destructor for Layout. More...
 

Static Public Attributes

static const char * BASIC_CONVERSION_PATTERN
 A conversion pattern equivalent to the BasicLayout. More...
 
static const char * DEFAULT_CONVERSION_PATTERN
 The default conversion pattern. More...
 
static const char * SIMPLE_CONVERSION_PATTERN
 A conversion pattern equivalent to the SimpleLayout. More...
 
static const char * TTCC_CONVERSION_PATTERN
 A conversion pattern equivalent to the TTCCLayout. More...
 

Private Types

typedef std::vector< PatternComponent * > ComponentVector
 

Private Attributes

ComponentVector _components
 
std::string _conversionPattern
 

Detailed Description

PatternLayout is a simple fixed format Layout implementation.

Definition at line 26 of file PatternLayout.hh.

Member Typedef Documentation

typedef std::vector<PatternComponent*> PatternLayout::ComponentVector
private

Definition at line 102 of file PatternLayout.hh.

Constructor & Destructor Documentation

PatternLayout::PatternLayout ( )
virtual PatternLayout::~PatternLayout ( )
virtual

Member Function Documentation

virtual void PatternLayout::clearConversionPattern ( )
virtual
virtual std::string PatternLayout::format ( const LoggingEvent event)
virtual

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

By default, set to "%%m%%n"

Implements Layout.

virtual std::string PatternLayout::getConversionPattern ( ) const
virtual
virtual void PatternLayout::setConversionPattern ( const std::string &  conversionPattern)
virtual

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. %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
conversionPatternthe conversion pattern
Exceptions
GenICam::InvalidArgumentExceptionif the pattern is invalid
virtual void PatternLayout::setConversionPattern ( const char *  conversionPattern)
virtual

Member Data Documentation

ComponentVector PatternLayout::_components
private

Definition at line 103 of file PatternLayout.hh.

std::string PatternLayout::_conversionPattern
private

Definition at line 105 of file PatternLayout.hh.

const char* PatternLayout::BASIC_CONVERSION_PATTERN
static

A conversion pattern equivalent to the BasicLayout.

Definition at line 41 of file PatternLayout.hh.

const char* PatternLayout::DEFAULT_CONVERSION_PATTERN
static

The default conversion pattern.

Definition at line 31 of file PatternLayout.hh.

const char* PatternLayout::SIMPLE_CONVERSION_PATTERN
static

A conversion pattern equivalent to the SimpleLayout.

Definition at line 36 of file PatternLayout.hh.

const char* PatternLayout::TTCC_CONVERSION_PATTERN
static

A conversion pattern equivalent to the TTCCLayout.

Note: TTCCLayout is in log4j but not log4cpp.

Definition at line 47 of file PatternLayout.hh.


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


rc_genicam_api
Author(s): Heiko Hirschmueller
autogenerated on Thu Jun 6 2019 19:10:55