-
Notifications
You must be signed in to change notification settings - Fork 5
Expand file tree
/
Copy pathclass_r_t_tracer.html
More file actions
487 lines (463 loc) · 32.2 KB
/
class_r_t_tracer.html
File metadata and controls
487 lines (463 loc) · 32.2 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
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
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
<!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.9.6"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>C++ TargetRTS: RTTracer Class 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>
<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" />
</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="projectalign">
<div id="projectname">C++ TargetRTS
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.6 -->
<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" 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');
$(document).ready(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
<!-- 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><!-- top -->
<div class="header">
<div class="summary">
<a href="#nested-classes">Classes</a> |
<a href="#pub-types">Public Types</a> |
<a href="#pub-static-methods">Static Public Member Functions</a> |
<a href="#pro-types">Protected Types</a> |
<a href="#pro-methods">Protected Member Functions</a> |
<a href="#pro-static-methods">Static Protected Member Functions</a> |
<a href="#pro-attribs">Protected Attributes</a> |
<a href="#pro-static-attribs">Static Protected Attributes</a> |
<a href="#friends">Friends</a> |
<a href="class_r_t_tracer-members.html">List of all members</a> </div>
<div class="headertitle"><div class="title">RTTracer Class Reference</div></div>
</div><!--header-->
<div class="contents">
<div class="dynheader">
Inheritance diagram for RTTracer:</div>
<div class="dyncontent">
<div class="center">
<img src="class_r_t_tracer.png" usemap="#RTTracer_map" alt=""/>
<map id="RTTracer_map" name="RTTracer_map">
<area href="class_r_t_stream_buffer.html" alt="RTStreamBuffer" shape="rect" coords="0,56,101,80"/>
<area href="class_r_t_o_buffer.html" title="Represents an output buffer." alt="RTOBuffer" shape="rect" coords="0,0,101,24"/>
</map>
</div></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="nested-classes" name="nested-classes"></a>
Classes</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="struct_r_t_tracer_1_1_trace_info.html">TraceInfo</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Structure with additional info passed to traceMessage call. <a href="struct_r_t_tracer_1_1_trace_info.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-types" name="pub-types"></a>
Public Types</h2></td></tr>
<tr class="memitem:a9c921b7d6e9d593d073099d07ca19426"><td class="memItemLeft" align="right" valign="top"><a id="a9c921b7d6e9d593d073099d07ca19426" name="a9c921b7d6e9d593d073099d07ca19426"></a>enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="class_r_t_tracer.html#a9c921b7d6e9d593d073099d07ca19426">TraceEventKind</a> { <br />
  <b>Initialize</b>
, <b>Send</b>
, <b>Invoke</b>
, <b>InvokeWithoutReply</b>
, <br />
  <b>Reply</b>
, <b>Pause</b>
, <b>Flush</b>
<br />
}</td></tr>
<tr class="memdesc:a9c921b7d6e9d593d073099d07ca19426"><td class="mdescLeft"> </td><td class="mdescRight">Types of trace events supported. <br /></td></tr>
<tr class="separator:a9c921b7d6e9d593d073099d07ca19426"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a1cf76a701ec2cc473cbdacb5fb1d5b19"><td class="memItemLeft" align="right" valign="top"><a id="a1cf76a701ec2cc473cbdacb5fb1d5b19" name="a1cf76a701ec2cc473cbdacb5fb1d5b19"></a>
typedef std::chrono::system_clock::time_point </td><td class="memItemRight" valign="bottom"><b>TraceTime</b></td></tr>
<tr class="memdesc:a1cf76a701ec2cc473cbdacb5fb1d5b19"><td class="mdescLeft"> </td><td class="mdescRight">Type for storing trace timestamps. <br /></td></tr>
<tr class="separator:a1cf76a701ec2cc473cbdacb5fb1d5b19"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-static-methods" name="pub-static-methods"></a>
Static Public Member Functions</h2></td></tr>
<tr class="memitem:a83fe8247894152b1c07832ed2719216a"><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_r_t_tracer.html#a83fe8247894152b1c07832ed2719216a">flushTrace</a> (void)</td></tr>
<tr class="memdesc:a83fe8247894152b1c07832ed2719216a"><td class="mdescLeft"> </td><td class="mdescRight">Flush buffered trace messages to file. <br /></td></tr>
<tr class="separator:a83fe8247894152b1c07832ed2719216a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a8db8bc5988ebe629b21f27213cfb220b"><td class="memItemLeft" align="right" valign="top">static bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_r_t_tracer.html#a8db8bc5988ebe629b21f27213cfb220b">isEnabled</a> (void)</td></tr>
<tr class="memdesc:a8db8bc5988ebe629b21f27213cfb220b"><td class="mdescLeft"> </td><td class="mdescRight">Check if tracing is enabled. <br /></td></tr>
<tr class="separator:a8db8bc5988ebe629b21f27213cfb220b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ac12984ca56e8f20a47321d18f8a3b766"><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_r_t_tracer.html#ac12984ca56e8f20a47321d18f8a3b766">setEnabled</a> (bool)</td></tr>
<tr class="memdesc:ac12984ca56e8f20a47321d18f8a3b766"><td class="mdescLeft"> </td><td class="mdescRight">Enable or disable tracing to file. <br /></td></tr>
<tr class="separator:ac12984ca56e8f20a47321d18f8a3b766"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a4c698ff8a0044108b33d32a6fdf477bb"><td class="memItemLeft" align="right" valign="top">static bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_r_t_tracer.html#a4c698ff8a0044108b33d32a6fdf477bb">configure</a> (const char *configFile=nullptr)</td></tr>
<tr class="memdesc:a4c698ff8a0044108b33d32a6fdf477bb"><td class="mdescLeft"> </td><td class="mdescRight">Configure <a class="el" href="class_r_t_tracer.html">RTTracer</a> and tracing preferences. <br /></td></tr>
<tr class="separator:a4c698ff8a0044108b33d32a6fdf477bb"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a38199c0cbad8c78f6f81789f5848caf7"><td class="memItemLeft" align="right" valign="top">static bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_r_t_tracer.html#a38199c0cbad8c78f6f81789f5848caf7">isConfigured</a> (void)</td></tr>
<tr class="memdesc:a38199c0cbad8c78f6f81789f5848caf7"><td class="mdescLeft"> </td><td class="mdescRight">Check if tracing has been configured. <br /></td></tr>
<tr class="separator:a38199c0cbad8c78f6f81789f5848caf7"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a935be4340a4b0bed29b9b3a6b558d97b"><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_r_t_tracer.html#a935be4340a4b0bed29b9b3a6b558d97b">note</a> (const std::string &text)</td></tr>
<tr class="memdesc:a935be4340a4b0bed29b9b3a6b558d97b"><td class="mdescLeft"> </td><td class="mdescRight">Write a note to the trace. <br /></td></tr>
<tr class="separator:a935be4340a4b0bed29b9b3a6b558d97b"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pro-types" name="pro-types"></a>
Protected Types</h2></td></tr>
<tr class="memitem:ad60ac5226e3ba248f0dc29262c371b43"><td class="memItemLeft" align="right" valign="top"><a id="ad60ac5226e3ba248f0dc29262c371b43" name="ad60ac5226e3ba248f0dc29262c371b43"></a>enum  </td><td class="memItemRight" valign="bottom">{ <br />
  <b>TIME1</b> = 0x10
, <b>TIME2</b> = 0x20
, <b>TIME3</b> = 0x40
, <b>TIME_ABSOLUTE</b> = 0x80
, <br />
  <b>PRECISION_MASK</b> = 0x0F
, <b>PRECISION_NANO</b> = 0x09
, <b>PRECISION_MICRO</b> = 0x06
, <b>PRECISION_MILLI</b> = 0x03
<br />
}</td></tr>
<tr class="separator:ad60ac5226e3ba248f0dc29262c371b43"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pro-methods" name="pro-methods"></a>
Protected Member Functions</h2></td></tr>
<tr class="memitem:ad2b2de0d4e52823f948d15b0ce8a59c8"><td class="memItemLeft" align="right" valign="top"><a id="ad2b2de0d4e52823f948d15b0ce8a59c8" name="ad2b2de0d4e52823f948d15b0ce8a59c8"></a>
void </td><td class="memItemRight" valign="bottom"><b>printTimestamp</b> (const <a class="el" href="class_r_t_tracer.html#a1cf76a701ec2cc473cbdacb5fb1d5b19">TraceTime</a> &timestamp)</td></tr>
<tr class="separator:ad2b2de0d4e52823f948d15b0ce8a59c8"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a5fb89f5b23ead10e1b82b78324c8e844"><td class="memItemLeft" align="right" valign="top"><a id="a5fb89f5b23ead10e1b82b78324c8e844" name="a5fb89f5b23ead10e1b82b78324c8e844"></a>
void </td><td class="memItemRight" valign="bottom"><b>traceMessage</b> (const <a class="el" href="class_r_t_message.html">RTMessage</a> *, <a class="el" href="class_r_t_tracer.html#a9c921b7d6e9d593d073099d07ca19426">TraceEventKind</a> traceEventKind, const <a class="el" href="struct_r_t_tracer_1_1_trace_info.html">TraceInfo</a> *)</td></tr>
<tr class="separator:a5fb89f5b23ead10e1b82b78324c8e844"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a2b97c587ba955142291f0d6467e4d9a0"><td class="memItemLeft" align="right" valign="top"><a id="a2b97c587ba955142291f0d6467e4d9a0" name="a2b97c587ba955142291f0d6467e4d9a0"></a>
void </td><td class="memItemRight" valign="bottom"><b>traceNote</b> (const std::string &text)</td></tr>
<tr class="separator:a2b97c587ba955142291f0d6467e4d9a0"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a5802b886b025fca72aec3e774f9a4069"><td class="memItemLeft" align="right" valign="top"><a id="a5802b886b025fca72aec3e774f9a4069" name="a5802b886b025fca72aec3e774f9a4069"></a>
void </td><td class="memItemRight" valign="bottom"><b>traceNote_nolock</b> (const std::string &text)</td></tr>
<tr class="separator:a5802b886b025fca72aec3e774f9a4069"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ae5e72d70c7d8fdadf4f0897fc6cdfd6d"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="class_r_t_tracer.html#ae5e72d70c7d8fdadf4f0897fc6cdfd6d">flush</a> (void) override</td></tr>
<tr class="memdesc:ae5e72d70c7d8fdadf4f0897fc6cdfd6d"><td class="mdescLeft"> </td><td class="mdescRight">Flushes the data written to the buffer. <br /></td></tr>
<tr class="separator:ae5e72d70c7d8fdadf4f0897fc6cdfd6d"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pro-static-methods" name="pro-static-methods"></a>
Static Protected Member Functions</h2></td></tr>
<tr class="memitem:a572dd5ffc9d6e5c0923919d1980bd166"><td class="memItemLeft" align="right" valign="top"><a id="a572dd5ffc9d6e5c0923919d1980bd166" name="a572dd5ffc9d6e5c0923919d1980bd166"></a>
static <a class="el" href="class_r_t_tracer.html">RTTracer</a> & </td><td class="memItemRight" valign="bottom"><b>instance</b> ()</td></tr>
<tr class="separator:a572dd5ffc9d6e5c0923919d1980bd166"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a3e6e5c70e0753eef230e401ff0874cdf"><td class="memItemLeft" align="right" valign="top"><a id="a3e6e5c70e0753eef230e401ff0874cdf" name="a3e6e5c70e0753eef230e401ff0874cdf"></a>
static std::string </td><td class="memItemRight" valign="bottom"><b>initTraceFile</b> (void)</td></tr>
<tr class="separator:a3e6e5c70e0753eef230e401ff0874cdf"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a1b792daa2ab3c0ea526ef8835b26459a"><td class="memItemLeft" align="right" valign="top"><a id="a1b792daa2ab3c0ea526ef8835b26459a" name="a1b792daa2ab3c0ea526ef8835b26459a"></a>
static void </td><td class="memItemRight" valign="bottom"><b>getSenderInfo</b> (const <a class="el" href="class_r_t_message.html">RTMessage</a> *, <a class="el" href="struct_r_t_tracer_1_1_trace_info.html">TraceInfo</a> *)</td></tr>
<tr class="separator:a1b792daa2ab3c0ea526ef8835b26459a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a990764803753e6a3bd9fe21a3c6fd92d"><td class="memItemLeft" align="right" valign="top"><a id="a990764803753e6a3bd9fe21a3c6fd92d" name="a990764803753e6a3bd9fe21a3c6fd92d"></a>
static void </td><td class="memItemRight" valign="bottom"><b>traceMS</b> (const <a class="el" href="class_r_t_message.html">RTMessage</a> *, <a class="el" href="class_r_t_tracer.html#a9c921b7d6e9d593d073099d07ca19426">TraceEventKind</a> traceEventKind, const <a class="el" href="struct_r_t_tracer_1_1_trace_info.html">TraceInfo</a> *=nullptr)</td></tr>
<tr class="separator:a990764803753e6a3bd9fe21a3c6fd92d"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pro-attribs" name="pro-attribs"></a>
Protected Attributes</h2></td></tr>
<tr class="memitem:a0a995e9235ad024bb583356c168e5592"><td class="memItemLeft" align="right" valign="top"><a id="a0a995e9235ad024bb583356c168e5592" name="a0a995e9235ad024bb583356c168e5592"></a>
std::string </td><td class="memItemRight" valign="bottom"><b>_traceFile</b></td></tr>
<tr class="separator:a0a995e9235ad024bb583356c168e5592"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aa1fae6eaff9b9e407ea59d36c70dc459"><td class="memItemLeft" align="right" valign="top"><a id="aa1fae6eaff9b9e407ea59d36c70dc459" name="aa1fae6eaff9b9e407ea59d36c70dc459"></a>
std::ofstream </td><td class="memItemRight" valign="bottom"><b>_file</b></td></tr>
<tr class="separator:aa1fae6eaff9b9e407ea59d36c70dc459"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="inherit_header pro_attribs_class_r_t_stream_buffer"><td colspan="2" onclick="javascript:toggleInherit('pro_attribs_class_r_t_stream_buffer')"><img src="closed.png" alt="-"/> Protected Attributes inherited from <a class="el" href="class_r_t_stream_buffer.html">RTStreamBuffer</a></td></tr>
<tr class="memitem:a552c109b4d9e0bb0ba0a59272feb731e inherit pro_attribs_class_r_t_stream_buffer"><td class="memItemLeft" align="right" valign="top"><a id="a552c109b4d9e0bb0ba0a59272feb731e" name="a552c109b4d9e0bb0ba0a59272feb731e"></a>
int </td><td class="memItemRight" valign="bottom"><b>offset</b></td></tr>
<tr class="separator:a552c109b4d9e0bb0ba0a59272feb731e inherit pro_attribs_class_r_t_stream_buffer"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a10c01a456497d83fe5e26c6e80f8c609 inherit pro_attribs_class_r_t_stream_buffer"><td class="memItemLeft" align="right" valign="top"><a id="a10c01a456497d83fe5e26c6e80f8c609" name="a10c01a456497d83fe5e26c6e80f8c609"></a>
char </td><td class="memItemRight" valign="bottom"><b>buffer</b> [80]</td></tr>
<tr class="separator:a10c01a456497d83fe5e26c6e80f8c609 inherit pro_attribs_class_r_t_stream_buffer"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pro-static-attribs" name="pro-static-attribs"></a>
Static Protected Attributes</h2></td></tr>
<tr class="memitem:af464ccbda79737692441c624c4c375ff"><td class="memItemLeft" align="right" valign="top"><a id="af464ccbda79737692441c624c4c375ff" name="af464ccbda79737692441c624c4c375ff"></a>
static bool </td><td class="memItemRight" valign="bottom"><b>_enabled</b></td></tr>
<tr class="separator:af464ccbda79737692441c624c4c375ff"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:af492bafa462d3a78190193b3d04157b8"><td class="memItemLeft" align="right" valign="top"><a id="af492bafa462d3a78190193b3d04157b8" name="af492bafa462d3a78190193b3d04157b8"></a>
static <a class="el" href="class_r_t_json_result.html">RTJsonResult</a> </td><td class="memItemRight" valign="bottom"><b>jsonConfig</b></td></tr>
<tr class="separator:af492bafa462d3a78190193b3d04157b8"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a913fa5849b126cbf225ee0fe4f1c9f2c"><td class="memItemLeft" align="right" valign="top"><a id="a913fa5849b126cbf225ee0fe4f1c9f2c" name="a913fa5849b126cbf225ee0fe4f1c9f2c"></a>
static bool </td><td class="memItemRight" valign="bottom"><b>_configured</b></td></tr>
<tr class="separator:a913fa5849b126cbf225ee0fe4f1c9f2c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aa58d1b04a0c2d3dbc20021842ce3912e"><td class="memItemLeft" align="right" valign="top"><a id="aa58d1b04a0c2d3dbc20021842ce3912e" name="aa58d1b04a0c2d3dbc20021842ce3912e"></a>
static std::string </td><td class="memItemRight" valign="bottom"><b>_applicationName</b></td></tr>
<tr class="separator:aa58d1b04a0c2d3dbc20021842ce3912e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a31f92e053c818cb71398a1fe2bd0da22"><td class="memItemLeft" align="right" valign="top"><a id="a31f92e053c818cb71398a1fe2bd0da22" name="a31f92e053c818cb71398a1fe2bd0da22"></a>
static std::string </td><td class="memItemRight" valign="bottom"><b>_traceFileName</b></td></tr>
<tr class="separator:a31f92e053c818cb71398a1fe2bd0da22"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a11702acec90283162ecb75326793b9ee"><td class="memItemLeft" align="right" valign="top"><a id="a11702acec90283162ecb75326793b9ee" name="a11702acec90283162ecb75326793b9ee"></a>
static bool </td><td class="memItemRight" valign="bottom"><b>_overwriteFile</b></td></tr>
<tr class="separator:a11702acec90283162ecb75326793b9ee"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a0485ee92267819c3920e81ecc2198953"><td class="memItemLeft" align="right" valign="top"><a id="a0485ee92267819c3920e81ecc2198953" name="a0485ee92267819c3920e81ecc2198953"></a>
static <a class="el" href="class_r_t_tracer.html#a1cf76a701ec2cc473cbdacb5fb1d5b19">TraceTime</a> </td><td class="memItemRight" valign="bottom"><b>_start</b></td></tr>
<tr class="separator:a0485ee92267819c3920e81ecc2198953"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a215ac65f6aa6891d10c8b74876276a8e"><td class="memItemLeft" align="right" valign="top"><a id="a215ac65f6aa6891d10c8b74876276a8e" name="a215ac65f6aa6891d10c8b74876276a8e"></a>
static int </td><td class="memItemRight" valign="bottom"><b>_timestamps</b></td></tr>
<tr class="separator:a215ac65f6aa6891d10c8b74876276a8e"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="friends" name="friends"></a>
Friends</h2></td></tr>
<tr class="memitem:aa644bc916a7ca31a4149961f3ad64ff6"><td class="memItemLeft" align="right" valign="top"><a id="aa644bc916a7ca31a4149961f3ad64ff6" name="aa644bc916a7ca31a4149961f3ad64ff6"></a>
class </td><td class="memItemRight" valign="bottom"><b>RTActor</b></td></tr>
<tr class="separator:aa644bc916a7ca31a4149961f3ad64ff6"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a91aadf601e2893e151a4bf263315ccd4"><td class="memItemLeft" align="right" valign="top"><a id="a91aadf601e2893e151a4bf263315ccd4" name="a91aadf601e2893e151a4bf263315ccd4"></a>
class </td><td class="memItemRight" valign="bottom"><b>RTMessage</b></td></tr>
<tr class="separator:a91aadf601e2893e151a4bf263315ccd4"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a5e75f7ca9efcae5275eb1753b036b30d"><td class="memItemLeft" align="right" valign="top"><a id="a5e75f7ca9efcae5275eb1753b036b30d" name="a5e75f7ca9efcae5275eb1753b036b30d"></a>
class </td><td class="memItemRight" valign="bottom"><b>RTProtocol</b></td></tr>
<tr class="separator:a5e75f7ca9efcae5275eb1753b036b30d"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="inherited" name="inherited"></a>
Additional Inherited Members</h2></td></tr>
<tr class="inherit_header pub_methods_class_r_t_stream_buffer"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_class_r_t_stream_buffer')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="class_r_t_stream_buffer.html">RTStreamBuffer</a></td></tr>
<tr class="memitem:a15445af67ccff17e89a1989f2a74b0cd inherit pub_methods_class_r_t_stream_buffer"><td class="memItemLeft" align="right" valign="top">virtual int </td><td class="memItemRight" valign="bottom"><a class="el" href="class_r_t_stream_buffer.html#a15445af67ccff17e89a1989f2a74b0cd">write</a> (const char *data, int size) override</td></tr>
<tr class="memdesc:a15445af67ccff17e89a1989f2a74b0cd inherit pub_methods_class_r_t_stream_buffer"><td class="mdescLeft"> </td><td class="mdescRight">Write a string to the buffer. <br /></td></tr>
<tr class="separator:a15445af67ccff17e89a1989f2a74b0cd inherit pub_methods_class_r_t_stream_buffer"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ad5705ef44b354b50a74cd3e81bb97fb9"><td class="memItemLeft" align="right" valign="top">virtual int </td><td class="memItemRight" valign="bottom"><a class="el" href="class_r_t_o_buffer.html#ad5705ef44b354b50a74cd3e81bb97fb9">write</a> (const char *data, int size)=0</td></tr>
<tr class="memdesc:ad5705ef44b354b50a74cd3e81bb97fb9"><td class="mdescLeft"> </td><td class="mdescRight">Write a string to the buffer. <br /></td></tr>
<tr class="separator:ad5705ef44b354b50a74cd3e81bb97fb9"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a86f3c112e3473ae2eda74357e71db9cf"><td class="memItemLeft" align="right" valign="top">virtual int </td><td class="memItemRight" valign="bottom"><a class="el" href="class_r_t_o_buffer.html#a86f3c112e3473ae2eda74357e71db9cf">flush</a> (void)=0</td></tr>
<tr class="memdesc:a86f3c112e3473ae2eda74357e71db9cf"><td class="mdescLeft"> </td><td class="mdescRight">Flushes the data written to the buffer. <br /></td></tr>
<tr class="separator:a86f3c112e3473ae2eda74357e71db9cf"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a4c698ff8a0044108b33d32a6fdf477bb" name="a4c698ff8a0044108b33d32a6fdf477bb"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4c698ff8a0044108b33d32a6fdf477bb">◆ </a></span>configure()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static bool RTTracer::configure </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>configFile</em> = <code>nullptr</code></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Configure <a class="el" href="class_r_t_tracer.html">RTTracer</a> and tracing preferences. </p>
<p>Parse JSON configuration file and override defaults. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">configFile</td><td>JSON configuration file to parse. If not provided, get it from the -traceConfig command line argument instead. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="ae5e72d70c7d8fdadf4f0897fc6cdfd6d" name="ae5e72d70c7d8fdadf4f0897fc6cdfd6d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae5e72d70c7d8fdadf4f0897fc6cdfd6d">◆ </a></span>flush()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">int RTTracer::flush </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">override</span><span class="mlabel">protected</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Flushes the data written to the buffer. </p>
<p>For some output buffers, the written data will not appear in the output until <a class="el" href="class_r_t_tracer.html#ae5e72d70c7d8fdadf4f0897fc6cdfd6d" title="Flushes the data written to the buffer.">flush()</a> has been called. For others explicit flushing is not needed. </p><dl class="section return"><dt>Returns</dt><dd>1 if successful, 0 otherwise </dd></dl>
<p>Implements <a class="el" href="class_r_t_o_buffer.html#a86f3c112e3473ae2eda74357e71db9cf">RTOBuffer</a>.</p>
</div>
</div>
<a id="a83fe8247894152b1c07832ed2719216a" name="a83fe8247894152b1c07832ed2719216a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a83fe8247894152b1c07832ed2719216a">◆ </a></span>flushTrace()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void RTTracer::flushTrace </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Flush buffered trace messages to file. </p>
<p>This function is called each time 'trace [on|off]' command is sent to the running application. </p>
</div>
</div>
<a id="a38199c0cbad8c78f6f81789f5848caf7" name="a38199c0cbad8c78f6f81789f5848caf7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a38199c0cbad8c78f6f81789f5848caf7">◆ </a></span>isConfigured()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool RTTracer::isConfigured </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Check if tracing has been configured. </p>
<dl class="section return"><dt>Returns</dt><dd>true if yes, false if no. </dd></dl>
</div>
</div>
<a id="a8db8bc5988ebe629b21f27213cfb220b" name="a8db8bc5988ebe629b21f27213cfb220b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8db8bc5988ebe629b21f27213cfb220b">◆ </a></span>isEnabled()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool RTTracer::isEnabled </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Check if tracing is enabled. </p>
<dl class="section return"><dt>Returns</dt><dd>true if yes, false if no. </dd></dl>
</div>
</div>
<a id="a935be4340a4b0bed29b9b3a6b558d97b" name="a935be4340a4b0bed29b9b3a6b558d97b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a935be4340a4b0bed29b9b3a6b558d97b">◆ </a></span>note()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void RTTracer::note </td>
<td>(</td>
<td class="paramtype">const std::string & </td>
<td class="paramname"><em>text</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Write a note to the trace. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">text</td><td>Note text to write to the trace. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="ac12984ca56e8f20a47321d18f8a3b766" name="ac12984ca56e8f20a47321d18f8a3b766"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac12984ca56e8f20a47321d18f8a3b766">◆ </a></span>setEnabled()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static void RTTracer::setEnabled </td>
<td>(</td>
<td class="paramtype">bool </td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Enable or disable tracing to file. </p>
<p>This function can be called many times during execution. When tracing status changes to disabled, a note saying that tracing is paused is written to the trace and all output is flushed to file. Note that enabling or disabling tracing takes effect immediately. That is, if this function is called while processing a message (e.g. from a transition code snippet) that message will not be traced if tracing is turned off (setEnabled(false)) while it will be traced if tracing is turned on (setEnabled(true)). </p>
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li><a class="el" href="_r_t_tracer_8h_source.html">RTTracer.h</a></li>
<li>RTTracer.inl</li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.6
</small></address>
</body>
</html>