File: classlog4cpp_1_1Priority.html

package info (click to toggle)
log4cpp-doc 0.3.5-rc3-1
  • links: PTS
  • area: main
  • in suites: etch, etch-m68k
  • size: 5,664 kB
  • ctags: 925
  • sloc: makefile: 34
file content (236 lines) | stat: -rw-r--r-- 11,694 bytes parent folder | download
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
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>log4cpp: log4cpp::Priority Class Reference</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.4.2 -->
<div class="qindex"><a class="qindex" href="index.html">Main&nbsp;Page</a> | <a class="qindex" href="namespaces.html">Namespace List</a> | <a class="qindex" href="hierarchy.html">Class&nbsp;Hierarchy</a> | <a class="qindex" href="annotated.html">Class&nbsp;List</a> | <a class="qindex" href="dirs.html">Directories</a> | <a class="qindex" href="files.html">File&nbsp;List</a> | <a class="qindex" href="namespacemembers.html">Namespace&nbsp;Members</a> | <a class="qindex" href="functions.html">Class&nbsp;Members</a> | <a class="qindex" href="globals.html">File&nbsp;Members</a> | <a class="qindex" href="pages.html">Related&nbsp;Pages</a></div>
<div class="nav">
<a class="el" href="namespacelog4cpp.html">log4cpp</a>::<a class="el" href="classlog4cpp_1_1Priority.html">Priority</a></div>
<h1>log4cpp::Priority Class Reference</h1>The <a class="el" href="classlog4cpp_1_1Priority.html">Priority</a> class provides importance levels with which one can categorize log messages.  
<a href="#_details">More...</a>
<p>
<code>#include &lt;<a class="el" href="Priority_8hh-source.html">Priority.hh</a>&gt;</code>
<p>
<a href="classlog4cpp_1_1Priority-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 int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cpp_1_1Priority.html#w0">Value</a></td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The type of <a class="el" href="classlog4cpp_1_1Priority.html">Priority</a> Values.  <a href="#w0"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">enum &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cpp_1_1Priority.html#w11">PriorityLevel</a> { <br>
&nbsp;&nbsp;<a class="el" href="classlog4cpp_1_1Priority.html#w11w1">EMERG</a> =  0, 
<a class="el" href="classlog4cpp_1_1Priority.html#w11w2">FATAL</a> =  0, 
<a class="el" href="classlog4cpp_1_1Priority.html#w11w3">ALERT</a> =  100, 
<a class="el" href="classlog4cpp_1_1Priority.html#w11w4">CRIT</a> =  200, 
<br>
&nbsp;&nbsp;<a class="el" href="classlog4cpp_1_1Priority.html#w11w5">ERROR</a> =  300, 
<a class="el" href="classlog4cpp_1_1Priority.html#w11w6">WARN</a> =  400, 
<a class="el" href="classlog4cpp_1_1Priority.html#w11w7">NOTICE</a> =  500, 
<a class="el" href="classlog4cpp_1_1Priority.html#w11w8">INFO</a> =  600, 
<br>
&nbsp;&nbsp;<a class="el" href="classlog4cpp_1_1Priority.html#w11w9">DEBUG</a> =  700, 
<a class="el" href="classlog4cpp_1_1Priority.html#w11w10">NOTSET</a> =  800
<br>
 }</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Predefined Levels of Priorities.  <a href="classlog4cpp_1_1Priority.html#w11">More...</a><br></td></tr>
<tr><td colspan="2"><br><h2>Static Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">static const std::string &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cpp_1_1Priority.html#e0">getPriorityName</a> (int priority)  throw ()</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns the name of the given priority value.  <a href="#e0"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">static <a class="el" href="classlog4cpp_1_1Priority.html#w0">Value</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cpp_1_1Priority.html#e1">getPriorityValue</a> (const std::string &amp;priorityName)  throw (std::invalid_argument)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns the value of the given priority name.  <a href="#e1"></a><br></td></tr>
<tr><td colspan="2"><br><h2>Static Public Attributes</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">static const int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cpp_1_1Priority.html#s0">MESSAGE_SIZE</a> = 8</td></tr>

</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
The <a class="el" href="classlog4cpp_1_1Priority.html">Priority</a> class provides importance levels with which one can categorize log messages. 
<p>
<hr><h2>Member Typedef Documentation</h2>
<a class="anchor" name="w0" doxytag="log4cpp::Priority::Value"></a><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
  <tr>
    <td class="mdRow">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top">typedef int <a class="el" href="classlog4cpp_1_1Priority.html#w0">log4cpp::Priority::Value</a>          </td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
The type of <a class="el" href="classlog4cpp_1_1Priority.html">Priority</a> Values. 
<p>
    </td>
  </tr>
</table>
<hr><h2>Member Enumeration Documentation</h2>
<a class="anchor" name="w11" doxytag="log4cpp::Priority::PriorityLevel"></a><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
  <tr>
    <td class="mdRow">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top">enum <a class="el" href="classlog4cpp_1_1Priority.html#w11">log4cpp::Priority::PriorityLevel</a>          </td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Predefined Levels of Priorities. 
<p>
These correspond to the priority levels used by syslog(3). <dl compact><dt><b>Enumeration values: </b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"><em><a class="anchor" name="w11w1" doxytag="EMERG"></a>EMERG</em>&nbsp;</td><td>
</td></tr>
<tr><td valign="top"><em><a class="anchor" name="w11w2" doxytag="FATAL"></a>FATAL</em>&nbsp;</td><td>
</td></tr>
<tr><td valign="top"><em><a class="anchor" name="w11w3" doxytag="ALERT"></a>ALERT</em>&nbsp;</td><td>
</td></tr>
<tr><td valign="top"><em><a class="anchor" name="w11w4" doxytag="CRIT"></a>CRIT</em>&nbsp;</td><td>
</td></tr>
<tr><td valign="top"><em><a class="anchor" name="w11w5" doxytag="ERROR"></a>ERROR</em>&nbsp;</td><td>
</td></tr>
<tr><td valign="top"><em><a class="anchor" name="w11w6" doxytag="WARN"></a>WARN</em>&nbsp;</td><td>
</td></tr>
<tr><td valign="top"><em><a class="anchor" name="w11w7" doxytag="NOTICE"></a>NOTICE</em>&nbsp;</td><td>
</td></tr>
<tr><td valign="top"><em><a class="anchor" name="w11w8" doxytag="INFO"></a>INFO</em>&nbsp;</td><td>
</td></tr>
<tr><td valign="top"><em><a class="anchor" name="w11w9" doxytag="DEBUG"></a>DEBUG</em>&nbsp;</td><td>
</td></tr>
<tr><td valign="top"><em><a class="anchor" name="w11w10" doxytag="NOTSET"></a>NOTSET</em>&nbsp;</td><td>
</td></tr>
</table>
</dl>
    </td>
  </tr>
</table>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="e0" doxytag="log4cpp::Priority::getPriorityName"></a><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
  <tr>
    <td class="mdRow">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top">const std::string &amp; log4cpp::Priority::getPriorityName           </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top">int&nbsp;</td>
          <td class="mdname1" valign="top" nowrap> <em>priority</em>          </td>
          <td class="md" valign="top">&nbsp;)&nbsp;</td>
          <td class="md" nowrap>  throw ()<code> [static]</code></td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Returns the name of the given priority value. 
<p>
Currently, if the value is not one of the PriorityLevel values, the method returns the name of the largest priority smaller the given value. <dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>priority</em>&nbsp;</td><td>the numeric value of the priority. </td></tr>
  </table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>a string representing the name of the priority. </dd></dl>
    </td>
  </tr>
</table>
<a class="anchor" name="e1" doxytag="log4cpp::Priority::getPriorityValue"></a><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
  <tr>
    <td class="mdRow">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top"><a class="el" href="classlog4cpp_1_1Priority.html#w0">Priority::Value</a> log4cpp::Priority::getPriorityValue           </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top">const std::string &amp;&nbsp;</td>
          <td class="mdname1" valign="top" nowrap> <em>priorityName</em>          </td>
          <td class="md" valign="top">&nbsp;)&nbsp;</td>
          <td class="md" nowrap>  throw (std::invalid_argument)<code> [static]</code></td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Returns the value of the given priority name. 
<p>
This can be either one of EMERG ... NOTSET or a decimal string representation of the value, e.g. '700' for DEBUG. <dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>priorityName</em>&nbsp;</td><td>the string containing the the of the priority </td></tr>
  </table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>the value corresponding with the priority name </dd></dl>
<dl compact><dt><b>Exceptions:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>std::invalid_argument</em>&nbsp;</td><td>if the priorityName does not correspond with a known <a class="el" href="classlog4cpp_1_1Priority.html">Priority</a> name or a number </td></tr>
  </table>
</dl>
    </td>
  </tr>
</table>
<hr><h2>Member Data Documentation</h2>
<a class="anchor" name="s0" doxytag="log4cpp::Priority::MESSAGE_SIZE"></a><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
  <tr>
    <td class="mdRow">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top">const int <a class="el" href="classlog4cpp_1_1Priority.html#s0">log4cpp::Priority::MESSAGE_SIZE</a> = 8<code> [static]</code>          </td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
    </td>
  </tr>
</table>
<hr>The documentation for this class was generated from the following files:<ul>
<li><a class="el" href="Priority_8hh-source.html">Priority.hh</a><li><a class="el" href="Priority_8cpp.html">Priority.cpp</a></ul>
<hr size="1"><address style="align: right;"><small>Generated on Fri Jul 29 14:12:37 2005 for log4cpp by&nbsp;
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.2 </small></address>
</body>
</html>