-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathclassproio_1_1Event.html
More file actions
594 lines (550 loc) · 30.1 KB
/
classproio_1_1Event.html
File metadata and controls
594 lines (550 loc) · 30.1 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
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.11"/>
<title>proio: proio::Event 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>
<script type="text/javascript">
$(document).ready(function() { init_search(); });
</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 style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">proio
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.11 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
<li>
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</span>
</div>
</li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Class List</span></a></li>
<li><a href="classes.html"><span>Class Index</span></a></li>
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class Members</span></a></li>
</ul>
</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">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><b>proio</b></li><li class="navelem"><a class="el" href="classproio_1_1Event.html">Event</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="#friends">Friends</a> |
<a href="classproio_1_1Event-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">proio::Event Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p><code>#include <<a class="el" href="event_8h_source.html">event.h</a>></code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a5a40dd4708297f7031e29b39e039ae10"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classproio_1_1Event.html#a5a40dd4708297f7031e29b39e039ae10">Event</a> ()</td></tr>
<tr class="separator:a5a40dd4708297f7031e29b39e039ae10"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a77ac77a367dd7382fa162aaa3f044b4d"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classproio_1_1Event.html#a77ac77a367dd7382fa162aaa3f044b4d">Event</a> (const std::string &proto)</td></tr>
<tr class="separator:a77ac77a367dd7382fa162aaa3f044b4d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a5af4a67915f2fe8aac76d3c20d3278bd"><td class="memItemLeft" align="right" valign="top">uint64_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classproio_1_1Event.html#a5af4a67915f2fe8aac76d3c20d3278bd">AddEntry</a> (google::protobuf::Message *entry, std::string tag="")</td></tr>
<tr class="separator:a5af4a67915f2fe8aac76d3c20d3278bd"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ad125f2420c84137d28b3588eccca3f51"><td class="memItemLeft" align="right" valign="top">google::protobuf::Message * </td><td class="memItemRight" valign="bottom"><a class="el" href="classproio_1_1Event.html#ad125f2420c84137d28b3588eccca3f51">GetEntry</a> (uint64_t id)</td></tr>
<tr class="separator:ad125f2420c84137d28b3588eccca3f51"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a05c1561e4d6d5f8f09c29673dbf4f562"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classproio_1_1Event.html#a05c1561e4d6d5f8f09c29673dbf4f562">TagEntry</a> (uint64_t id, std::string tag)</td></tr>
<tr class="separator:a05c1561e4d6d5f8f09c29673dbf4f562"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:afb7bf5604049ee70145083f36696e64b"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classproio_1_1Event.html#afb7bf5604049ee70145083f36696e64b">UntagEntry</a> (uint64_t id, std::string tag)</td></tr>
<tr class="separator:afb7bf5604049ee70145083f36696e64b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:add17fcdfd3c2cb838a61a5d6bd0cf081"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classproio_1_1Event.html#add17fcdfd3c2cb838a61a5d6bd0cf081">RemoveEntry</a> (uint64_t id)</td></tr>
<tr class="separator:add17fcdfd3c2cb838a61a5d6bd0cf081"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aa821f55427caa3dc7dc5c750b662001a"><td class="memItemLeft" align="right" valign="top">std::vector< std::string > </td><td class="memItemRight" valign="bottom"><a class="el" href="classproio_1_1Event.html#aa821f55427caa3dc7dc5c750b662001a">Tags</a> ()</td></tr>
<tr class="separator:aa821f55427caa3dc7dc5c750b662001a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a0ace44e845b1265091bb6acb088db37f"><td class="memItemLeft" align="right" valign="top">std::vector< uint64_t > </td><td class="memItemRight" valign="bottom"><a class="el" href="classproio_1_1Event.html#a0ace44e845b1265091bb6acb088db37f">TaggedEntries</a> (std::string tag)</td></tr>
<tr class="separator:a0ace44e845b1265091bb6acb088db37f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a2a288aeb0ba97cf2edf49afb4b199d12"><td class="memItemLeft" align="right" valign="top">std::vector< uint64_t > </td><td class="memItemRight" valign="bottom"><a class="el" href="classproio_1_1Event.html#a2a288aeb0ba97cf2edf49afb4b199d12">AllEntries</a> ()</td></tr>
<tr class="separator:a2a288aeb0ba97cf2edf49afb4b199d12"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ab5abcb3172a9610ab9d61d0428018469"><td class="memItemLeft" align="right" valign="top">std::vector< std::string > </td><td class="memItemRight" valign="bottom"><a class="el" href="classproio_1_1Event.html#ab5abcb3172a9610ab9d61d0428018469">EntryTags</a> (uint64_t id)</td></tr>
<tr class="separator:ab5abcb3172a9610ab9d61d0428018469"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a4abc130312b7122525381feb4382168a"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classproio_1_1Event.html#a4abc130312b7122525381feb4382168a">DeleteTag</a> (std::string tag)</td></tr>
<tr class="separator:a4abc130312b7122525381feb4382168a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a70cbedb7555e195aa3405d7beba9cb84"><td class="memItemLeft" align="right" valign="top">google::protobuf::Message * </td><td class="memItemRight" valign="bottom"><a class="el" href="classproio_1_1Event.html#a70cbedb7555e195aa3405d7beba9cb84">Free</a> (const google::protobuf::Descriptor *desc)</td></tr>
<tr class="separator:a70cbedb7555e195aa3405d7beba9cb84"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aedcfe3ee3816c118806fa026e28d968b"><td class="memItemLeft" align="right" valign="top">std::map< std::string, std::shared_ptr< const std::string > > & </td><td class="memItemRight" valign="bottom"><a class="el" href="classproio_1_1Event.html#aedcfe3ee3816c118806fa026e28d968b">Metadata</a> ()</td></tr>
<tr class="separator:aedcfe3ee3816c118806fa026e28d968b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a5f105a5b3daddc3a893a44b8de445819"><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classproio_1_1Event.html#a5f105a5b3daddc3a893a44b8de445819">String</a> ()</td></tr>
<tr class="separator:a5f105a5b3daddc3a893a44b8de445819"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ad431d4416636e8b4aca9e52c8a47e6af"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classproio_1_1Event.html#ad431d4416636e8b4aca9e52c8a47e6af">SerializeToString</a> (std::string *output)</td></tr>
<tr class="separator:ad431d4416636e8b4aca9e52c8a47e6af"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a229a9449fcdb6e11f48b5ede14c046a6"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classproio_1_1Event.html#a229a9449fcdb6e11f48b5ede14c046a6">FlushCache</a> ()</td></tr>
<tr class="separator:a229a9449fcdb6e11f48b5ede14c046a6"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ae39cdc53bffb0741bfda9c5634b7018b"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classproio_1_1Event.html#ae39cdc53bffb0741bfda9c5634b7018b">Clear</a> ()</td></tr>
<tr class="separator:ae39cdc53bffb0741bfda9c5634b7018b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:adc674fb22935a805c530b323696882db"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classproio_1_1Event.html#adc674fb22935a805c530b323696882db">SetDescriptorPool</a> (const google::protobuf::DescriptorPool *pool=NULL)</td></tr>
<tr class="separator:adc674fb22935a805c530b323696882db"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:afb601c820bc1e5fd084ea68880626492"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classproio_1_1Event.html#afb601c820bc1e5fd084ea68880626492">UseGeneratedPool</a> (bool useGenPool=true)</td></tr>
<tr class="separator:afb601c820bc1e5fd084ea68880626492"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:af37245d358792cdef34ff4c76c74c022"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="af37245d358792cdef34ff4c76c74c022"></a>
<a class="el" href="classproio_1_1Event.html">Event</a> & </td><td class="memItemRight" valign="bottom"><b>operator=</b> (const <a class="el" href="classproio_1_1Event.html">Event</a> &event)</td></tr>
<tr class="separator:af37245d358792cdef34ff4c76c74c022"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="friends"></a>
Friends</h2></td></tr>
<tr class="memitem:ab699d593c3b9dee1ed8d700a93d70700"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab699d593c3b9dee1ed8d700a93d70700"></a>
class </td><td class="memItemRight" valign="bottom"><b>Writer</b></td></tr>
<tr class="separator:ab699d593c3b9dee1ed8d700a93d70700"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a35cb182752752c74a30050705acc3c06"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a35cb182752752c74a30050705acc3c06"></a>
class </td><td class="memItemRight" valign="bottom"><b>Reader</b></td></tr>
<tr class="separator:a35cb182752752c74a30050705acc3c06"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Class representing a single event </p>
<p>Definition at line <a class="el" href="event_8h_source.html#l00014">14</a> of file <a class="el" href="event_8h_source.html">event.h</a>.</p>
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
<a class="anchor" id="a5a40dd4708297f7031e29b39e039ae10"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Event::Event </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Default constructor </p>
<p>Definition at line <a class="el" href="event_8cc_source.html#l00011">11</a> of file <a class="el" href="event_8cc_source.html">event.cc</a>.</p>
</div>
</div>
<a class="anchor" id="a77ac77a367dd7382fa162aaa3f044b4d"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Event::Event </td>
<td>(</td>
<td class="paramtype">const std::string & </td>
<td class="paramname"><em>proto</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>This constructor initializes the event from the protobuf wire format. </p>
<p>Definition at line <a class="el" href="event_8cc_source.html#l00018">18</a> of file <a class="el" href="event_8cc_source.html">event.cc</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="a5af4a67915f2fe8aac76d3c20d3278bd"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint64_t Event::AddEntry </td>
<td>(</td>
<td class="paramtype">google::protobuf::Message * </td>
<td class="paramname"><em>entry</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">std::string </td>
<td class="paramname"><em>tag</em> = <code>""</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>AddEntry takes a tag and protobuf message entry and adds it to the <a class="el" href="classproio_1_1Event.html">Event</a>. The return value is a uint64_t ID number used to reference the added entry. Once the entry is added, it is owned by the <a class="el" href="classproio_1_1Event.html">Event</a> object. </p>
<p>Definition at line <a class="el" href="event_8cc_source.html#l00027">27</a> of file <a class="el" href="event_8cc_source.html">event.cc</a>.</p>
</div>
</div>
<a class="anchor" id="a2a288aeb0ba97cf2edf49afb4b199d12"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::vector< uint64_t > Event::AllEntries </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>AllEntries returns IDs for all entries in the event. </p>
<p>Definition at line <a class="el" href="event_8cc_source.html#l00120">120</a> of file <a class="el" href="event_8cc_source.html">event.cc</a>.</p>
</div>
</div>
<a class="anchor" id="ae39cdc53bffb0741bfda9c5634b7018b"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Event::Clear </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Clear prepares the <a class="el" href="classproio_1_1Event.html">Event</a> for data from a new event. </p>
<p>Definition at line <a class="el" href="event_8cc_source.html#l00191">191</a> of file <a class="el" href="event_8cc_source.html">event.cc</a>.</p>
</div>
</div>
<a class="anchor" id="a4abc130312b7122525381feb4382168a"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Event::DeleteTag </td>
<td>(</td>
<td class="paramtype">std::string </td>
<td class="paramname"><em>tag</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>DeleteTag removes a tag from the <a class="el" href="classproio_1_1Event.html">Event</a>. </p>
<p>Definition at line <a class="el" href="event_8cc_source.html#l00140">140</a> of file <a class="el" href="event_8cc_source.html">event.cc</a>.</p>
</div>
</div>
<a class="anchor" id="ab5abcb3172a9610ab9d61d0428018469"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::vector< std::string > Event::EntryTags </td>
<td>(</td>
<td class="paramtype">uint64_t </td>
<td class="paramname"><em>id</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>EntryTags performs a reverse lookup of tags that point to an entry. This is a relatively expensive search. </p>
<p>Definition at line <a class="el" href="event_8cc_source.html#l00127">127</a> of file <a class="el" href="event_8cc_source.html">event.cc</a>.</p>
</div>
</div>
<a class="anchor" id="a229a9449fcdb6e11f48b5ede14c046a6"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Event::FlushCache </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>FlushCache forces all event entries to be serialized. This is useful for putting the main serialization load into parallel threads before aggregating the events into an output stream. </p>
<p>Definition at line <a class="el" href="event_8cc_source.html#l00172">172</a> of file <a class="el" href="event_8cc_source.html">event.cc</a>.</p>
</div>
</div>
<a class="anchor" id="a70cbedb7555e195aa3405d7beba9cb84"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Message * Event::Free </td>
<td>(</td>
<td class="paramtype">const google::protobuf::Descriptor * </td>
<td class="paramname"><em>desc</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Free returns an allocated and cleared entry Message of the type described by the given Descriptor, or NULL if no already-allocated messages of this type are available. </p>
<p>Definition at line <a class="el" href="event_8cc_source.html#l00142">142</a> of file <a class="el" href="event_8cc_source.html">event.cc</a>.</p>
</div>
</div>
<a class="anchor" id="ad125f2420c84137d28b3588eccca3f51"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Message * Event::GetEntry </td>
<td>(</td>
<td class="paramtype">uint64_t </td>
<td class="paramname"><em>id</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>GetEntry takes an entry ID and returns the corresponding entry. The returned entries are still owned by the <a class="el" href="classproio_1_1Event.html">Event</a> object. If the entry does not exist, NULL is returned.</p>
<p>If the specified entry's type is one that is not known at compile time, GetEntry will attempt to create and return a dynamic protobuf Message using the information from the stream. </p>
<p>Definition at line <a class="el" href="event_8cc_source.html#l00043">43</a> of file <a class="el" href="event_8cc_source.html">event.cc</a>.</p>
</div>
</div>
<a class="anchor" id="aedcfe3ee3816c118806fa026e28d968b"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">std::map<std::string, std::shared_ptr<const std::string> >& proio::Event::Metadata </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Metadata returns a mapping from a string key to a pointer to a string that contains metadata associated with the <a class="el" href="classproio_1_1Event.html">Event</a> by a <a class="el" href="classproio_1_1Reader.html">Reader</a>. These metadata are all the entries received on the stream up to this <a class="el" href="classproio_1_1Event.html">Event</a>. </p>
<p>Definition at line <a class="el" href="event_8h_source.html#l00074">74</a> of file <a class="el" href="event_8h_source.html">event.h</a>.</p>
</div>
</div>
<a class="anchor" id="add17fcdfd3c2cb838a61a5d6bd0cf081"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Event::RemoveEntry </td>
<td>(</td>
<td class="paramtype">uint64_t </td>
<td class="paramname"><em>id</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>RemoveEntry removes an entry from the event. </p>
<p>Definition at line <a class="el" href="event_8cc_source.html#l00089">89</a> of file <a class="el" href="event_8cc_source.html">event.cc</a>.</p>
</div>
</div>
<a class="anchor" id="ad431d4416636e8b4aca9e52c8a47e6af"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool proio::Event::SerializeToString </td>
<td>(</td>
<td class="paramtype">std::string * </td>
<td class="paramname"><em>output</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>SerializeToString stores the event in the given string in protobuf wire format. </p>
<p>Definition at line <a class="el" href="event_8h_source.html#l00082">82</a> of file <a class="el" href="event_8h_source.html">event.h</a>.</p>
</div>
</div>
<a class="anchor" id="adc674fb22935a805c530b323696882db"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Event::SetDescriptorPool </td>
<td>(</td>
<td class="paramtype">const google::protobuf::DescriptorPool * </td>
<td class="paramname"><em>pool</em> = <code>NULL</code></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>SetDescriptorPool sets the protobuf DescriptorPool for the <a class="el" href="classproio_1_1Event.html">Event</a> to use to create dynamic protobuf Messages when the entry type is not available at compile time. This is automatically set using information from the stream if a <a class="el" href="classproio_1_1Reader.html">Reader</a> was used to create the event. </p>
<p>Definition at line <a class="el" href="event_8cc_source.html#l00205">205</a> of file <a class="el" href="event_8cc_source.html">event.cc</a>.</p>
</div>
</div>
<a class="anchor" id="a5f105a5b3daddc3a893a44b8de445819"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::string Event::String </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>String returns a human-readable string representing the event. </p>
<p>Definition at line <a class="el" href="event_8cc_source.html#l00152">152</a> of file <a class="el" href="event_8cc_source.html">event.cc</a>.</p>
</div>
</div>
<a class="anchor" id="a05c1561e4d6d5f8f09c29673dbf4f562"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Event::TagEntry </td>
<td>(</td>
<td class="paramtype">uint64_t </td>
<td class="paramname"><em>id</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">std::string </td>
<td class="paramname"><em>tag</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>TagEntry adds a tag to an entry that has already been added, identified by its ID. </p>
<p>Definition at line <a class="el" href="event_8cc_source.html#l00075">75</a> of file <a class="el" href="event_8cc_source.html">event.cc</a>.</p>
</div>
</div>
<a class="anchor" id="a0ace44e845b1265091bb6acb088db37f"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::vector< uint64_t > Event::TaggedEntries </td>
<td>(</td>
<td class="paramtype">std::string </td>
<td class="paramname"><em>tag</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>TaggedEntries tages a tag string and returns a list of entry IDs that the tag references. </p>
<p>Definition at line <a class="el" href="event_8cc_source.html#l00109">109</a> of file <a class="el" href="event_8cc_source.html">event.cc</a>.</p>
</div>
</div>
<a class="anchor" id="aa821f55427caa3dc7dc5c750b662001a"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::vector< std::string > Event::Tags </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Tags returns a list of tags that exist in the event. </p>
<p>Definition at line <a class="el" href="event_8cc_source.html#l00100">100</a> of file <a class="el" href="event_8cc_source.html">event.cc</a>.</p>
</div>
</div>
<a class="anchor" id="afb7bf5604049ee70145083f36696e64b"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Event::UntagEntry </td>
<td>(</td>
<td class="paramtype">uint64_t </td>
<td class="paramname"><em>id</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">std::string </td>
<td class="paramname"><em>tag</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>UntagEntry removes a tag from a specified entry. </p>
<p>Definition at line <a class="el" href="event_8cc_source.html#l00077">77</a> of file <a class="el" href="event_8cc_source.html">event.cc</a>.</p>
</div>
</div>
<a class="anchor" id="afb601c820bc1e5fd084ea68880626492"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Event::UseGeneratedPool </td>
<td>(</td>
<td class="paramtype">bool </td>
<td class="paramname"><em>useGenPool</em> = <code>true</code></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>UseGeneratedPool can be used to disable this <a class="el" href="classproio_1_1Event.html">Event</a>'s use of the protobuf generated pool. By default, the event will first try to use the protobuf generated pool when GetEntry is called. If this method is called with an argument of false, GetEntry will always attempt to create dynamic protobuf Messages from a pool either set by a <a class="el" href="classproio_1_1Reader.html">Reader</a> or by SetDescriptorPool. This is for testing purposes and can also to be used to gain access to new data model fields. </p>
<p>Definition at line <a class="el" href="event_8cc_source.html#l00212">212</a> of file <a class="el" href="event_8cc_source.html">event.cc</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li>/home/travis/build/proio-org/cpp-proio/src/<a class="el" href="event_8h_source.html">event.h</a></li>
<li>/home/travis/build/proio-org/cpp-proio/src/<a class="el" href="event_8cc_source.html">event.cc</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.11
</small></address>
</body>
</html>