-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathclasslogit_1_1ILogFormatter.html
221 lines (210 loc) · 10.4 KB
/
classlogit_1_1ILogFormatter.html
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
<!-- HTML header for doxygen 1.11.0-->
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.12.0"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>LogIt++: logit::ILogFormatter Interface Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<script type="text/javascript" src="clipboard.js"></script>
<script type="text/javascript" src="doxygen-awesome-darkmode-toggle.js"></script>
<script type="text/javascript" src="doxygen-awesome-paragraph-link.js"></script>
<script type="text/javascript">
DoxygenAwesomeDarkModeToggle.init()
DoxygenAwesomeParagraphLink.init()
</script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="cookie.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="doxygen-awesome.css" rel="stylesheet" type="text/css"/>
<link href="doxygen-awesome-sidebar-only.css" rel="stylesheet" type="text/css"/>
<link href="doxygen-awesome-sidebar-only-darkmode-toggle.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr id="projectrow">
<td id="projectlogo"><img alt="Logo" src="logo.png"/></td>
<td id="projectalign">
<div id="projectname">LogIt++
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.12.0 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search/",'.html');
/* @license-end */
</script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
$(function() { codefold.init(0); });
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
$(function() {
initMenu('',true,false,'search.php','Search',true);
$(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
$(function(){initNavTree('classlogit_1_1ILogFormatter.html',''); initResizable(true); });
/* @license-end */
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="classlogit_1_1ILogFormatter-members.html">List of all members</a> </div>
<div class="headertitle"><div class="title">logit::ILogFormatter Interface Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div></div>
</div><!--header-->
<div class="contents">
<p>Interface for formatting log records.
<a href="#details">More...</a></p>
<p><code>#include <<a class="el" href="ILogFormatter_8hpp_source.html">ILogFormatter.hpp</a>></code></p>
<div class="dynheader">
Inheritance diagram for logit::ILogFormatter:</div>
<div class="dyncontent">
<div class="center">
<img src="classlogit_1_1ILogFormatter.png" usemap="#logit::ILogFormatter_map" alt=""/>
<map id="logit::ILogFormatter_map" name="logit::ILogFormatter_map">
<area href="classlogit_1_1SimpleLogFormatter.html" title="A simple log formatter that formats log messages based on a user-defined pattern." alt="logit::SimpleLogFormatter" shape="rect" coords="0,56,153,80"/>
</map>
</div></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-methods" name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a2c3401af20fafec7d37fafa1e8e084f3" id="r_a2c3401af20fafec7d37fafa1e8e084f3"><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="#a2c3401af20fafec7d37fafa1e8e084f3">~ILogFormatter</a> ()=default</td></tr>
<tr class="separator:a2c3401af20fafec7d37fafa1e8e084f3"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ae513f0253954fd91a0cbbec91fe2d333" id="r_ae513f0253954fd91a0cbbec91fe2d333"><td class="memItemLeft" align="right" valign="top">virtual std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="#ae513f0253954fd91a0cbbec91fe2d333">format</a> (const <a class="el" href="structlogit_1_1LogRecord.html">LogRecord</a> &record) const =0</td></tr>
<tr class="memdesc:ae513f0253954fd91a0cbbec91fe2d333"><td class="mdescLeft"> </td><td class="mdescRight">Formats a log record into a string. <br /></td></tr>
<tr class="separator:ae513f0253954fd91a0cbbec91fe2d333"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Interface for formatting log records. </p>
<p>The <code><a class="el" href="classlogit_1_1ILogFormatter.html" title="Interface for formatting log records.">ILogFormatter</a></code> class defines an interface that any log formatter must implement. It provides a pure virtual function for formatting a log record into a string. </p>
<p class="definition">Definition at line <a class="el" href="ILogFormatter_8hpp_source.html#l00016">16</a> of file <a class="el" href="ILogFormatter_8hpp_source.html">ILogFormatter.hpp</a>.</p>
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
<a id="a2c3401af20fafec7d37fafa1e8e084f3" name="a2c3401af20fafec7d37fafa1e8e084f3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2c3401af20fafec7d37fafa1e8e084f3">◆ </a></span>~ILogFormatter()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual logit::ILogFormatter::~ILogFormatter </td>
<td>(</td>
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span><span class="mlabel">default</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="ae513f0253954fd91a0cbbec91fe2d333" name="ae513f0253954fd91a0cbbec91fe2d333"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae513f0253954fd91a0cbbec91fe2d333">◆ </a></span>format()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual std::string logit::ILogFormatter::format </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="structlogit_1_1LogRecord.html">LogRecord</a> &</td> <td class="paramname"><span class="paramname"><em>record</em></span></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Formats a log record into a string. </p>
<p>This pure virtual function must be implemented by any class deriving from <code><a class="el" href="classlogit_1_1ILogFormatter.html" title="Interface for formatting log records.">ILogFormatter</a></code>. The implementation should format the log record into a human-readable or machine-readable string.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">record</td><td>The log record to be formatted. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>A string representing the formatted log message. </dd></dl>
<p>Implemented in <a class="el" href="classlogit_1_1SimpleLogFormatter.html#ad92e97e6274ff28d0620cb8f643f841c">logit::SimpleLogFormatter</a>.</p>
</div>
</div>
<hr/>The documentation for this interface was generated from the following file:<ul>
<li>include/log-it/parts/Formatter/<a class="el" href="ILogFormatter_8hpp_source.html">ILogFormatter.hpp</a></li>
</ul>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="namespacelogit.html">logit</a></li><li class="navelem"><a class="el" href="classlogit_1_1ILogFormatter.html">ILogFormatter</a></li>
<li class="footer">Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.12.0 </li>
</ul>
</div>
</body>
</html>