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
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
|
<?xml version='1.0' encoding='utf-8'?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html><head>
<meta http-equiv="Content-Type" content="application/xhtml+xml; charset=UTF-8" />
<meta http-equiv="Content-Script-Type" content="text/javascript"/>
<title>
Package: Alog.Transforms
</title>
<link rel='stylesheet' href='support/docgen.css' type='text/css'/>
<link rel='stylesheet' href='support/tags.css' type='text/css'/>
<script src='support/docgen.js' type='text/javascript' charset='utf-8'></script>
</head>
<body onload="onloadDoc();">
<div id='leftSide'>
<div id='leftSideInside'>
<div id='header'>
<h2 class="button">Documentation</h2>
<a href='index.html'><div class="button2">Table of Contents</div></a>
<a href='tree.html'><div class="button2">Class Inheritance Tree</div></a>
</div>
<div id='navigation'>
<h2 class="button">Navigation</h2>
<a href='#Description'><div class="button2">Description</div></a>
<a href='#Classes'><div class="button2">Classes</div></a>
<a href='#Types'><div class="button2">Types</div></a>
<a href='#Methods'><div class="button2">Subprograms & Entries</div></a>
</div><!-- navigation -->
</div>
</div> <!-- leftSide -->
<div class='default' id='rightSide'>
<div id='rightSideInside'>
<div id='Index'>
<h2>Index</h2>
<script type="text/javascript">
var names = new Array (
new Array ('Instance (abstract)', 'alog-transforms.ads:31:9', 'class-spec'),
new Array ('Class', 'alog-transforms.ads:35:12', 'type-spec'),
new Array ('Handle', 'alog-transforms.ads:37:9', 'type-spec'),
new Array ('=', 'alog-transforms.ads:39:13', 'subp-spec'),
new Array ('Set_<wbr/>Name', 'alog-transforms.ads:45:14', 'subp-spec'),
new Array ('Get_<wbr/>Name', 'alog-transforms.ads:50:13', 'subp-spec'),
new Array ('Transform_<wbr/>Message (abstract)', 'alog-transforms.ads:53:13', 'subp-spec'),
new Array ('Setup', 'alog-transforms.ads:60:14', 'subp-spec'),
new Array ('Teardown', 'alog-transforms.ads:65:14', 'subp-spec'),
new Array ('dummy', '', ''));
printIndexList (names);
</script>
<noscript>
<ul>
<li class='class-spec'><a href="#alog-transforms.ads:31:9">Instance (abstract)</a></li>
<li class='type-spec'><a href="#alog-transforms.ads:35:12">Class</a></li>
<li class='type-spec'><a href="#alog-transforms.ads:37:9">Handle</a></li>
<li class='subp-spec'><a href="#alog-transforms.ads:39:13">=</a></li>
<li class='subp-spec'><a href="#alog-transforms.ads:45:14">Set_<wbr/>Name</a></li>
<li class='subp-spec'><a href="#alog-transforms.ads:50:13">Get_<wbr/>Name</a></li>
<li class='subp-spec'><a href="#alog-transforms.ads:53:13">Transform_<wbr/>Message (abstract)</a></li>
<li class='subp-spec'><a href="#alog-transforms.ads:60:14">Setup</a></li>
<li class='subp-spec'><a href="#alog-transforms.ads:65:14">Teardown</a></li>
</ul>
</noscript>
</div>
</div>
</div>
<div class='default' id='documentation'>
<div class='title'>
Package:
<span class="droplink"><i>Alog.Transforms</i><ul>
<li><a href="src_alog-transforms.ads.html">Goto spec source</a></li>
</ul></span>
</div>
<div class='subprograms'>
<h1><a name='Description' id='Description'></a>Description</h1>
<div class="class">
<div class='details'><pre><span class="keyword">package</span> <span class="name"><b>Alog.Transforms</b></span> <span class="keyword">is</span></pre></div>
<div class='comment'>Abstract package Transforms. Provides methods used by all Alog transforms. </div>
</div>
</div>
<div class='subprograms'>
<h1><a name='Classes' id='Classes'></a>Classes</h1>
<div class="class">
<h3><a name='alog-transforms.ads:31:9' id='alog-transforms.ads:31:9'></a>
<span class="droplink">Instance (abstract)<ul>
<li><a href="src_alog-transforms.ads.html#l31">Goto declaration in source</a></li>
<li><a href="src_alog-transforms.ads.html#l72">Goto full declaration in source</a></li>
</ul></span>
</h3>
<div class='details'><pre><span class="keyword">type</span> <span class="name"><b>Instance</b></span> <span class="keyword">is</span> <span class="keyword">abstract</span> <span class="keyword">tagged</span> <span class="keyword">limited</span> <span class="keyword">private</span>;</pre></div>
<div class='profile'>
<div>
<h4>Immediate Children:</h4>
<div><a href="alog-transforms-casing.ads.html#alog-transforms-casing.ads:29:9" title="defined at alog-transforms-casing.ads:29:9">Alog.Transforms.Casing.Instance</a></div>
<div><a href="alog-transforms.ads.html#alog-transforms.ads:35:12" title="defined at alog-transforms.ads:35:12">Alog.Transforms.Class</a></div>
</div>
<div>
<h4>Primitive operations:</h4>
<div><span class="droplink">Setup<ul><li><a href="alog-transforms.ads.html#alog-transforms.ads:60:14" title="To API doc">To API doc</a></li><li><a href="src_alog-transforms.ads.html#l60" title="To spec">To spec</a></li></ul></span></div>
<div><span class="droplink">Teardown<ul><li><a href="alog-transforms.ads.html#alog-transforms.ads:65:14" title="To API doc">To API doc</a></li><li><a href="src_alog-transforms.ads.html#l65" title="To spec">To spec</a></li></ul></span></div>
<div><span class="droplink">Transform_Message<ul><li><a href="alog-transforms.ads.html#alog-transforms.ads:53:13" title="To API doc">To API doc</a></li><li><a href="src_alog-transforms.ads.html#l53" title="To spec">To spec</a></li></ul></span></div>
</div>
</div>
<div class='profile'>
<h4>References:</h4>
<div><i><a href="src_alog-transforms.ads.html#l31" title="alog-transforms.ads:31:9">alog-transforms.ads:31:9</a> (declaration)</i></div>
<div><i><a href="src_alog-transforms-casing.ads.html#l29" title="alog-transforms-casing.ads:29:41">alog-transforms-casing.ads:29:41</a> (reference)</i></div>
<div><i><a href="src_alog-transforms-casing.ads.html#l49" title="alog-transforms-casing.ads:49:41">alog-transforms-casing.ads:49:41</a> (reference)</i></div>
<div><i><a href="src_alog-transforms.ads.html#l35" title="alog-transforms.ads:35:21">alog-transforms.ads:35:21</a> (reference)</i></div>
<div><i><a href="src_alog-transforms.ads.html#l54" title="alog-transforms.ads:54:19">alog-transforms.ads:54:19</a> (reference)</i></div>
<div><i><a href="src_alog-transforms.ads.html#l60" title="alog-transforms.ads:60:40">alog-transforms.ads:60:40</a> (reference)</i></div>
<div><i><a href="src_alog-transforms.ads.html#l65" title="alog-transforms.ads:65:43">alog-transforms.ads:65:43</a> (reference)</i></div>
<div><i><a href="src_alog-transforms.ads.html#l72" title="alog-transforms.ads:72:9">alog-transforms.ads:72:9</a> (full declaration)</i></div>
</div>
<div class='comment'>Abstract type transform instance. All tranforms in the Alog framework must implement this type. </div>
</div>
</div>
<div class='subprograms'>
<h1><a name='Types' id='Types'></a>Types</h1>
<div class="class">
<h3>
<a name='alog-transforms.ads:35:12' id='alog-transforms.ads:35:12'></a>
<span class="droplink">Class<ul>
<li><a href="src_alog-transforms.ads.html#l35">Goto declaration in source</a></li>
</ul></span>
</h3>
<div class='details'><pre><span class="keyword">subtype</span> <span class="name"><b>Class</b></span> <span class="keyword">is</span> <a href="alog-transforms.ads.html#alog-transforms.ads:31:9" title="defined at alog-transforms.ads:31:9">Instance</a>'<a href="alog-transforms.ads.html#alog-transforms.ads:35:12" title="defined at alog-transforms.ads:35:12">Class</a>;</pre></div>
<div class='profile'>
<h4>References:</h4>
<div><i><a href="src_alog-transforms.ads.html#l35" title="alog-transforms.ads:35:12">alog-transforms.ads:35:12</a> (declaration)</i></div>
<div><i><a href="src_alog-logger.ads.html#l132" title="alog-logger.ads:132:28">alog-logger.ads:132:28</a> (reference)</i></div>
<div><i><a href="src_alog-logger.ads.html#l161" title="alog-logger.ads:161:36">alog-logger.ads:161:36</a> (reference)</i></div>
<div><i>alog-transforms.adb:38:35 (reference)</i></div>
<div><i>alog-transforms.adb:46:26 (reference)</i></div>
<div><i><a href="src_alog-transforms.ads.html#l37" title="alog-transforms.ads:37:26">alog-transforms.ads:37:26</a> (reference)</i></div>
<div><i><a href="src_alog-transforms.ads.html#l46" title="alog-transforms.ads:46:26">alog-transforms.ads:46:26</a> (reference)</i></div>
<div><i><a href="src_alog-transforms.ads.html#l50" title="alog-transforms.ads:50:35">alog-transforms.ads:50:35</a> (reference)</i></div>
</div>
</div>
<div class="class">
<h3>
<a name='alog-transforms.ads:37:9' id='alog-transforms.ads:37:9'></a>
<span class="droplink">Handle<ul>
<li><a href="src_alog-transforms.ads.html#l37">Goto declaration in source</a></li>
</ul></span>
</h3>
<div class='details'><pre><span class="keyword">type</span> <span class="name"><b>Handle</b></span> <span class="keyword">is</span> <span class="keyword">access</span> <a href="alog-transforms.ads.html#alog-transforms.ads:35:12" title="defined at alog-transforms.ads:35:12">Class</a>;</pre></div>
<div class='profile'>
<h4>References:</h4>
<div><i><a href="src_alog-transforms.ads.html#l37" title="alog-transforms.ads:37:9">alog-transforms.ads:37:9</a> (declaration)</i></div>
<div><i>alog-active_logger.adb:60:37 (reference)</i></div>
<div><i><a href="src_alog-active_logger.ads.html#l82" title="alog-active_logger.ads:82:37">alog-active_logger.ads:82:37</a> (reference)</i></div>
<div><i>alog-logger.adb:73:37 (reference)</i></div>
<div><i>alog-logger.adb:101:57 (reference)</i></div>
<div><i>alog-logger.adb:104:57 (reference)</i></div>
<div><i>alog-logger.adb:199:40 (reference)</i></div>
<div><i>alog-logger.adb:230:61 (reference)</i></div>
<div><i>alog-logger.adb:233:61 (reference)</i></div>
<div><i>alog-logger.adb:284:50 (reference)</i></div>
<div><i>alog-logger.adb:293:39 (reference)</i></div>
<div><i><a href="src_alog-logger.ads.html#l84" title="alog-logger.ads:84:37">alog-logger.ads:84:37</a> (reference)</i></div>
<div><i><a href="src_alog-logger.ads.html#l100" title="alog-logger.ads:100:50">alog-logger.ads:100:50</a> (reference)</i></div>
<div><i><a href="src_alog-logger.ads.html#l107" title="alog-logger.ads:107:50">alog-logger.ads:107:50</a> (reference)</i></div>
<div><i><a href="src_alog-logger.ads.html#l133" title="alog-logger.ads:133:28">alog-logger.ads:133:28</a> (reference)</i></div>
<div><i><a href="src_alog-logger.ads.html#l162" title="alog-logger.ads:162:36">alog-logger.ads:162:36</a> (reference)</i></div>
<div><i>alog-tasked_logger.adb:146:64 (reference)</i></div>
<div><i><a href="src_alog-tasked_logger.ads.html#l67" title="alog-tasked_logger.ads:67:54">alog-tasked_logger.ads:67:54</a> (reference)</i></div>
<div><i>alog-transforms.adb:29:15 (reference)</i></div>
<div><i>alog-transforms.adb:30:15 (reference)</i></div>
<div><i><a href="src_alog-transforms.ads.html#l40" title="alog-transforms.ads:40:15">alog-transforms.ads:40:15</a> (reference)</i></div>
<div><i><a href="src_alog-transforms.ads.html#l41" title="alog-transforms.ads:41:15">alog-transforms.ads:41:15</a> (reference)</i></div>
</div>
</div>
</div>
<div class='subprograms'>
<h1><a name='Methods' id='Methods'></a>Subprograms & Entries</h1>
<div class="class">
<h3>
<a name='alog-transforms.ads:39:13' id='alog-transforms.ads:39:13'></a>
<span class="droplink">=<ul>
<li><a href="src_alog-transforms.ads.html#l39">Goto spec in source</a></li>
</ul></span>
</h3>
<div class='details'><pre><span class="keyword">function</span> <span class="name"><b>"="</b></span> <table><tr><td>(</td><td><span class="name"><a name="alog-transforms.ads:40:7"></a>Left</span></td><td>: <a href="alog-transforms.ads.html#alog-transforms.ads:37:9" title="defined at alog-transforms.ads:37:9">Handle</a>;</td></tr><tr><td></td><td><span class="name"><a name="alog-transforms.ads:41:7"></a>Right</span></td><td>: <a href="alog-transforms.ads.html#alog-transforms.ads:37:9" title="defined at alog-transforms.ads:37:9">Handle</a>)</td></tr></table><span class="keyword">return</span> Boolean;</pre></div>
<div class='profile'>
<h4>References:</h4>
<div><i><a href="src_alog-transforms.ads.html#l39" title="alog-transforms.ads:39:13">alog-transforms.ads:39:13</a> (declaration)</i></div>
<div><i>alog-transforms.adb:28:13 (body)</i></div>
<div><i>alog-transforms.adb:34:8 (label)</i></div>
</div>
<div class='profile'>
<h4>Calls:</h4>
<div><i><a href="alog-transforms.ads.html#alog-transforms.ads:50:13" title="defined at alog-transforms.ads:50:13">Get_Name</a> defined at <a href="src_alog-transforms.ads.html#l50" title="alog-transforms.ads:50:13">alog-transforms.ads:50:13</a></i></div>
</div>
<div class='comment'>Equal function. </div>
</div>
<div class="class">
<h3>
<a name='alog-transforms.ads:45:14' id='alog-transforms.ads:45:14'></a>
<span class="droplink">Set_Name<ul>
<li><a href="src_alog-transforms.ads.html#l45">Goto spec in source</a></li>
</ul></span>
</h3>
<div class='details'><pre><span class="keyword">procedure</span> <span class="name"><b>Set_Name</b></span> <table><tr><td>(</td><td><span class="name"><a name="alog-transforms.ads:46:7"></a>Transform</span></td><td>: <span class="keyword">in</span> <span class="keyword">out</span> <a href="alog-transforms.ads.html#alog-transforms.ads:35:12" title="defined at alog-transforms.ads:35:12">Class</a>;</td></tr><tr><td></td><td><span class="name"><a name="alog-transforms.ads:47:7"></a>Name</span></td><td>: String);</td></tr></table></pre></div>
<div class='profile'>
<h4>References:</h4>
<div><i><a href="src_alog-transforms.ads.html#l45" title="alog-transforms.ads:45:14">alog-transforms.ads:45:14</a> (declaration)</i></div>
<div><i>alog-transforms.adb:45:14 (body)</i></div>
<div><i>alog-transforms.adb:51:8 (label)</i></div>
</div>
<div class='profile'>
<h4>Calls:</h4>
<div><i>To_Unbounded_String defined at a-strunb.ads:57:13</i></div>
</div>
<div class='comment'>Set transform name. </div>
</div>
<div class="class">
<h3>
<a name='alog-transforms.ads:50:13' id='alog-transforms.ads:50:13'></a>
<span class="droplink">Get_Name<ul>
<li><a href="src_alog-transforms.ads.html#l50">Goto spec in source</a></li>
</ul></span>
</h3>
<div class='details'><pre><span class="keyword">function</span> <span class="name"><b>Get_Name</b></span> <table><tr><td>(</td><td><span class="name"><a name="alog-transforms.ads:50:23"></a>Transform</span></td><td>: <a href="alog-transforms.ads.html#alog-transforms.ads:35:12" title="defined at alog-transforms.ads:35:12">Class</a>)</td></tr></table><span class="keyword">return</span> String;</pre></div>
<div class='profile'>
<h4>References:</h4>
<div><i><a href="src_alog-transforms.ads.html#l50" title="alog-transforms.ads:50:13">alog-transforms.ads:50:13</a> (declaration)</i></div>
<div><i>alog-logger.adb:76:40 (reference)</i></div>
<div><i>alog-transforms.adb:33:19 (reference)</i></div>
<div><i>alog-transforms.adb:33:36 (reference)</i></div>
<div><i>alog-transforms.adb:38:13 (body)</i></div>
<div><i>alog-transforms.adb:41:8 (label)</i></div>
</div>
<div class='profile'>
<h4>Called by:</h4>
<div><i><a href="alog-transforms.ads.html#alog-transforms.ads:39:13" title="defined at alog-transforms.ads:39:13">=</a> defined at <a href="src_alog-transforms.ads.html#l39" title="alog-transforms.ads:39:13">alog-transforms.ads:39:13</a></i></div>
<div><i><a href="alog-transforms.ads.html#alog-transforms.ads:39:13" title="defined at alog-transforms.ads:39:13">=</a> defined at <a href="src_alog-transforms.ads.html#l39" title="alog-transforms.ads:39:13">alog-transforms.ads:39:13</a></i></div>
<div><i><a href="alog-logger.ads.html#alog-logger.ads:82:14" title="defined at alog-logger.ads:82:14">Alog.Logger.Attach_Transform</a> defined at <a href="src_alog-logger.ads.html#l82" title="alog-logger.ads:82:14">alog-logger.ads:82:14</a></i></div>
</div>
<div class='profile'>
<h4>Calls:</h4>
<div><i>To_String defined at a-strunb.ads:63:13</i></div>
</div>
<div class='comment'>Get transform name. </div>
</div>
<div class="class">
<h3>
<a name='alog-transforms.ads:53:13' id='alog-transforms.ads:53:13'></a>
<span class="droplink">Transform_Message (abstract)<ul>
<li><a href="src_alog-transforms.ads.html#l53">Goto spec in source</a></li>
</ul></span>
</h3>
<div class='details'><pre><span class="keyword">function</span> <span class="name"><b>Transform_Message</b></span> <table><tr><td>(</td><td><span class="name"><a name="alog-transforms.ads:54:7"></a>Transform</span></td><td>: <a href="alog-transforms.ads.html#alog-transforms.ads:31:9" title="defined at alog-transforms.ads:31:9">Instance</a>;</td></tr><tr><td></td><td><span class="name"><a name="alog-transforms.ads:55:7"></a>Level</span></td><td>: <a href="alog.ads.html#alog.ads:32:9" title="defined at alog.ads:32:9">Log_Level</a>;</td></tr><tr><td></td><td><span class="name"><a name="alog-transforms.ads:56:7"></a>Msg</span></td><td>: String)</td></tr></table><span class="keyword">return</span> String <span class="keyword">is</span> <span class="keyword">abstract</span>;</pre></div>
<div class='profile'>
<h4>References:</h4>
<div><i><a href="src_alog-transforms.ads.html#l53" title="alog-transforms.ads:53:13">alog-transforms.ads:53:13</a> (declaration)</i></div>
<div><i>alog-logger.adb:235:38 (dispatching call)</i></div>
</div>
<div class='profile'>
<h4>Called by:</h4>
<div><i>Alog.Logger.Log_Message.Do_Transform defined at alog-logger.adb:230:17</i></div>
</div>
<div class='comment'>Transform message with specified log level. </div>
</div>
<div class="class">
<h3>
<a name='alog-transforms.ads:60:14' id='alog-transforms.ads:60:14'></a>
<span class="droplink">Setup<ul>
<li><a href="src_alog-transforms.ads.html#l60">Goto spec in source</a></li>
</ul></span>
</h3>
<div class='details'><pre><span class="keyword">procedure</span> <span class="name"><b>Setup</b></span> <table><tr><td>(</td><td><span class="name"><a name="alog-transforms.ads:60:21"></a>Transform</span></td><td>: <span class="keyword">in</span> <span class="keyword">out</span> <a href="alog-transforms.ads.html#alog-transforms.ads:31:9" title="defined at alog-transforms.ads:31:9">Instance</a>)</td></tr></table><span class="keyword">is</span> <span class="keyword">null</span>;</pre></div>
<div class='profile'>
<h4>References:</h4>
<div><i><a href="src_alog-transforms.ads.html#l60" title="alog-transforms.ads:60:14">alog-transforms.ads:60:14</a> (declaration)</i></div>
</div>
<div class='comment'>Each transform must provide a Setup-procedure. These procedures are called by logger instances when attaching Transforms. All needed operations prior to transforming log messages should be done here. </div>
</div>
<div class="class">
<h3>
<a name='alog-transforms.ads:65:14' id='alog-transforms.ads:65:14'></a>
<span class="droplink">Teardown<ul>
<li><a href="src_alog-transforms.ads.html#l65">Goto spec in source</a></li>
</ul></span>
</h3>
<div class='details'><pre><span class="keyword">procedure</span> <span class="name"><b>Teardown</b></span> <table><tr><td>(</td><td><span class="name"><a name="alog-transforms.ads:65:24"></a>Transform</span></td><td>: <span class="keyword">in</span> <span class="keyword">out</span> <a href="alog-transforms.ads.html#alog-transforms.ads:31:9" title="defined at alog-transforms.ads:31:9">Instance</a>)</td></tr></table><span class="keyword">is</span> <span class="keyword">null</span>;</pre></div>
<div class='profile'>
<h4>References:</h4>
<div><i><a href="src_alog-transforms.ads.html#l65" title="alog-transforms.ads:65:14">alog-transforms.ads:65:14</a> (declaration)</i></div>
<div><i>alog-logger.adb:106:17 (dispatching call)</i></div>
</div>
<div class='profile'>
<h4>Called by:</h4>
<div><i>Alog.Logger.Clear.Teardown_Transform defined at alog-logger.adb:101:17</i></div>
</div>
<div class='comment'>Each transform must provide a Teardown-procedure. These procedures are called by logger instances when detaching Transforms or when the logger object gets out of scope. </div>
</div>
</div>
</div> <!-- documentation -->
</body>
</html>
|
