File: classlog4cpp_1_1LayoutAppender.html

package info (click to toggle)
log4cpp-doc 1.0-4
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 8,528 kB
  • sloc: makefile: 10
file content (200 lines) | stat: -rw-r--r-- 14,577 bytes parent folder | download | duplicates (5)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
<title>log4cpp: log4cpp::LayoutAppender Class Reference</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
<link href="tabs.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.5.2 -->
<div class="tabs">
  <ul>
    <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
    <li><a href="namespaces.html"><span>Namespaces</span></a></li>
    <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
    <li><a href="files.html"><span>Files</span></a></li>
    <li><a href="pages.html"><span>Related&nbsp;Pages</span></a></li>
  </ul>
</div>
<div class="tabs">
  <ul>
    <li><a href="annotated.html"><span>Class&nbsp;List</span></a></li>
    <li><a href="hierarchy.html"><span>Class&nbsp;Hierarchy</span></a></li>
    <li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
  </ul>
</div>
<div class="nav">
<a class="el" href="namespacelog4cpp.html">log4cpp</a>::<a class="el" href="classlog4cpp_1_1LayoutAppender.html">LayoutAppender</a></div>
<h1>log4cpp::LayoutAppender Class Reference</h1><!-- doxytag: class="log4cpp::LayoutAppender" --><!-- doxytag: inherits="log4cpp::AppenderSkeleton" --><a class="el" href="classlog4cpp_1_1LayoutAppender.html" title="LayoutAppender is a common superclass for all Appenders that require a Layout.">LayoutAppender</a> is a common superclass for all Appenders that require a <a class="el" href="classlog4cpp_1_1Layout.html" title="Extend this abstract class to create your own log layout format.">Layout</a>.  
<a href="#_details">More...</a>
<p>
<code>#include &lt;<a class="el" href="LayoutAppender_8hh-source.html">LayoutAppender.hh</a>&gt;</code>
<p>
Inheritance diagram for log4cpp::LayoutAppender:<p><center><img src="classlog4cpp_1_1LayoutAppender__inherit__graph.gif" border="0" usemap="#log4cpp_1_1LayoutAppender__inherit__map" alt="Inheritance graph"></center>
<map name="log4cpp_1_1LayoutAppender__inherit__map">
<area shape="rect" href="classlog4cpp_1_1BufferingAppender.html" title="log4cpp::BufferingAppender" alt="" coords="5,229,181,256"><area shape="rect" href="classlog4cpp_1_1FileAppender.html" title="log4cpp::FileAppender" alt="" coords="205,229,349,256"><area shape="rect" href="classlog4cpp_1_1OstreamAppender.html" title="OstreamAppender appends LoggingEvents to ostreams." alt="" coords="373,229,541,256"><area shape="rect" href="classlog4cpp_1_1RemoteSyslogAppender.html" title="RemoteSyslogAppender sends LoggingEvents to a remote syslog system." alt="" coords="565,229,768,256"><area shape="rect" href="classlog4cpp_1_1StringQueueAppender.html" title="This class puts log messages in an in&#45;memory queue." alt="" coords="792,229,984,256"><area shape="rect" href="classlog4cpp_1_1SyslogAppender.html" title="SyslogAppender sends LoggingEvents to the local syslog system." alt="" coords="1008,229,1168,256"><area shape="rect" href="classlog4cpp_1_1Win32DebugAppender.html" title="Win32DebugAppender simply sends the log message to the default system debugger on..." alt="" coords="1192,229,1387,256"><area shape="rect" href="classlog4cpp_1_1AppenderSkeleton.html" title="AppenderSkeleton is a helper class, simplifying implementation of Appenders: it already..." alt="" coords="581,80,752,107"><area shape="rect" href="classlog4cpp_1_1Appender.html" title="Implement this interface for your own strategies for printing log statements." alt="" coords="605,5,728,32"><area shape="rect" href="classlog4cpp_1_1RollingFileAppender.html" title="RollingFileAppender is a FileAppender that rolls over the logfile once it has reached..." alt="" coords="185,304,369,331"></map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center>Collaboration diagram for log4cpp::LayoutAppender:<p><center><img src="classlog4cpp_1_1LayoutAppender__coll__graph.gif" border="0" usemap="#log4cpp_1_1LayoutAppender__coll__map" alt="Collaboration graph"></center>
<map name="log4cpp_1_1LayoutAppender__coll__map">
<area shape="rect" href="classlog4cpp_1_1AppenderSkeleton.html" title="AppenderSkeleton is a helper class, simplifying implementation of Appenders: it already..." alt="" coords="45,187,216,213"><area shape="rect" href="classlog4cpp_1_1Appender.html" title="Implement this interface for your own strategies for printing log statements." alt="" coords="25,96,148,123"><area shape="rect" href="classlog4cpp_1_1threading_1_1Mutex.html" title="log4cpp::threading::Mutex" alt="" coords="5,5,168,32"><area shape="rect" title="_appenderMapMutex" alt="" coords="83,28,91,36"><area shape="rect" title="_appenderMapMutex" alt="" coords="83,92,91,100"><area shape="rect" href="classlog4cpp_1_1Filter.html" title="Users should extend this class to implement customized logging event filtering." alt="" coords="172,96,271,123"><area shape="rect" title="_filter" alt="" coords="204,119,212,127"><area shape="rect" title="_filter" alt="" coords="140,183,148,191"><area shape="rect" title="_chainedFilter" alt="" coords="241,92,249,100"><area shape="rect" title="_chainedFilter" alt="" coords="241,119,249,127"><area shape="rect" href="classlog4cpp_1_1Layout.html" title="Extend this abstract class to create your own log layout format." alt="" coords="240,187,349,213"><area shape="rect" title="_layout" alt="" coords="284,209,292,217"><area shape="rect" title="_layout" alt="" coords="256,273,264,281"></map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center><a href="classlog4cpp_1_1LayoutAppender-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Public Types</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">typedef <a class="el" href="classlog4cpp_1_1BasicLayout.html">BasicLayout</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cpp_1_1LayoutAppender.html#188b3a9a2dd9f718f250f95efaa43724">DefaultLayoutType</a></td></tr>

<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cpp_1_1LayoutAppender.html#31d50b4e476c70bd99e3c9dbd07e6a79">LayoutAppender</a> (const std::string &amp;name)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cpp_1_1LayoutAppender.html#da501d953eb1e980840866880ba0afb9">~LayoutAppender</a> ()</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cpp_1_1LayoutAppender.html#0c14651f4d6a734619034701904783c0">requiresLayout</a> () const</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Check if the appender requires a layout.  <a href="#0c14651f4d6a734619034701904783c0"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cpp_1_1LayoutAppender.html#a12073260a58276f9f43a75cb7b93b68">setLayout</a> (<a class="el" href="classlog4cpp_1_1Layout.html">Layout</a> *layout=NULL)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set the <a class="el" href="classlog4cpp_1_1Layout.html" title="Extend this abstract class to create your own log layout format.">Layout</a> for this appender.  <a href="#a12073260a58276f9f43a75cb7b93b68"></a><br></td></tr>
<tr><td colspan="2"><br><h2>Protected Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classlog4cpp_1_1Layout.html">Layout</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cpp_1_1LayoutAppender.html#2215bc27417d200bd510f2f5d91fa0ff">_getLayout</a> ()</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Return the layout of the appender.  <a href="#2215bc27417d200bd510f2f5d91fa0ff"></a><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
<a class="el" href="classlog4cpp_1_1LayoutAppender.html" title="LayoutAppender is a common superclass for all Appenders that require a Layout.">LayoutAppender</a> is a common superclass for all Appenders that require a <a class="el" href="classlog4cpp_1_1Layout.html" title="Extend this abstract class to create your own log layout format.">Layout</a>. 
<p>
<hr><h2>Member Typedef Documentation</h2>
<a class="anchor" name="188b3a9a2dd9f718f250f95efaa43724"></a><!-- doxytag: member="log4cpp::LayoutAppender::DefaultLayoutType" ref="188b3a9a2dd9f718f250f95efaa43724" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">typedef <a class="el" href="classlog4cpp_1_1BasicLayout.html">BasicLayout</a> <a class="el" href="classlog4cpp_1_1BasicLayout.html">log4cpp::LayoutAppender::DefaultLayoutType</a>          </td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>

</div>
</div><p>
<hr><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" name="31d50b4e476c70bd99e3c9dbd07e6a79"></a><!-- doxytag: member="log4cpp::LayoutAppender::LayoutAppender" ref="31d50b4e476c70bd99e3c9dbd07e6a79" args="(const std::string &amp;name)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">log4cpp::LayoutAppender::LayoutAppender           </td>
          <td>(</td>
          <td class="paramtype">const std::string &amp;&nbsp;</td>
          <td class="paramname"> <em>name</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>

</div>
</div><p>
<a class="anchor" name="da501d953eb1e980840866880ba0afb9"></a><!-- doxytag: member="log4cpp::LayoutAppender::~LayoutAppender" ref="da501d953eb1e980840866880ba0afb9" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">log4cpp::LayoutAppender::~LayoutAppender           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"><code> [virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>

</div>
</div><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="0c14651f4d6a734619034701904783c0"></a><!-- doxytag: member="log4cpp::LayoutAppender::requiresLayout" ref="0c14651f4d6a734619034701904783c0" args="() const" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bool log4cpp::LayoutAppender::requiresLayout           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"> const<code> [virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Check if the appender requires a layout. 
<p>
All LayoutAppenders do, therefore this method returns true for all subclasses.<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>true. </dd></dl>

<p>
Implements <a class="el" href="classlog4cpp_1_1AppenderSkeleton.html#2c56b0118614086644df4cd37408ca02">log4cpp::AppenderSkeleton</a>.
</div>
</div><p>
<a class="anchor" name="a12073260a58276f9f43a75cb7b93b68"></a><!-- doxytag: member="log4cpp::LayoutAppender::setLayout" ref="a12073260a58276f9f43a75cb7b93b68" args="(Layout *layout=NULL)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void log4cpp::LayoutAppender::setLayout           </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="classlog4cpp_1_1Layout.html">Layout</a> *&nbsp;</td>
          <td class="paramname"> <em>layout</em> = <code>NULL</code>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"><code> [virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Set the <a class="el" href="classlog4cpp_1_1Layout.html" title="Extend this abstract class to create your own log layout format.">Layout</a> for this appender. 
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>layout</em>&nbsp;</td><td>The layout to use. </td></tr>
  </table>
</dl>

<p>
Implements <a class="el" href="classlog4cpp_1_1AppenderSkeleton.html#5d1136572a006239935c4264beb07065">log4cpp::AppenderSkeleton</a>.
</div>
</div><p>
<a class="anchor" name="2215bc27417d200bd510f2f5d91fa0ff"></a><!-- doxytag: member="log4cpp::LayoutAppender::_getLayout" ref="2215bc27417d200bd510f2f5d91fa0ff" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classlog4cpp_1_1Layout.html">Layout</a> &amp; log4cpp::LayoutAppender::_getLayout           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"><code> [protected]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Return the layout of the appender. 
<p>
This method is the <a class="el" href="classlog4cpp_1_1Layout.html" title="Extend this abstract class to create your own log layout format.">Layout</a> accessor for subclasses of <a class="el" href="classlog4cpp_1_1LayoutAppender.html" title="LayoutAppender is a common superclass for all Appenders that require a Layout.">LayoutAppender</a>. <dl class="return" compact><dt><b>Returns:</b></dt><dd>the <a class="el" href="classlog4cpp_1_1Layout.html" title="Extend this abstract class to create your own log layout format.">Layout</a>. </dd></dl>

</div>
</div><p>
<hr>The documentation for this class was generated from the following files:<ul>
<li><a class="el" href="LayoutAppender_8hh-source.html">LayoutAppender.hh</a><li><a class="el" href="LayoutAppender_8cpp.html">LayoutAppender.cpp</a></ul>
<hr size="1"><address style="text-align: right;"><small>Generated on Mon Sep 3 11:55:05 2007 for log4cpp by&nbsp;
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.2 </small></address>
</body>
</html>