-
Notifications
You must be signed in to change notification settings - Fork 1
Expand file tree
/
Copy pathBrookLogger.TBrookLoggerOutput.html
More file actions
184 lines (183 loc) · 9.86 KB
/
BrookLogger.TBrookLoggerOutput.html
File metadata and controls
184 lines (183 loc) · 9.86 KB
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
<!DOCTYPE html>
<html lang="en">
<head>
<title>Brook Tardigrade: BrookLogger: Class TBrookLoggerOutput</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta name="generator" content="PasDoc 0.16.0">
<meta http-equiv="content-type" content="text/html; charset=utf-8">
<link rel="stylesheet" type="text/css" href="tipuesearch/tipuesearch.css">
<link rel="StyleSheet" type="text/css" href="pasdoc.css">
</head>
<body>
<div class="container"><div class="navigation">
<h2><a href="index.html">Brook Tardigrade</a></h2><ul><li><a href="AllUnits.html">Units</a></li><li><a href="ClassHierarchy.html">Class Hierarchy</a></li><li><a href="AllClasses.html">Classes, Interfaces, Objects and Records</a></li><li><a href="AllTypes.html">Types</a></li><li><a href="AllVariables.html">Variables</a></li><li><a href="AllConstants.html">Constants</a></li><li><a href="AllFunctions.html">Functions and Procedures</a></li><li><a href="AllIdentifiers.html">Identifiers</a></li><li><form class="search-form" action="tipue_results.html"><div class="search-input"><input type="text" name="q" id="tipue_search_input" pattern=".{3,}" title="At least 3 characters" required><div class="search-button"><input type="button" id="tipue_search_button" onclick="this.form.submit();"></div></div></form>
<div style="clear: both"></div>
</li></ul></div><div class="content">
<span id="TBrookLoggerOutput"></span><h1 class="cio">Class TBrookLoggerOutput</h1>
<div class="sections">
<div class="one_section"><a class="section" href="#PasDoc-Description">Description</a></div><div class="one_section"><a class="section" href="#PasDoc-Hierarchy">Hierarchy</a></div><div class="one_section">Fields</div><div class="one_section"><a class="section" href="#PasDoc-Methods">Methods</a></div><div class="one_section"><a class="section" href="#PasDoc-Properties">Properties</a></div></div>
<span id="PasDoc-Description"></span><h2 class="unit">Unit</h2>
<p class="unitlink">
<a href="BrookLogger.html">BrookLogger</a></p>
<h2 class="declaration">Declaration</h2>
<p class="declaration">
<code>type TBrookLoggerOutput = class abstract(TPersistent)</code></p>
<h2 class="description">Description</h2>
<p>
Abstract class for logger output.</p>
<span id="PasDoc-Hierarchy"></span><h2 class="hierarchy">Hierarchy</h2>
<ul class="hierarchy"><li class="ancestor">TObject</li>
<li class="ancestor">TPersistent</li>
<li class="thisitem">TBrookLoggerOutput</li></ul><h2 class="overview">Overview</h2>
<span id="PasDoc-Methods"></span><h3 class="summary">Methods</h3>
<table class="summary wide_list">
<tr class="list">
<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><code>constructor <strong><a href="BrookLogger.TBrookLoggerOutput.html#Create">Create</a></strong>(AFilters, AOptions: TStringList); virtual;</code></td>
</tr>
<tr class="list2">
<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><code>class function <strong><a href="BrookLogger.TBrookLoggerOutput.html#GetRegisterAlias">GetRegisterAlias</a></strong>: string; virtual;</code></td>
</tr>
<tr class="list">
<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><code>class function <strong><a href="BrookLogger.TBrookLoggerOutput.html#GetName">GetName</a></strong>: string; virtual; abstract;</code></td>
</tr>
<tr class="list2">
<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><code>function <strong><a href="BrookLogger.TBrookLoggerOutput.html#IsFiltered">IsFiltered</a></strong>(const ALevel: string): Boolean; virtual;</code></td>
</tr>
<tr class="list">
<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><code>procedure <strong><a href="BrookLogger.TBrookLoggerOutput.html#Log">Log</a></strong>(const ALevel, AMessage: string); virtual; abstract;</code></td>
</tr>
<tr class="list2">
<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><code>procedure <strong><a href="BrookLogger.TBrookLoggerOutput.html#Fail">Fail</a></strong>(const ALevel: string; AException: Exception); virtual; abstract;</code></td>
</tr>
</table>
<span id="PasDoc-Properties"></span><h3 class="summary">Properties</h3>
<table class="summary wide_list">
<tr class="list">
<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><code>property <strong><a href="BrookLogger.TBrookLoggerOutput.html#Filters">Filters</a></strong>: TStringList read FFilters;</code></td>
</tr>
<tr class="list2">
<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><code>property <strong><a href="BrookLogger.TBrookLoggerOutput.html#Options">Options</a></strong>: TStringList read FOptions;</code></td>
</tr>
</table>
<h2 class="description">Description</h2>
<h3 class="detail">Methods</h3>
<table class="detail wide_list">
<tr class="list">
<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><span id="Create"></span><code>constructor <strong>Create</strong>(AFilters, AOptions: TStringList); virtual;</code></td>
</tr>
<tr><td colspan="2">
<p>
Creates an instance of <code><a class="normal" href="BrookLogger.TBrookLoggerOutput.html">TBrookLoggerOutput</a></code>. </p>
<h6 class="description_section">Parameters</h6>
<dl class="parameters">
<dt>AFilters[in]</dt>
<dd><a class="normal" href="BrookLogger.TBrookLoggerOutput.html#Filters">Filters</a> to be assigned to the logger instance.</dd>
<dt>AOptions[in]</dt>
<dd><a class="normal" href="BrookLogger.TBrookLoggerOutput.html#Options">Options</a> to be assigned to the logger instance.</dd>
</dl>
</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><span id="GetRegisterAlias"></span><code>class function <strong>GetRegisterAlias</strong>: string; virtual;</code></td>
</tr>
<tr><td colspan="2">
<p>
Returns the alias name for output source. </p>
<h6 class="description_section">Returns</h6>
<p class="return">Output source alias.</p></td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><span id="GetName"></span><code>class function <strong>GetName</strong>: string; virtual; abstract;</code></td>
</tr>
<tr><td colspan="2">
<p>
Returns the name for output source. </p>
<h6 class="description_section">Returns</h6>
<p class="return">Output source name.</p></td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><span id="IsFiltered"></span><code>function <strong>IsFiltered</strong>(const ALevel: string): Boolean; virtual;</code></td>
</tr>
<tr><td colspan="2">
<p>
Returns <code>True</code> if a certain <a class="normal" href="BrookLogger.TBrookLoggerOutput.html#Log">log</a> level is filtered. </p>
<h6 class="description_section">Parameters</h6>
<dl class="parameters">
<dt>ALevel[in]</dt>
<dd><a class="normal" href="BrookLogger.TBrookLoggerOutput.html#Log">Log</a> level.</dd>
</dl>
</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><span id="Log"></span><code>procedure <strong>Log</strong>(const ALevel, AMessage: string); virtual; abstract;</code></td>
</tr>
<tr><td colspan="2">
<p>
Appends a message to the output <code>log</code>. </p>
<h6 class="description_section">Parameters</h6>
<dl class="parameters">
<dt>ALevel[in]</dt>
<dd><code>Log</code> level.</dd>
<dt>AMessage[in]</dt>
<dd><code>Log</code> message.</dd>
</dl>
</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><span id="Fail"></span><code>procedure <strong>Fail</strong>(const ALevel: string; AException: Exception); virtual; abstract;</code></td>
</tr>
<tr><td colspan="2">
<p>
Appends an exception message to the output <a class="normal" href="BrookLogger.TBrookLoggerOutput.html#Log">log</a>. </p>
<h6 class="description_section">Parameters</h6>
<dl class="parameters">
<dt>ALevel[in]</dt>
<dd><a class="normal" href="BrookLogger.TBrookLoggerOutput.html#Log">Log</a> level.</dd>
<dt>AException[in]</dt>
<dd><a class="normal" href="BrookLogger.TBrookLoggerOutput.html#Log">Log</a> exception.</dd>
</dl>
</td></tr>
</table>
<h3 class="detail">Properties</h3>
<table class="detail wide_list">
<tr class="list">
<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><span id="Filters"></span><code>property <strong>Filters</strong>: TStringList read FFilters;</code></td>
</tr>
<tr><td colspan="2">
<p>
List containing the filtered <a class="normal" href="BrookLogger.TBrookLoggerOutput.html#Log">log</a> levels.</p>
</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><span id="Options"></span><code>property <strong>Options</strong>: TStringList read FOptions;</code></td>
</tr>
<tr><td colspan="2">
<p>
List containing additional <code>options</code> to the output.</p>
</td></tr>
</table>
<hr><span class="appinfo"><em>Generated by <a href="https://pasdoc.github.io/">PasDoc 0.16.0</a>. </em>
</span>
</div></div></body></html>