-
Notifications
You must be signed in to change notification settings - Fork 0
/
index.html
2072 lines (1729 loc) · 175 KB
/
index.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
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
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<!DOCTYPE html>
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>Welcome to RFID-transceiver’s API reference! — RFID-transceiver 1.0 documentation</title>
<script type="text/javascript" src="static/js/modernizr.min.js"></script>
<script type="text/javascript" id="documentation_options" data-url_root="./" src="static/documentation_options.js"></script>
<script src="static/jquery.js"></script>
<script src="static/underscore.js"></script>
<script src="static/doctools.js"></script>
<script src="static/language_data.js"></script>
<script type="text/javascript" src="static/js/theme.js"></script>
<link rel="stylesheet" href="static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="static/pygments.css" type="text/css" />
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
</head>
<body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >
<a href="#" class="icon icon-home"> RFID-transceiver
</a>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
<input type="text" name="q" placeholder="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
<!-- Local TOC -->
<div class="local-toc"><ul>
<li><a class="reference internal" href="#">Welcome to RFID-transceiver’s API reference!</a></li>
<li><a class="reference internal" href="#indices-and-tables">Indices and tables</a></li>
</ul>
</div>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" aria-label="top navigation">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="#">RFID-transceiver</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
<li><a href="#">Docs</a> »</li>
<li>Welcome to RFID-transceiver’s API reference!</li>
<li class="wy-breadcrumbs-aside">
<a href="sources/index.rst.txt" rel="nofollow"> View page source</a>
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<div class="section" id="welcome-to-rfid-transceiver-s-api-reference">
<h1>Welcome to RFID-transceiver’s API reference!<a class="headerlink" href="#welcome-to-rfid-transceiver-s-api-reference" title="Permalink to this headline">¶</a></h1>
<dl class="cpp class">
<dt id="_CPPv46config">
<span id="_CPPv36config"></span><span id="_CPPv26config"></span><span id="config"></span><span class="target" id="classconfig"></span><em class="property">class </em><code class="sig-name descname">config</code><a class="headerlink" href="#_CPPv46config" title="Permalink to this definition">¶</a><br /></dt>
<dd><em>#include <config.hpp></em><p>The configuration class of the component. </p>
<div class="breathe-sectiondef docutils container">
<p class="breathe-sectiondef-title rubric">Public Functions</p>
<dl class="cpp function">
<dt id="_CPPv4N6config6configEv">
<span id="_CPPv3N6config6configEv"></span><span id="_CPPv2N6config6configEv"></span><span id="config::config"></span><span class="target" id="classconfig_1ab1b245308f26ce7979e4c37e93869706"></span><code class="sig-name descname">config</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N6config6configEv" title="Permalink to this definition">¶</a><br /></dt>
<dd><p>The default constructor. </p>
</dd></dl>
<dl class="cpp function">
<dt id="_CPPv4N6config3runEv">
<span id="_CPPv3N6config3runEv"></span><span id="_CPPv2N6config3runEv"></span><span id="config::run"></span><span class="target" id="classconfig_1a7d4ca52ffcc22c01406e93f1fa78ab8b"></span>bool <code class="sig-name descname">run</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N6config3runEv" title="Permalink to this definition">¶</a><br /></dt>
<dd><p>Provides information on whether the configuration terminal is currently running or not. <dl class="simple">
<dt><strong>Return</strong></dt><dd><p>true if configuration terminal is currently running, false otherwise. </p>
</dd>
</dl>
</dd></dl>
<dl class="cpp function">
<dt id="_CPPv4N6config4quitEv">
<span id="_CPPv3N6config4quitEv"></span><span id="_CPPv2N6config4quitEv"></span><span id="config::quit"></span><span class="target" id="classconfig_1a1d32e187280bf2d0ad8478a47ab94e1d"></span>void <code class="sig-name descname">quit</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N6config4quitEv" title="Permalink to this definition">¶</a><br /></dt>
<dd><p>Sets execution flag to flag to false thus terminating the execution of the configuration terminal. </p>
</dd></dl>
<dl class="cpp function">
<dt id="_CPPv4N6config9is_rotateEv">
<span id="_CPPv3N6config9is_rotateEv"></span><span id="_CPPv2N6config9is_rotateEv"></span><span id="config::is_rotate"></span><span class="target" id="classconfig_1a9f0480100094705922a3202f2ff45cfd"></span>bool <code class="sig-name descname">is_rotate</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N6config9is_rotateEv" title="Permalink to this definition">¶</a><br /></dt>
<dd><p>Provides information on whether protocol rotation is enabled or not (feature not implemented yet). <dl class="simple">
<dt><strong>Return</strong></dt><dd><p>true if protocol rotation is enabled, false otherwise. </p>
</dd>
</dl>
</dd></dl>
<dl class="cpp function">
<dt id="_CPPv4N6config15get_location_idEv">
<span id="_CPPv3N6config15get_location_idEv"></span><span id="_CPPv2N6config15get_location_idEv"></span><span id="config::get_location_id"></span><span class="target" id="classconfig_1a7756837bde889417fe38b68e8da1bd9d"></span>std::string <code class="sig-name descname">get_location_id</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N6config15get_location_idEv" title="Permalink to this definition">¶</a><br /></dt>
<dd><p>Provides the current location id, i.e. physical location the rfid transceiver is deployed at. <dl class="simple">
<dt><strong>Return</strong></dt><dd><p>the location id. </p>
</dd>
</dl>
</dd></dl>
<dl class="cpp function">
<dt id="_CPPv4N6config18get_rfid_reader_idEv">
<span id="_CPPv3N6config18get_rfid_reader_idEv"></span><span id="_CPPv2N6config18get_rfid_reader_idEv"></span><span id="config::get_rfid_reader_id"></span><span class="target" id="classconfig_1ad51ea11e66475a866b8f1c999e4628ee"></span>std::string <code class="sig-name descname">get_rfid_reader_id</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N6config18get_rfid_reader_idEv" title="Permalink to this definition">¶</a><br /></dt>
<dd><p>Provides the current rfid transceiver id, i.e. the unique id of the rfid transceiver. <dl class="simple">
<dt><strong>Return</strong></dt><dd><p>the location id. </p>
</dd>
</dl>
</dd></dl>
<dl class="cpp function">
<dt id="_CPPv4N6config17get_rfid_protocolEv">
<span id="_CPPv3N6config17get_rfid_protocolEv"></span><span id="_CPPv2N6config17get_rfid_protocolEv"></span><span id="config::get_rfid_protocol"></span><span class="target" id="classconfig_1a5c835a529c89fee4c8fed28e7651afc1"></span>std::string <code class="sig-name descname">get_rfid_protocol</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N6config17get_rfid_protocolEv" title="Permalink to this definition">¶</a><br /></dt>
<dd><p>Provides the currently active rfid protocol (only one protocol currently implemented) in a user friendly format, i.e. 15693 for ISO / IEEE 15693. <dl class="simple">
<dt><strong>Return</strong></dt><dd><p>the currently active rfid protocol. </p>
</dd>
</dl>
</dd></dl>
<dl class="cpp function">
<dt id="_CPPv4N6config15get_rfid_rotateERNSt6vectorINSt6stringEEE">
<span id="_CPPv3N6config15get_rfid_rotateERNSt6vectorINSt6stringEEE"></span><span id="_CPPv2N6config15get_rfid_rotateERNSt6vectorINSt6stringEEE"></span><span id="config::get_rfid_rotate__std::vector:ss:R"></span><span class="target" id="classconfig_1a7a709a176a9d577205cbc4ceca134dce"></span>void <code class="sig-name descname">get_rfid_rotate</code><span class="sig-paren">(</span>std::vector<std::string> &<em>protocols</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N6config15get_rfid_rotateERNSt6vectorINSt6stringEEE" title="Permalink to this definition">¶</a><br /></dt>
<dd><p>Provides the rfid protocols currently set up for rotation (feature yet to be implemented) in the specified vector of strings. <dl class="simple">
<dt><strong>Parameters</strong></dt><dd><ul class="breatheparameterlist simple">
<li><p><code class="docutils literal notranslate"><span class="pre">protocols</span></code>: a reference to the vector of string to provide the protocols in. </p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="cpp function">
<dt id="_CPPv4N6config33get_rfid_select_protocol_confbitsEv">
<span id="_CPPv3N6config33get_rfid_select_protocol_confbitsEv"></span><span id="_CPPv2N6config33get_rfid_select_protocol_confbitsEv"></span><span id="config::get_rfid_select_protocol_confbits"></span><span class="target" id="classconfig_1a4525c77aeca1db6b214adb15d1c5891e"></span>std::string <code class="sig-name descname">get_rfid_select_protocol_confbits</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N6config33get_rfid_select_protocol_confbitsEv" title="Permalink to this definition">¶</a><br /></dt>
<dd><p>Provides the currently set configuration bits of the rfid transceiver for protocol selection. <dl class="simple">
<dt><strong>Return</strong></dt><dd><p>the protocol selection configurtion bits. </p>
</dd>
</dl>
</dd></dl>
<dl class="cpp function">
<dt id="_CPPv4N6config35get_rfid_select_parameters_confbitsEv">
<span id="_CPPv3N6config35get_rfid_select_parameters_confbitsEv"></span><span id="_CPPv2N6config35get_rfid_select_parameters_confbitsEv"></span><span id="config::get_rfid_select_parameters_confbits"></span><span class="target" id="classconfig_1a2ca75c4bfb2276acd6c2973fcdd450b6"></span>std::string <code class="sig-name descname">get_rfid_select_parameters_confbits</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N6config35get_rfid_select_parameters_confbitsEv" title="Permalink to this definition">¶</a><br /></dt>
<dd><p>Provides the currently set configuration bits of the rfid transceiver passed as parameters during protocol selection. <dl class="simple">
<dt><strong>Return</strong></dt><dd><p>the parameters of the protocol selection configurtion bits. </p>
</dd>
</dl>
</dd></dl>
<dl class="cpp function">
<dt id="_CPPv4N6config27get_rfid_send_data_confbitsEv">
<span id="_CPPv3N6config27get_rfid_send_data_confbitsEv"></span><span id="_CPPv2N6config27get_rfid_send_data_confbitsEv"></span><span id="config::get_rfid_send_data_confbits"></span><span class="target" id="classconfig_1abb6b5dc2e37f125a6067cb4871b9b6c9"></span>std::string <code class="sig-name descname">get_rfid_send_data_confbits</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N6config27get_rfid_send_data_confbitsEv" title="Permalink to this definition">¶</a><br /></dt>
<dd><p>Provides the currently set configuration bits of the rfid transceiver for data transfer between the transceiver board and the rfid tag. <dl class="simple">
<dt><strong>Return</strong></dt><dd><p>the data transfer configurtion bits. </p>
</dd>
</dl>
</dd></dl>
<dl class="cpp function">
<dt id="_CPPv4N6config11get_reg_uriEv">
<span id="_CPPv3N6config11get_reg_uriEv"></span><span id="_CPPv2N6config11get_reg_uriEv"></span><span id="config::get_reg_uri"></span><span class="target" id="classconfig_1aea817fca86df9c05fe50cc61ac0188dc"></span>std::string <code class="sig-name descname">get_reg_uri</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N6config11get_reg_uriEv" title="Permalink to this definition">¶</a><br /></dt>
<dd><p>Provides the currently set URI of the remote (or local) server to register tags with. <dl class="simple">
<dt><strong>Return</strong></dt><dd><p>the URI. </p>
</dd>
</dl>
</dd></dl>
<dl class="cpp function">
<dt id="_CPPv4N6config16get_reg_hostnameEv">
<span id="_CPPv3N6config16get_reg_hostnameEv"></span><span id="_CPPv2N6config16get_reg_hostnameEv"></span><span id="config::get_reg_hostname"></span><span class="target" id="classconfig_1a332a47dfc1af541b818b126990b03d3b"></span>std::string <code class="sig-name descname">get_reg_hostname</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N6config16get_reg_hostnameEv" title="Permalink to this definition">¶</a><br /></dt>
<dd><p>Provides the currently set hostname of the remote (or local) server to register tags with. <dl class="simple">
<dt><strong>Return</strong></dt><dd><p>the hostname. </p>
</dd>
</dl>
</dd></dl>
<dl class="cpp function">
<dt id="_CPPv4N6config12get_reg_pathEv">
<span id="_CPPv3N6config12get_reg_pathEv"></span><span id="_CPPv2N6config12get_reg_pathEv"></span><span id="config::get_reg_path"></span><span class="target" id="classconfig_1a24f0b374b892ef5de0ef61084cb43c36"></span>std::string <code class="sig-name descname">get_reg_path</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N6config12get_reg_pathEv" title="Permalink to this definition">¶</a><br /></dt>
<dd><p>Provides the currently set URI path of the remote (or local) server to register tags with. <dl class="simple">
<dt><strong>Return</strong></dt><dd><p>the path of the URI. </p>
</dd>
</dl>
</dd></dl>
<dl class="cpp function">
<dt id="_CPPv4N6config12get_reg_portEv">
<span id="_CPPv3N6config12get_reg_portEv"></span><span id="_CPPv2N6config12get_reg_portEv"></span><span id="config::get_reg_port"></span><span class="target" id="classconfig_1a086023eb9faa98c18ec3d8ec225ced42"></span>std::string <code class="sig-name descname">get_reg_port</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N6config12get_reg_portEv" title="Permalink to this definition">¶</a><br /></dt>
<dd><p>Provides the currently set port of the remote (or local) server to register tags with. <dl class="simple">
<dt><strong>Return</strong></dt><dd><p>the port. </p>
</dd>
</dl>
</dd></dl>
<dl class="cpp function">
<dt id="_CPPv4N6config13get_unreg_uriEv">
<span id="_CPPv3N6config13get_unreg_uriEv"></span><span id="_CPPv2N6config13get_unreg_uriEv"></span><span id="config::get_unreg_uri"></span><span class="target" id="classconfig_1ae9ef6271674d28e9e73d08571f7bf56e"></span>std::string <code class="sig-name descname">get_unreg_uri</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N6config13get_unreg_uriEv" title="Permalink to this definition">¶</a><br /></dt>
<dd><p>Provides the currently set URI of the remote (or local) server to unregister tags with. <dl class="simple">
<dt><strong>Return</strong></dt><dd><p>the URI. </p>
</dd>
</dl>
</dd></dl>
<dl class="cpp function">
<dt id="_CPPv4N6config18get_unreg_hostnameEv">
<span id="_CPPv3N6config18get_unreg_hostnameEv"></span><span id="_CPPv2N6config18get_unreg_hostnameEv"></span><span id="config::get_unreg_hostname"></span><span class="target" id="classconfig_1a01077468bd9c932724c40ff93f26e5bc"></span>std::string <code class="sig-name descname">get_unreg_hostname</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N6config18get_unreg_hostnameEv" title="Permalink to this definition">¶</a><br /></dt>
<dd><p>Provides the currently set hostname of the remote (or local) server to unregister tags with. <dl class="simple">
<dt><strong>Return</strong></dt><dd><p>the hostname. </p>
</dd>
</dl>
</dd></dl>
<dl class="cpp function">
<dt id="_CPPv4N6config14get_unreg_pathEv">
<span id="_CPPv3N6config14get_unreg_pathEv"></span><span id="_CPPv2N6config14get_unreg_pathEv"></span><span id="config::get_unreg_path"></span><span class="target" id="classconfig_1a8f62b0bb3cd33a601ba416cec47bfb4e"></span>std::string <code class="sig-name descname">get_unreg_path</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N6config14get_unreg_pathEv" title="Permalink to this definition">¶</a><br /></dt>
<dd><p>Provides the currently set URI path of the remote (or local) server to unregister tags with. <dl class="simple">
<dt><strong>Return</strong></dt><dd><p>the path of the URI. </p>
</dd>
</dl>
</dd></dl>
<dl class="cpp function">
<dt id="_CPPv4N6config14get_unreg_portEv">
<span id="_CPPv3N6config14get_unreg_portEv"></span><span id="_CPPv2N6config14get_unreg_portEv"></span><span id="config::get_unreg_port"></span><span class="target" id="classconfig_1a5bdbdc77176adbc1d5065333e0e0ade0"></span>std::string <code class="sig-name descname">get_unreg_port</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N6config14get_unreg_portEv" title="Permalink to this definition">¶</a><br /></dt>
<dd><p>Provides the currently set port of the remote (or local) server to unregister tags with. <dl class="simple">
<dt><strong>Return</strong></dt><dd><p>the port. </p>
</dd>
</dl>
</dd></dl>
<dl class="cpp function">
<dt id="_CPPv4N6config14get_scan_delayEv">
<span id="_CPPv3N6config14get_scan_delayEv"></span><span id="_CPPv2N6config14get_scan_delayEv"></span><span id="config::get_scan_delay"></span><span class="target" id="classconfig_1a54c3f7d1693b7131a17846581cf96f6f"></span>std::string <code class="sig-name descname">get_scan_delay</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N6config14get_scan_delayEv" title="Permalink to this definition">¶</a><br /></dt>
<dd><p>Provides the currently set scan delay of the rfid transceiver board. <dl class="simple">
<dt><strong>Return</strong></dt><dd><p>the delay inbetween scans. </p>
</dd>
</dl>
</dd></dl>
<dl class="cpp function">
<dt id="_CPPv4N6config16get_time_to_liveEv">
<span id="_CPPv3N6config16get_time_to_liveEv"></span><span id="_CPPv2N6config16get_time_to_liveEv"></span><span id="config::get_time_to_live"></span><span class="target" id="classconfig_1a16140d2e3fb675bf1d9898bdb6e06299"></span>std::string <code class="sig-name descname">get_time_to_live</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N6config16get_time_to_liveEv" title="Permalink to this definition">¶</a><br /></dt>
<dd><p>Provides the currently set “time to live” for a registered rfid tag. <dl class="simple">
<dt><strong>Return</strong></dt><dd><p>the time to live of a tag. </p>
</dd>
</dl>
</dd></dl>
<dl class="cpp function">
<dt id="_CPPv4N6config10get_repeatEv">
<span id="_CPPv3N6config10get_repeatEv"></span><span id="_CPPv2N6config10get_repeatEv"></span><span id="config::get_repeat"></span><span class="target" id="classconfig_1a2da18e8683e3cd5dea4f9623dd3c4fee"></span>std::string <code class="sig-name descname">get_repeat</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N6config10get_repeatEv" title="Permalink to this definition">¶</a><br /></dt>
<dd><p>Provides the currently set number of repetitive scan attempts of the rfid transceiver board. <dl class="simple">
<dt><strong>Return</strong></dt><dd><p>the delay inbetween scans. </p>
</dd>
</dl>
</dd></dl>
<dl class="cpp function">
<dt id="_CPPv4N6config15get_sim_seed_noEv">
<span id="_CPPv3N6config15get_sim_seed_noEv"></span><span id="_CPPv2N6config15get_sim_seed_noEv"></span><span id="config::get_sim_seed_no"></span><span class="target" id="classconfig_1a850a5155c8ba37c895ac56afc35ab26e"></span>std::string <code class="sig-name descname">get_sim_seed_no</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N6config15get_sim_seed_noEv" title="Permalink to this definition">¶</a><br /></dt>
<dd><p>Provides the currently set seed number of the simulator. <dl class="simple">
<dt><strong>Return</strong></dt><dd><p>the seed number. </p>
</dd>
</dl>
</dd></dl>
<dl class="cpp function">
<dt id="_CPPv4N6config15set_location_idENSt6stringE">
<span id="_CPPv3N6config15set_location_idENSt6stringE"></span><span id="_CPPv2N6config15set_location_idENSt6stringE"></span><span id="config::set_location_id__ss"></span><span class="target" id="classconfig_1a5527544496f281ef75379c03c6218a5f"></span>void <code class="sig-name descname">set_location_id</code><span class="sig-paren">(</span>std::string <em>loc_id</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N6config15set_location_idENSt6stringE" title="Permalink to this definition">¶</a><br /></dt>
<dd><p>Set the current location id. <dl class="simple">
<dt><strong>Parameters</strong></dt><dd><ul class="breatheparameterlist simple">
<li><p><code class="docutils literal notranslate"><span class="pre">loc_id</span></code>: location id to be set. </p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="cpp function">
<dt id="_CPPv4N6config18set_rfid_reader_idENSt6stringE">
<span id="_CPPv3N6config18set_rfid_reader_idENSt6stringE"></span><span id="_CPPv2N6config18set_rfid_reader_idENSt6stringE"></span><span id="config::set_rfid_reader_id__ss"></span><span class="target" id="classconfig_1ae5a53a878b93f8204d9170d0c622748b"></span>void <code class="sig-name descname">set_rfid_reader_id</code><span class="sig-paren">(</span>std::string <em>rfid_id</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N6config18set_rfid_reader_idENSt6stringE" title="Permalink to this definition">¶</a><br /></dt>
<dd><p>Set the current unique id of the rfid transceiver board. <dl class="simple">
<dt><strong>Parameters</strong></dt><dd><ul class="breatheparameterlist simple">
<li><p><code class="docutils literal notranslate"><span class="pre">rfid_id</span></code>: rfid transceiver board id to be set. </p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="cpp function">
<dt id="_CPPv4N6config17set_rfid_protocolENSt6stringE">
<span id="_CPPv3N6config17set_rfid_protocolENSt6stringE"></span><span id="_CPPv2N6config17set_rfid_protocolENSt6stringE"></span><span id="config::set_rfid_protocol__ss"></span><span class="target" id="classconfig_1a3e6dd981acfd77e411cac01978e11420"></span>void <code class="sig-name descname">set_rfid_protocol</code><span class="sig-paren">(</span>std::string <em>protocol</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N6config17set_rfid_protocolENSt6stringE" title="Permalink to this definition">¶</a><br /></dt>
<dd><p>Set the current rfid protocol of the rfid transceiver board protocol (only one protocol implemented currently). <dl class="simple">
<dt><strong>Parameters</strong></dt><dd><ul class="breatheparameterlist simple">
<li><p><code class="docutils literal notranslate"><span class="pre">protocol</span></code>: protocol to be set in reader friendly format, i.e. 15693. </p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="cpp function">
<dt id="_CPPv4N6config15set_rfid_rotateENSt6vectorINSt6stringEEE">
<span id="_CPPv3N6config15set_rfid_rotateENSt6vectorINSt6stringEEE"></span><span id="_CPPv2N6config15set_rfid_rotateENSt6vectorINSt6stringEEE"></span><span id="config::set_rfid_rotate__std::vector:ss:"></span><span class="target" id="classconfig_1a80c12ebcbeade8095d680eb94cdfdb25"></span>void <code class="sig-name descname">set_rfid_rotate</code><span class="sig-paren">(</span>std::vector<std::string> <em>protocols</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N6config15set_rfid_rotateENSt6vectorINSt6stringEEE" title="Permalink to this definition">¶</a><br /></dt>
<dd><p>Set the current rfid protocols to be rotated (feature yet to be implemented). <dl class="simple">
<dt><strong>Parameters</strong></dt><dd><ul class="breatheparameterlist simple">
<li><p><code class="docutils literal notranslate"><span class="pre">protocols</span></code>: a veector of strings holding the rfid protocols to be rotated in the correct order, in human friendly format, i.e. {“15693”, “14443B”}. </p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="cpp function">
<dt id="_CPPv4N6config20set_transmission_uriENSt6stringE">
<span id="_CPPv3N6config20set_transmission_uriENSt6stringE"></span><span id="_CPPv2N6config20set_transmission_uriENSt6stringE"></span><span id="config::set_transmission_uri__ss"></span><span class="target" id="classconfig_1aaa2f1b21e325bbd80294188eab847834"></span>void <code class="sig-name descname">set_transmission_uri</code><span class="sig-paren">(</span>std::string <em>url</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N6config20set_transmission_uriENSt6stringE" title="Permalink to this definition">¶</a><br /></dt>
<dd><p>Set the current transmission URI. <dl class="simple">
<dt><strong>Parameters</strong></dt><dd><ul class="breatheparameterlist simple">
<li><p><code class="docutils literal notranslate"><span class="pre">url</span></code>: the URI to be set. </p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="cpp function">
<dt id="_CPPv4N6config14set_scan_delayENSt6stringE">
<span id="_CPPv3N6config14set_scan_delayENSt6stringE"></span><span id="_CPPv2N6config14set_scan_delayENSt6stringE"></span><span id="config::set_scan_delay__ss"></span><span class="target" id="classconfig_1affb6379146fab96537f8cdb6915adbe0"></span>void <code class="sig-name descname">set_scan_delay</code><span class="sig-paren">(</span>std::string <em>delay</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N6config14set_scan_delayENSt6stringE" title="Permalink to this definition">¶</a><br /></dt>
<dd><p>Set the current scan delay of the rfid transceiver board. <dl class="simple">
<dt><strong>Parameters</strong></dt><dd><ul class="breatheparameterlist simple">
<li><p><code class="docutils literal notranslate"><span class="pre">delay</span></code>: the scan delay to be set. </p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="cpp function">
<dt id="_CPPv4N6config10set_repeatENSt6stringE">
<span id="_CPPv3N6config10set_repeatENSt6stringE"></span><span id="_CPPv2N6config10set_repeatENSt6stringE"></span><span id="config::set_repeat__ss"></span><span class="target" id="classconfig_1a5f0520e3f5d766451f5a542c407c264c"></span>void <code class="sig-name descname">set_repeat</code><span class="sig-paren">(</span>std::string <em>repeat</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N6config10set_repeatENSt6stringE" title="Permalink to this definition">¶</a><br /></dt>
<dd><p>Set the number of repetitive scan attempts of the rfid transceiver board. <dl class="simple">
<dt><strong>Parameters</strong></dt><dd><ul class="breatheparameterlist simple">
<li><p><code class="docutils literal notranslate"><span class="pre">repeat</span></code>: the number of scan attempts. </p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="cpp function">
<dt id="_CPPv4N6config15set_sim_seed_noENSt6stringE">
<span id="_CPPv3N6config15set_sim_seed_noENSt6stringE"></span><span id="_CPPv2N6config15set_sim_seed_noENSt6stringE"></span><span id="config::set_sim_seed_no__ss"></span><span class="target" id="classconfig_1a09a89e98d0a5c549b4b109af1f6689d3"></span>void <code class="sig-name descname">set_sim_seed_no</code><span class="sig-paren">(</span>std::string <em>seed_no</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N6config15set_sim_seed_noENSt6stringE" title="Permalink to this definition">¶</a><br /></dt>
<dd><p>Set the current seed number of the simulator. <dl class="simple">
<dt><strong>Parameters</strong></dt><dd><ul class="breatheparameterlist simple">
<li><p><code class="docutils literal notranslate"><span class="pre">seed_no</span></code>: the seed number to be set. </p></li>
</ul>
</dd>
</dl>
</dd></dl>
</div>
<div class="breathe-sectiondef docutils container">
<p class="breathe-sectiondef-title rubric">Private Members</p>
<dl class="cpp var">
<dt id="_CPPv4N6config2idE">
<span id="_CPPv3N6config2idE"></span><span id="_CPPv2N6config2idE"></span><span id="config::id__config_id"></span><span class="target" id="classconfig_1acf604ae4b3cda34756b9e235fa8e9ea0"></span><a class="reference internal" href="#_CPPv49config_id" title="config_id">config_id</a> <code class="sig-name descname">id</code><a class="headerlink" href="#_CPPv4N6config2idE" title="Permalink to this definition">¶</a><br /></dt>
<dd></dd></dl>
<dl class="cpp var">
<dt id="_CPPv4N6config8transmitE">
<span id="_CPPv3N6config8transmitE"></span><span id="_CPPv2N6config8transmitE"></span><span id="config::transmit__config_url"></span><span class="target" id="classconfig_1a376ac7b1492eeb45a88e9e3f14dc4829"></span><a class="reference internal" href="#_CPPv410config_url" title="config_url">config_url</a> <code class="sig-name descname">transmit</code><a class="headerlink" href="#_CPPv4N6config8transmitE" title="Permalink to this definition">¶</a><br /></dt>
<dd></dd></dl>
<dl class="cpp var">
<dt id="_CPPv4N6config6readerE">
<span id="_CPPv3N6config6readerE"></span><span id="_CPPv2N6config6readerE"></span><span id="config::reader__config_reader"></span><span class="target" id="classconfig_1a0e493cb853eca34f377faadf67b4b00f"></span><a class="reference internal" href="#_CPPv413config_reader" title="config_reader">config_reader</a> <code class="sig-name descname">reader</code><a class="headerlink" href="#_CPPv4N6config6readerE" title="Permalink to this definition">¶</a><br /></dt>
<dd></dd></dl>
<dl class="cpp var">
<dt id="_CPPv4N6config4confE">
<span id="_CPPv3N6config4confE"></span><span id="_CPPv2N6config4confE"></span><span id="config::conf__config_bitconf"></span><span class="target" id="classconfig_1a1e5ae38a99f687d9ebf9c1ff66841dd1"></span><a class="reference internal" href="#_CPPv414config_bitconf" title="config_bitconf">config_bitconf</a> <code class="sig-name descname">conf</code><a class="headerlink" href="#_CPPv4N6config4confE" title="Permalink to this definition">¶</a><br /></dt>
<dd></dd></dl>
<dl class="cpp var">
<dt id="_CPPv4N6config3simE">
<span id="_CPPv3N6config3simE"></span><span id="_CPPv2N6config3simE"></span><span id="config::sim__config_sim"></span><span class="target" id="classconfig_1a6eee3dbaf60d27488af9a802934ec5b6"></span><a class="reference internal" href="#_CPPv410config_sim" title="config_sim">config_sim</a> <code class="sig-name descname">sim</code><a class="headerlink" href="#_CPPv4N6config3simE" title="Permalink to this definition">¶</a><br /></dt>
<dd></dd></dl>
<dl class="cpp var">
<dt id="_CPPv4N6config6statusE">
<span id="_CPPv3N6config6statusE"></span><span id="_CPPv2N6config6statusE"></span><span id="config::status__b"></span><span class="target" id="classconfig_1ac6ba8f1229955d959d4813cfb627b3f8"></span>bool <code class="sig-name descname">status</code><a class="headerlink" href="#_CPPv4N6config6statusE" title="Permalink to this definition">¶</a><br /></dt>
<dd></dd></dl>
</div>
</dd></dl>
<dl class="cpp struct">
<dt id="_CPPv414config_bitconf">
<span id="_CPPv314config_bitconf"></span><span id="_CPPv214config_bitconf"></span><span id="config_bitconf"></span><span class="target" id="structconfig__bitconf"></span><em class="property">struct </em><code class="sig-name descname">config_bitconf</code><a class="headerlink" href="#_CPPv414config_bitconf" title="Permalink to this definition">¶</a><br /></dt>
<dd><div class="breathe-sectiondef docutils container">
<p class="breathe-sectiondef-title rubric">Public Members</p>
<dl class="cpp var">
<dt id="_CPPv4N14config_bitconf15select_protocolE">
<span id="_CPPv3N14config_bitconf15select_protocolE"></span><span id="_CPPv2N14config_bitconf15select_protocolE"></span><span id="config_bitconf::select_protocol__ss"></span><span class="target" id="structconfig__bitconf_1a67232dbd03531e94d54fab90f3045959"></span>std::string <code class="sig-name descname">select_protocol</code><a class="headerlink" href="#_CPPv4N14config_bitconf15select_protocolE" title="Permalink to this definition">¶</a><br /></dt>
<dd><p>Configuration bits for the actual protocol during the select protocol process. </p>
</dd></dl>
<dl class="cpp var">
<dt id="_CPPv4N14config_bitconf17select_parametersE">
<span id="_CPPv3N14config_bitconf17select_parametersE"></span><span id="_CPPv2N14config_bitconf17select_parametersE"></span><span id="config_bitconf::select_parameters__ss"></span><span class="target" id="structconfig__bitconf_1af836741ae0789f097cab519de32c4026"></span>std::string <code class="sig-name descname">select_parameters</code><a class="headerlink" href="#_CPPv4N14config_bitconf17select_parametersE" title="Permalink to this definition">¶</a><br /></dt>
<dd><p>Configuration bits for the parameters passed during the select protocol process. </p>
</dd></dl>
<dl class="cpp var">
<dt id="_CPPv4N14config_bitconf9send_dataE">
<span id="_CPPv3N14config_bitconf9send_dataE"></span><span id="_CPPv2N14config_bitconf9send_dataE"></span><span id="config_bitconf::send_data__ss"></span><span class="target" id="structconfig__bitconf_1ab980afc20d86a888da6f9fd9c25dde57"></span>std::string <code class="sig-name descname">send_data</code><a class="headerlink" href="#_CPPv4N14config_bitconf9send_dataE" title="Permalink to this definition">¶</a><br /></dt>
<dd><p>Configuration bits for the data transfer process between the rfid transceiver board and the rfid tag. </p>
</dd></dl>
</div>
</dd></dl>
<dl class="cpp struct">
<dt id="_CPPv49config_id">
<span id="_CPPv39config_id"></span><span id="_CPPv29config_id"></span><span id="config_id"></span><span class="target" id="structconfig__id"></span><em class="property">struct </em><code class="sig-name descname">config_id</code><a class="headerlink" href="#_CPPv49config_id" title="Permalink to this definition">¶</a><br /></dt>
<dd><div class="breathe-sectiondef docutils container">
<p class="breathe-sectiondef-title rubric">Public Members</p>
<dl class="cpp var">
<dt id="_CPPv4N9config_id11location_idE">
<span id="_CPPv3N9config_id11location_idE"></span><span id="_CPPv2N9config_id11location_idE"></span><span id="config_id::location_id__ss"></span><span class="target" id="structconfig__id_1a05b88eef52112546568cadb48b6624d9"></span>std::string <code class="sig-name descname">location_id</code><a class="headerlink" href="#_CPPv4N9config_id11location_idE" title="Permalink to this definition">¶</a><br /></dt>
<dd><p>Location id of the physical location where the rfid transceiver board is deployed. </p>
</dd></dl>
<dl class="cpp var">
<dt id="_CPPv4N9config_id14rfid_reader_idE">
<span id="_CPPv3N9config_id14rfid_reader_idE"></span><span id="_CPPv2N9config_id14rfid_reader_idE"></span><span id="config_id::rfid_reader_id__ss"></span><span class="target" id="structconfig__id_1ae19aa7108b0bcd0139d7566a39673ded"></span>std::string <code class="sig-name descname">rfid_reader_id</code><a class="headerlink" href="#_CPPv4N9config_id14rfid_reader_idE" title="Permalink to this definition">¶</a><br /></dt>
<dd><p>Unique id for this specific rfid transceiver board. </p>
</dd></dl>
</div>
</dd></dl>
<dl class="cpp struct">
<dt id="_CPPv413config_reader">
<span id="_CPPv313config_reader"></span><span id="_CPPv213config_reader"></span><span id="config_reader"></span><span class="target" id="structconfig__reader"></span><em class="property">struct </em><code class="sig-name descname">config_reader</code><a class="headerlink" href="#_CPPv413config_reader" title="Permalink to this definition">¶</a><br /></dt>
<dd><div class="breathe-sectiondef docutils container">
<p class="breathe-sectiondef-title rubric">Public Members</p>
<dl class="cpp var">
<dt id="_CPPv4N13config_reader8protocolE">
<span id="_CPPv3N13config_reader8protocolE"></span><span id="_CPPv2N13config_reader8protocolE"></span><span id="config_reader::protocol__ss"></span><span class="target" id="structconfig__reader_1ad943d61b9de34b8ad101853265ede4cc"></span>std::string <code class="sig-name descname">protocol</code><a class="headerlink" href="#_CPPv4N13config_reader8protocolE" title="Permalink to this definition">¶</a><br /></dt>
<dd><p>Protocol of the rfid transceiver board in human friendly format. </p>
</dd></dl>
<dl class="cpp var">
<dt id="_CPPv4N13config_reader6rotateE">
<span id="_CPPv3N13config_reader6rotateE"></span><span id="_CPPv2N13config_reader6rotateE"></span><span id="config_reader::rotate__std::vector:ss:"></span><span class="target" id="structconfig__reader_1ac45faecd1b8d0cf35ab7ec928333fb58"></span>std::vector<std::string> <code class="sig-name descname">rotate</code><a class="headerlink" href="#_CPPv4N13config_reader6rotateE" title="Permalink to this definition">¶</a><br /></dt>
<dd><p>Protocols for the rfid transceiver board to rotate in human friendly format (feature yet to be implemented). </p>
</dd></dl>
<dl class="cpp var">
<dt id="_CPPv4N13config_reader15rotate_protocolE">
<span id="_CPPv3N13config_reader15rotate_protocolE"></span><span id="_CPPv2N13config_reader15rotate_protocolE"></span><span id="config_reader::rotate_protocol__b"></span><span class="target" id="structconfig__reader_1aea8c86a386db69072ed97a080c20a26f"></span>bool <code class="sig-name descname">rotate_protocol</code><a class="headerlink" href="#_CPPv4N13config_reader15rotate_protocolE" title="Permalink to this definition">¶</a><br /></dt>
<dd><p>Flag for whether protocol rotation is enabled or not. </p>
</dd></dl>
<dl class="cpp var">
<dt id="_CPPv4N13config_reader10scan_delayE">
<span id="_CPPv3N13config_reader10scan_delayE"></span><span id="_CPPv2N13config_reader10scan_delayE"></span><span id="config_reader::scan_delay__ss"></span><span class="target" id="structconfig__reader_1acc50db559edb34e3bbab5ade29906300"></span>std::string <code class="sig-name descname">scan_delay</code><a class="headerlink" href="#_CPPv4N13config_reader10scan_delayE" title="Permalink to this definition">¶</a><br /></dt>
<dd><p>Scan delay of the rfid transceiver board. </p>
</dd></dl>
<dl class="cpp var">
<dt id="_CPPv4N13config_reader12time_to_liveE">
<span id="_CPPv3N13config_reader12time_to_liveE"></span><span id="_CPPv2N13config_reader12time_to_liveE"></span><span id="config_reader::time_to_live__ss"></span><span class="target" id="structconfig__reader_1ab0dabb7a0957db90b7afad37319c0be1"></span>std::string <code class="sig-name descname">time_to_live</code><a class="headerlink" href="#_CPPv4N13config_reader12time_to_liveE" title="Permalink to this definition">¶</a><br /></dt>
<dd><p>Time to live for the registered rfid tags in milliseconds. </p>
</dd></dl>
<dl class="cpp var">
<dt id="_CPPv4N13config_reader6repeatE">
<span id="_CPPv3N13config_reader6repeatE"></span><span id="_CPPv2N13config_reader6repeatE"></span><span id="config_reader::repeat__ss"></span><span class="target" id="structconfig__reader_1a7a84a559766359f75e19d667728163a2"></span>std::string <code class="sig-name descname">repeat</code><a class="headerlink" href="#_CPPv4N13config_reader6repeatE" title="Permalink to this definition">¶</a><br /></dt>
<dd><p>Number of repetetive scan attempts of the rfid transceiver board. </p>
</dd></dl>
</div>
</dd></dl>
<dl class="cpp struct">
<dt id="_CPPv410config_sim">
<span id="_CPPv310config_sim"></span><span id="_CPPv210config_sim"></span><span id="config_sim"></span><span class="target" id="structconfig__sim"></span><em class="property">struct </em><code class="sig-name descname">config_sim</code><a class="headerlink" href="#_CPPv410config_sim" title="Permalink to this definition">¶</a><br /></dt>
<dd><div class="breathe-sectiondef docutils container">
<p class="breathe-sectiondef-title rubric">Public Members</p>
<dl class="cpp var">
<dt id="_CPPv4N10config_sim7seed_noE">
<span id="_CPPv3N10config_sim7seed_noE"></span><span id="_CPPv2N10config_sim7seed_noE"></span><span id="config_sim::seed_no__ss"></span><span class="target" id="structconfig__sim_1ac86c9b6086f8f4ba9bb288587cce32f8"></span>std::string <code class="sig-name descname">seed_no</code><a class="headerlink" href="#_CPPv4N10config_sim7seed_noE" title="Permalink to this definition">¶</a><br /></dt>
<dd><p>Seed number used by the RNG of the simulator. </p>
</dd></dl>
</div>
</dd></dl>
<dl class="cpp class">
<dt id="_CPPv415config_terminal">
<span id="_CPPv315config_terminal"></span><span id="_CPPv215config_terminal"></span><span id="config_terminal"></span><span class="target" id="classconfig__terminal"></span><em class="property">class </em><code class="sig-name descname">config_terminal</code><a class="headerlink" href="#_CPPv415config_terminal" title="Permalink to this definition">¶</a><br /></dt>
<dd></dd></dl>
<dl class="cpp struct">
<dt id="_CPPv410config_url">
<span id="_CPPv310config_url"></span><span id="_CPPv210config_url"></span><span id="config_url"></span><span class="target" id="structconfig__url"></span><em class="property">struct </em><code class="sig-name descname">config_url</code><a class="headerlink" href="#_CPPv410config_url" title="Permalink to this definition">¶</a><br /></dt>
<dd><div class="breathe-sectiondef docutils container">
<p class="breathe-sectiondef-title rubric">Public Members</p>
<dl class="cpp var">
<dt id="_CPPv4N10config_url12reg_protocolE">
<span id="_CPPv3N10config_url12reg_protocolE"></span><span id="_CPPv2N10config_url12reg_protocolE"></span><span id="config_url::reg_protocol__ss"></span><span class="target" id="structconfig__url_1ab1c8340889efa0b9e174f20aebef0d24"></span>std::string <code class="sig-name descname">reg_protocol</code><a class="headerlink" href="#_CPPv4N10config_url12reg_protocolE" title="Permalink to this definition">¶</a><br /></dt>
<dd><p>Protocol used for registration of tags, i.e. HTTP (currently only supported protocol). </p>
</dd></dl>
<dl class="cpp var">
<dt id="_CPPv4N10config_url12reg_hostnameE">
<span id="_CPPv3N10config_url12reg_hostnameE"></span><span id="_CPPv2N10config_url12reg_hostnameE"></span><span id="config_url::reg_hostname__ss"></span><span class="target" id="structconfig__url_1af1778ed8f8fba5e2888c076cc304310c"></span>std::string <code class="sig-name descname">reg_hostname</code><a class="headerlink" href="#_CPPv4N10config_url12reg_hostnameE" title="Permalink to this definition">¶</a><br /></dt>
<dd><p>Hostname of the current server used for tag registration. </p>
</dd></dl>
<dl class="cpp var">
<dt id="_CPPv4N10config_url8reg_portE">
<span id="_CPPv3N10config_url8reg_portE"></span><span id="_CPPv2N10config_url8reg_portE"></span><span id="config_url::reg_port__ss"></span><span class="target" id="structconfig__url_1ac67689ff8ce4c0b0e2dbce549c29f087"></span>std::string <code class="sig-name descname">reg_port</code><a class="headerlink" href="#_CPPv4N10config_url8reg_portE" title="Permalink to this definition">¶</a><br /></dt>
<dd><p>Port of the current server used for tag registration. </p>
</dd></dl>
<dl class="cpp var">
<dt id="_CPPv4N10config_url8reg_pathE">
<span id="_CPPv3N10config_url8reg_pathE"></span><span id="_CPPv2N10config_url8reg_pathE"></span><span id="config_url::reg_path__ss"></span><span class="target" id="structconfig__url_1aeafd6153a7a3ef599777c20d7a669e71"></span>std::string <code class="sig-name descname">reg_path</code><a class="headerlink" href="#_CPPv4N10config_url8reg_pathE" title="Permalink to this definition">¶</a><br /></dt>
<dd><p>URI path of the current server used for tag registration. </p>
</dd></dl>
<dl class="cpp var">
<dt id="_CPPv4N10config_url16reg_original_urlE">
<span id="_CPPv3N10config_url16reg_original_urlE"></span><span id="_CPPv2N10config_url16reg_original_urlE"></span><span id="config_url::reg_original_url__ss"></span><span class="target" id="structconfig__url_1aed7fdca339c1ee263d705643337f4771"></span>std::string <code class="sig-name descname">reg_original_url</code><a class="headerlink" href="#_CPPv4N10config_url16reg_original_urlE" title="Permalink to this definition">¶</a><br /></dt>
<dd><p>Originally set URI, as per user input, of the current server used for tag registration. </p>
</dd></dl>
<dl class="cpp var">
<dt id="_CPPv4N10config_url14unreg_protocolE">
<span id="_CPPv3N10config_url14unreg_protocolE"></span><span id="_CPPv2N10config_url14unreg_protocolE"></span><span id="config_url::unreg_protocol__ss"></span><span class="target" id="structconfig__url_1a981dd55ea8c001c3141fc3d8da340d77"></span>std::string <code class="sig-name descname">unreg_protocol</code><a class="headerlink" href="#_CPPv4N10config_url14unreg_protocolE" title="Permalink to this definition">¶</a><br /></dt>
<dd><p>Protocol used for unregistration of tags, i.e. HTTP (currently only supported protocol). </p>
</dd></dl>
<dl class="cpp var">
<dt id="_CPPv4N10config_url14unreg_hostnameE">
<span id="_CPPv3N10config_url14unreg_hostnameE"></span><span id="_CPPv2N10config_url14unreg_hostnameE"></span><span id="config_url::unreg_hostname__ss"></span><span class="target" id="structconfig__url_1a642b3d4474bfd2fdb60b27efb52760af"></span>std::string <code class="sig-name descname">unreg_hostname</code><a class="headerlink" href="#_CPPv4N10config_url14unreg_hostnameE" title="Permalink to this definition">¶</a><br /></dt>
<dd><p>Hostname of the current server used for tag unregistration. </p>
</dd></dl>
<dl class="cpp var">
<dt id="_CPPv4N10config_url10unreg_portE">
<span id="_CPPv3N10config_url10unreg_portE"></span><span id="_CPPv2N10config_url10unreg_portE"></span><span id="config_url::unreg_port__ss"></span><span class="target" id="structconfig__url_1ac6a4dc2bd7b505c00114621c5b45160b"></span>std::string <code class="sig-name descname">unreg_port</code><a class="headerlink" href="#_CPPv4N10config_url10unreg_portE" title="Permalink to this definition">¶</a><br /></dt>
<dd><p>Port of the current server used for tag unregistration. </p>
</dd></dl>
<dl class="cpp var">
<dt id="_CPPv4N10config_url10unreg_pathE">
<span id="_CPPv3N10config_url10unreg_pathE"></span><span id="_CPPv2N10config_url10unreg_pathE"></span><span id="config_url::unreg_path__ss"></span><span class="target" id="structconfig__url_1a4f1c6cbc5615123dc34d37b9d9556b11"></span>std::string <code class="sig-name descname">unreg_path</code><a class="headerlink" href="#_CPPv4N10config_url10unreg_pathE" title="Permalink to this definition">¶</a><br /></dt>
<dd><p>URI path of the current server used for tag unregistration. </p>
</dd></dl>
<dl class="cpp var">
<dt id="_CPPv4N10config_url18unreg_original_urlE">
<span id="_CPPv3N10config_url18unreg_original_urlE"></span><span id="_CPPv2N10config_url18unreg_original_urlE"></span><span id="config_url::unreg_original_url__ss"></span><span class="target" id="structconfig__url_1ab5454de091b24c717ec85c98a934aa57"></span>std::string <code class="sig-name descname">unreg_original_url</code><a class="headerlink" href="#_CPPv4N10config_url18unreg_original_urlE" title="Permalink to this definition">¶</a><br /></dt>
<dd><p>Originally set URI, as per user input, of the current server used for tag unregistration. </p>
</dd></dl>
</div>
</dd></dl>
<dl class="cpp class">
<dt id="_CPPv411interpreter">
<span id="_CPPv311interpreter"></span><span id="_CPPv211interpreter"></span><span id="interpreter"></span><span class="target" id="classinterpreter"></span><em class="property">class </em><code class="sig-name descname">interpreter</code><a class="headerlink" href="#_CPPv411interpreter" title="Permalink to this definition">¶</a><br /></dt>
<dd><em>#include <interpreter.hpp></em><p>The interpreter class flexible functionality to track, test current, match current, match depending on some previous, user input. </p>
<div class="breathe-sectiondef docutils container">
<p class="breathe-sectiondef-title rubric">Public Functions</p>
<dl class="cpp function">
<dt id="_CPPv4N11interpreter11interpreterEv">
<span id="_CPPv3N11interpreter11interpreterEv"></span><span id="_CPPv2N11interpreter11interpreterEv"></span><span id="interpreter::interpreter"></span><span class="target" id="classinterpreter_1ad503709081c0f0ce21c7ac98b6a0965c"></span><code class="sig-name descname">interpreter</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N11interpreter11interpreterEv" title="Permalink to this definition">¶</a><br /></dt>
<dd><p>The default constructor. </p>
</dd></dl>
<dl class="cpp function">
<dt id="_CPPv4N11interpreter11interpreterENSt6stringENSt6stringE">
<span id="_CPPv3N11interpreter11interpreterENSt6stringENSt6stringE"></span><span id="_CPPv2N11interpreter11interpreterENSt6stringENSt6stringE"></span><span id="interpreter::interpreter__ss.ss"></span><span class="target" id="classinterpreter_1ab151b52deae35e6c551020086da94e52"></span><code class="sig-name descname">interpreter</code><span class="sig-paren">(</span>std::string <em>name</em>, std::string <em>pattern</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N11interpreter11interpreterENSt6stringENSt6stringE" title="Permalink to this definition">¶</a><br /></dt>
<dd><p>A constructor that takes a name and a pattern to be added to the internal collection of patterns. <dl class="simple">
<dt><strong>Parameters</strong></dt><dd><ul class="breatheparameterlist simple">
<li><p><code class="docutils literal notranslate"><span class="pre">name</span></code>: the name of the pattern. </p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">pattern</span></code>: the pattern to be registered with the given name. </p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="cpp function">
<dt id="_CPPv4N11interpreter11interpreterENSt3mapINSt6stringENSt6stringEEE">
<span id="_CPPv3N11interpreter11interpreterENSt3mapINSt6stringENSt6stringEEE"></span><span id="_CPPv2N11interpreter11interpreterENSt3mapINSt6stringENSt6stringEEE"></span><span id="interpreter::interpreter__std::map:ss.ss:"></span><span class="target" id="classinterpreter_1ad3a662a726739174373ff345d0464beb"></span><code class="sig-name descname">interpreter</code><span class="sig-paren">(</span>std::map<std::string, std::string> <em>name_pattern_pairs</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N11interpreter11interpreterENSt3mapINSt6stringENSt6stringEEE" title="Permalink to this definition">¶</a><br /></dt>
<dd><p>A constructor that takes a map of names and their corresponding patterns to be added to the internal collection of patterns. <dl class="simple">
<dt><strong>Parameters</strong></dt><dd><ul class="breatheparameterlist simple">
<li><p><code class="docutils literal notranslate"><span class="pre">name_pattern_pairs</span></code>: a map of the name - pattern to be added. </p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="cpp function">
<dt id="_CPPv4N11interpreter11interpreterENSt6vectorINSt6stringEEE">
<span id="_CPPv3N11interpreter11interpreterENSt6vectorINSt6stringEEE"></span><span id="_CPPv2N11interpreter11interpreterENSt6vectorINSt6stringEEE"></span><span id="interpreter::interpreter__std::vector:ss:"></span><span class="target" id="classinterpreter_1a746dfb8590c75f88c70420c8b08fd15c"></span><code class="sig-name descname">interpreter</code><span class="sig-paren">(</span>std::vector<std::string> <em>name_pattern_pairs</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N11interpreter11interpreterENSt6vectorINSt6stringEEE" title="Permalink to this definition">¶</a><br /></dt>
<dd><p>A constructor that takes a vector where every even entry is considered a name, and every succeeding odd entry is considered the corresponding pattern to be added to the internal collection of patterns. <dl class="simple">
<dt><strong>Parameters</strong></dt><dd><ul class="breatheparameterlist simple">
<li><p><code class="docutils literal notranslate"><span class="pre">name_pattern_pairs</span></code>: a vector of the name - pattern pairs where even entry corresponds to name and succeeding odd entry to its pattern. </p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="cpp function">
<dt id="_CPPv4N11interpreter4testENSt6stringENSt6stringEib">
<span id="_CPPv3N11interpreter4testENSt6stringENSt6stringEib"></span><span id="_CPPv2N11interpreter4testENSt6stringENSt6stringEib"></span><span id="interpreter::test__ss.ss.i.b"></span><span class="target" id="classinterpreter_1a97b28e679dfeb7de011b92bb80898051"></span>bool <code class="sig-name descname">test</code><span class="sig-paren">(</span>std::string <em>input</em>, std::string <em>regex</em>, int <em>group</em> = 0, bool <em>retain</em> = false<span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N11interpreter4testENSt6stringENSt6stringEib" title="Permalink to this definition">¶</a><br /></dt>
<dd><p>Tests the given input against a registered pattern and optionally retains the potential match. <dl class="simple">
<dt><strong>Return</strong></dt><dd><p>true if there is a match, otherwise false. </p>
</dd>
<dt><strong>Parameters</strong></dt><dd><ul class="breatheparameterlist simple">
<li><p><code class="docutils literal notranslate"><span class="pre">input</span></code>: user input to be tested. </p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">regex</span></code>: name of pattern in internal collection </p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">group</span></code>: group of pattern to be matched (if applicable) to optionally be retained, defaults to 0, i.e. entire potential match. Optional. </p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">retain</span></code>: whether potential match should be retained or not, defaults to false. Optional. </p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="cpp function">
<dt id="_CPPv4N11interpreter4testENSt6stringENSt5regexE">
<span id="_CPPv3N11interpreter4testENSt6stringENSt5regexE"></span><span id="_CPPv2N11interpreter4testENSt6stringENSt5regexE"></span><span id="interpreter::test__ss.std::regex"></span><span class="target" id="classinterpreter_1acc32201b729dfc0e5a178c6258ae8cf4"></span>bool <code class="sig-name descname">test</code><span class="sig-paren">(</span>std::string <em>input</em>, std::regex <em>regex</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N11interpreter4testENSt6stringENSt5regexE" title="Permalink to this definition">¶</a><br /></dt>
<dd><p>Tests the given input against a registered pattern and optionally retains the potential match. <dl class="simple">
<dt><strong>Return</strong></dt><dd><p>true if there is a match, otherwise false. </p>
</dd>
<dt><strong>Parameters</strong></dt><dd><ul class="breatheparameterlist simple">
<li><p><code class="docutils literal notranslate"><span class="pre">input</span></code>: user input to be tested. </p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">regex</span></code>: standalone regex pattern to be tested against. </p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="cpp function">
<dt id="_CPPv4N11interpreter4evalENSt6stringERNSt6stringENSt6stringEib">
<span id="_CPPv3N11interpreter4evalENSt6stringERNSt6stringENSt6stringEib"></span><span id="_CPPv2N11interpreter4evalENSt6stringERNSt6stringENSt6stringEib"></span><span id="interpreter::eval__ss.ssR.ss.i.b"></span><span class="target" id="classinterpreter_1ab1485955a78629dd39c2f3a98f0f3a5e"></span>bool <code class="sig-name descname">eval</code><span class="sig-paren">(</span>std::string <em>input</em>, std::string &<em>match_str</em>, std::string <em>regex</em>, int <em>group</em> = 0, bool <em>retain</em> = false<span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N11interpreter4evalENSt6stringERNSt6stringENSt6stringEib" title="Permalink to this definition">¶</a><br /></dt>
<dd><p>Evaluates the given input against a registered pattern and optionally retains the potential match. <dl class="simple">
<dt><strong>Return</strong></dt><dd><p>true if there is a match, otherwise false. </p>
</dd>
<dt><strong>Parameters</strong></dt><dd><ul class="breatheparameterlist simple">
<li><p><code class="docutils literal notranslate"><span class="pre">input</span></code>: user input to be evaluated. </p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">match_str</span></code>: reference to the string to write the evaluated match to, if any. </p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">regex</span></code>: name of pattern in internal collection </p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">group</span></code>: group of pattern to be matched (if applicable) to optionally be retained, defaults to 0, i.e. entire potential match. Optional. </p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">retain</span></code>: whether potential match should be retained or not, defaults to false. Optional. </p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="cpp function">
<dt id="_CPPv4N11interpreter4evalENSt6stringERNSt6stringENSt5regexEi">
<span id="_CPPv3N11interpreter4evalENSt6stringERNSt6stringENSt5regexEi"></span><span id="_CPPv2N11interpreter4evalENSt6stringERNSt6stringENSt5regexEi"></span><span id="interpreter::eval__ss.ssR.std::regex.i"></span><span class="target" id="classinterpreter_1a9e25701dddab123e01935e4f7e4863cf"></span>bool <code class="sig-name descname">eval</code><span class="sig-paren">(</span>std::string <em>input</em>, std::string &<em>match_str</em>, std::regex <em>regex</em>, int <em>group</em> = 0<span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N11interpreter4evalENSt6stringERNSt6stringENSt5regexEi" title="Permalink to this definition">¶</a><br /></dt>
<dd><p>Evaluates the given input against a registered pattern and optionally retains the potential match. <dl class="simple">
<dt><strong>Return</strong></dt><dd><p>true if there is a match, otherwise false. </p>
</dd>
<dt><strong>Parameters</strong></dt><dd><ul class="breatheparameterlist simple">
<li><p><code class="docutils literal notranslate"><span class="pre">input</span></code>: user input to be tested. </p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">match_str</span></code>: reference to the string to write the evaluated match to, if any. </p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">regex</span></code>: standalone regex pattern to be tested against. </p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">group</span></code>: group of pattern to be matched (if applicable), defaults to 0, i.e. entire potential match. Optional. </p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="cpp function">
<dt id="_CPPv4N11interpreter4evalENSt6stringERNSt6vectorINSt6stringEEENSt6stringEib">
<span id="_CPPv3N11interpreter4evalENSt6stringERNSt6vectorINSt6stringEEENSt6stringEib"></span><span id="_CPPv2N11interpreter4evalENSt6stringERNSt6vectorINSt6stringEEENSt6stringEib"></span><span id="interpreter::eval__ss.std::vector:ss:R.ss.i.b"></span><span class="target" id="classinterpreter_1a29d70c8e011de2ee19ab2b471870714b"></span>bool <code class="sig-name descname">eval</code><span class="sig-paren">(</span>std::string <em>input</em>, std::vector<std::string> &<em>match_str</em>, std::string <em>regex</em>, int <em>group</em> = 0, bool <em>retain</em> = false<span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N11interpreter4evalENSt6stringERNSt6vectorINSt6stringEEENSt6stringEib" title="Permalink to this definition">¶</a><br /></dt>
<dd><p>Evaluates the given input against a registered pattern and optionally retains the potential match. <dl class="simple">
<dt><strong>Return</strong></dt><dd><p>true if there is a match, otherwise false. </p>
</dd>
<dt><strong>Parameters</strong></dt><dd><ul class="breatheparameterlist simple">
<li><p><code class="docutils literal notranslate"><span class="pre">input</span></code>: user input to be evaluated. </p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">match_str</span></code>: reference to a vector of strings to write the individual groups of the evaluated match to, if any. </p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">regex</span></code>: name of pattern in internal collection </p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">group</span></code>: group of pattern to be matched (if applicable) to optionally be retained, defaults to 0, i.e. entire potential match. Optional. </p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">retain</span></code>: whether potential match should be retained or not, defaults to false. Optional. </p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="cpp function">
<dt id="_CPPv4N11interpreter4evalENSt6stringERNSt6vectorINSt6stringEEENSt5regexE">
<span id="_CPPv3N11interpreter4evalENSt6stringERNSt6vectorINSt6stringEEENSt5regexE"></span><span id="_CPPv2N11interpreter4evalENSt6stringERNSt6vectorINSt6stringEEENSt5regexE"></span><span id="interpreter::eval__ss.std::vector:ss:R.std::regex"></span><span class="target" id="classinterpreter_1a33dae2d6f8c0adf66fcd58b3d19d2fca"></span>bool <code class="sig-name descname">eval</code><span class="sig-paren">(</span>std::string <em>input</em>, std::vector<std::string> &<em>match_str</em>, std::regex <em>regex</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N11interpreter4evalENSt6stringERNSt6vectorINSt6stringEEENSt5regexE" title="Permalink to this definition">¶</a><br /></dt>
<dd><p>Evaluates the given input against a registered pattern and optionally retains the potential match. <dl class="simple">
<dt><strong>Return</strong></dt><dd><p>true if there is a match, otherwise false. </p>
</dd>
<dt><strong>Parameters</strong></dt><dd><ul class="breatheparameterlist simple">
<li><p><code class="docutils literal notranslate"><span class="pre">input</span></code>: user input to be tested. </p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">match_str</span></code>: reference to a vector strings to write the individual groups of the evaluated match to, if any. </p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">regex</span></code>: standalone regex pattern to be tested against. </p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="cpp function">
<dt id="_CPPv4N11interpreter11look_behindEv">
<span id="_CPPv3N11interpreter11look_behindEv"></span><span id="_CPPv2N11interpreter11look_behindEv"></span><span id="interpreter::look_behind"></span><span class="target" id="classinterpreter_1acf793e08add9b89dcad048c52fe854e5"></span>std::string <code class="sig-name descname">look_behind</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N11interpreter11look_behindEv" title="Permalink to this definition">¶</a><br /></dt>
<dd><p>Looks at the most recent retained match and returns it. <dl class="simple">
<dt><strong>Return</strong></dt><dd><p>the most recently retained match. </p>
</dd>
</dl>
</dd></dl>
<dl class="cpp function">
<dt id="_CPPv4N11interpreter11look_behindEi">
<span id="_CPPv3N11interpreter11look_behindEi"></span><span id="_CPPv2N11interpreter11look_behindEi"></span><span id="interpreter::look_behind__i"></span><span class="target" id="classinterpreter_1a61c89d2a17d2ae664ed1efe97ad7056a"></span>std::string <code class="sig-name descname">look_behind</code><span class="sig-paren">(</span>int <em>hops</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N11interpreter11look_behindEi" title="Permalink to this definition">¶</a><br /></dt>
<dd><p>Looks at the retained match at the specified number of hops back and returns it. <dl class="simple">
<dt><strong>Return</strong></dt><dd><p>the retained match at the specified number of hops back. </p>
</dd>
<dt><strong>Parameters</strong></dt><dd><ul class="breatheparameterlist simple">
<li><p><code class="docutils literal notranslate"><span class="pre">hops</span></code>: number of hops to look back. </p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="cpp function">
<dt id="_CPPv4N11interpreter16look_behind_evalENSt6stringENSt6stringENSt6stringEi">
<span id="_CPPv3N11interpreter16look_behind_evalENSt6stringENSt6stringENSt6stringEi"></span><span id="_CPPv2N11interpreter16look_behind_evalENSt6stringENSt6stringENSt6stringEi"></span><span id="interpreter::look_behind_eval__ss.ss.ss.i"></span><span class="target" id="classinterpreter_1a4aa834df849ace3c91cb146d53df0a74"></span>bool <code class="sig-name descname">look_behind_eval</code><span class="sig-paren">(</span>std::string <em>input</em>, std::string <em>name_replaced</em> = "", std::string <em>name_to_replace</em> = "", int <em>hops</em> = 0<span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N11interpreter16look_behind_evalENSt6stringENSt6stringENSt6stringEi" title="Permalink to this definition">¶</a><br /></dt>
<dd><p>Looks at the retained match at the specified number of hops back (optional, defaults to most recent), and attempts to evaluate it against a pattern with the same name as itself (pattern may optionally be renamed). <dl class="simple">
<dt><strong>Return</strong></dt><dd><p>returns true if a match exists, otherwise false. </p>
</dd>
<dt><strong>Parameters</strong></dt><dd><ul class="breatheparameterlist simple">
<li><p><code class="docutils literal notranslate"><span class="pre">input</span></code>: user input to be evaluated. </p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">name_replaced</span></code>: pattern of part of the look behind value to be replaced for the name of the pattern to be used in the evaluation. Optional. </p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">name_to_replace</span></code>: string to replace the part of the pattern name to be replaced. Optional. </p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">hops</span></code>: number of hops to look behind, defaults to most recent. Optional. </p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="cpp function">
<dt id="_CPPv4N11interpreter5flushEv">
<span id="_CPPv3N11interpreter5flushEv"></span><span id="_CPPv2N11interpreter5flushEv"></span><span id="interpreter::flush"></span><span class="target" id="classinterpreter_1ac5c8e8a4f18e9cf271b5ae7995ee9757"></span>void <code class="sig-name descname">flush</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N11interpreter5flushEv" title="Permalink to this definition">¶</a><br /></dt>
<dd><p>Flushes the history of look behind values. </p>
</dd></dl>
<dl class="cpp function">
<dt id="_CPPv4N11interpreter10flush_lastEi">
<span id="_CPPv3N11interpreter10flush_lastEi"></span><span id="_CPPv2N11interpreter10flush_lastEi"></span><span id="interpreter::flush_last__i"></span><span class="target" id="classinterpreter_1ad9a5fc1b5e6aec0b3d0ce446a9b652d1"></span>void <code class="sig-name descname">flush_last</code><span class="sig-paren">(</span>int <em>no</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N11interpreter10flush_lastEi" title="Permalink to this definition">¶</a><br /></dt>
<dd><p>Flushes the specified last number of look behind values. <dl class="simple">
<dt><strong>Parameters</strong></dt><dd><ul class="breatheparameterlist simple">
<li><p><code class="docutils literal notranslate"><span class="pre">no</span></code>: number of values to remove from history starting with most recent. </p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="cpp function">
<dt id="_CPPv4N11interpreter11has_patternENSt6stringE">
<span id="_CPPv3N11interpreter11has_patternENSt6stringE"></span><span id="_CPPv2N11interpreter11has_patternENSt6stringE"></span><span id="interpreter::has_pattern__ss"></span><span class="target" id="classinterpreter_1af85cdc14e3204a369782533fb938b0d2"></span>bool <code class="sig-name descname">has_pattern</code><span class="sig-paren">(</span>std::string <em>name</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N11interpreter11has_patternENSt6stringE" title="Permalink to this definition">¶</a><br /></dt>
<dd><p>Checks if pattern with specified name exists. <dl class="simple">
<dt><strong>Return</strong></dt><dd><p>true if a pattern with specified name exists, otherwise false. </p>
</dd>
<dt><strong>Parameters</strong></dt><dd><ul class="breatheparameterlist simple">
<li><p><code class="docutils literal notranslate"><span class="pre">name</span></code>: name of the pattern whose existence to check for. </p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="cpp function">
<dt id="_CPPv4N11interpreter11has_patternENSt6vectorINSt6stringEEE">
<span id="_CPPv3N11interpreter11has_patternENSt6vectorINSt6stringEEE"></span><span id="_CPPv2N11interpreter11has_patternENSt6vectorINSt6stringEEE"></span><span id="interpreter::has_pattern__std::vector:ss:"></span><span class="target" id="classinterpreter_1a91b5ec99959772e0822113635f01db7e"></span>bool <code class="sig-name descname">has_pattern</code><span class="sig-paren">(</span>std::vector<std::string> <em>name</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N11interpreter11has_patternENSt6vectorINSt6stringEEE" title="Permalink to this definition">¶</a><br /></dt>
<dd><p>Checks if a collection of patterns exists. <dl class="simple">
<dt><strong>Return</strong></dt><dd><p>true if all patterns with the specified names exists, otherwise false. </p>
</dd>
<dt><strong>Parameters</strong></dt><dd><ul class="breatheparameterlist simple">
<li><p><code class="docutils literal notranslate"><span class="pre">name</span></code>: names of all the patterns whose existence to check for. </p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="cpp function">
<dt id="_CPPv4N11interpreter14remove_patternENSt6stringEb">
<span id="_CPPv3N11interpreter14remove_patternENSt6stringEb"></span><span id="_CPPv2N11interpreter14remove_patternENSt6stringEb"></span><span id="interpreter::remove_pattern__ss.b"></span><span class="target" id="classinterpreter_1ad95538274da07b891615a0cacfdfba03"></span>void <code class="sig-name descname">remove_pattern</code><span class="sig-paren">(</span>std::string <em>name</em>, bool <em>force</em> = true<span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N11interpreter14remove_patternENSt6stringEb" title="Permalink to this definition">¶</a><br /></dt>
<dd><p>Remove pattern with the specified name from the internal collection. <dl class="simple">
<dt><strong>Parameters</strong></dt><dd><ul class="breatheparameterlist simple">
<li><p><code class="docutils literal notranslate"><span class="pre">name</span></code>: name of the pattern to be removed. </p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">force</span></code>: force removal of pattern if true, which is default. Optional. </p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="cpp function">
<dt id="_CPPv4N11interpreter14remove_patternENSt6vectorINSt6stringEEEb">
<span id="_CPPv3N11interpreter14remove_patternENSt6vectorINSt6stringEEEb"></span><span id="_CPPv2N11interpreter14remove_patternENSt6vectorINSt6stringEEEb"></span><span id="interpreter::remove_pattern__std::vector:ss:.b"></span><span class="target" id="classinterpreter_1a6af2c29022af9a93edbd1e9df7178384"></span>void <code class="sig-name descname">remove_pattern</code><span class="sig-paren">(</span>std::vector<std::string> <em>name</em>, bool <em>force</em> = true<span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N11interpreter14remove_patternENSt6vectorINSt6stringEEEb" title="Permalink to this definition">¶</a><br /></dt>
<dd><p>Remove all patterns with the specified names from the internal collection. <dl class="simple">
<dt><strong>Parameters</strong></dt><dd><ul class="breatheparameterlist simple">
<li><p><code class="docutils literal notranslate"><span class="pre">name</span></code>: collection of names of the patterns to be removed. </p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">force</span></code>: force removal of pattern if true, which is default. Optional. </p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="cpp function">
<dt id="_CPPv4N11interpreter11set_patternENSt6stringENSt6stringE">
<span id="_CPPv3N11interpreter11set_patternENSt6stringENSt6stringE"></span><span id="_CPPv2N11interpreter11set_patternENSt6stringENSt6stringE"></span><span id="interpreter::set_pattern__ss.ss"></span><span class="target" id="classinterpreter_1abe5c973dd5ea672bca75ca5d5fa3c028"></span>void <code class="sig-name descname">set_pattern</code><span class="sig-paren">(</span>std::string <em>name</em>, std::string <em>pattern</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N11interpreter11set_patternENSt6stringENSt6stringE" title="Permalink to this definition">¶</a><br /></dt>
<dd><p>Add pattern with the specified name and pattern to the internal collection. <dl class="simple">
<dt><strong>Parameters</strong></dt><dd><ul class="breatheparameterlist simple">
<li><p><code class="docutils literal notranslate"><span class="pre">name</span></code>: name of pattern to be added. </p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">pattern</span></code>: pattern to be added. </p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="cpp function">
<dt id="_CPPv4N11interpreter11set_patternENSt3mapINSt6stringENSt6stringEEE">
<span id="_CPPv3N11interpreter11set_patternENSt3mapINSt6stringENSt6stringEEE"></span><span id="_CPPv2N11interpreter11set_patternENSt3mapINSt6stringENSt6stringEEE"></span><span id="interpreter::set_pattern__std::map:ss.ss:"></span><span class="target" id="classinterpreter_1a164c95c8199317c450f8790523db6af0"></span>void <code class="sig-name descname">set_pattern</code><span class="sig-paren">(</span>std::map<std::string, std::string> <em>name_pattern_pairs</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N11interpreter11set_patternENSt3mapINSt6stringENSt6stringEEE" title="Permalink to this definition">¶</a><br /></dt>
<dd><p>Add patterns with the specified names and patterns to the internal collection. <dl class="simple">
<dt><strong>Parameters</strong></dt><dd><ul class="breatheparameterlist simple">
<li><p><code class="docutils literal notranslate"><span class="pre">name_pattern_pairs</span></code>: map of names and corresponding patterns to be added. </p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="cpp function">
<dt id="_CPPv4N11interpreter11set_patternENSt6vectorINSt6stringEEE">
<span id="_CPPv3N11interpreter11set_patternENSt6vectorINSt6stringEEE"></span><span id="_CPPv2N11interpreter11set_patternENSt6vectorINSt6stringEEE"></span><span id="interpreter::set_pattern__std::vector:ss:"></span><span class="target" id="classinterpreter_1a5c5a009a2233596f06f3161a035ee9e9"></span>void <code class="sig-name descname">set_pattern</code><span class="sig-paren">(</span>std::vector<std::string> <em>name_pattern_pairs</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N11interpreter11set_patternENSt6vectorINSt6stringEEE" title="Permalink to this definition">¶</a><br /></dt>
<dd><p>Add patterns with the specified names and patterns to the internal collection. <dl class="simple">
<dt><strong>Parameters</strong></dt><dd><ul class="breatheparameterlist simple">
<li><p><code class="docutils literal notranslate"><span class="pre">name_pattern_pairs</span></code>: vector of names and corresponding patterns to be added, where even entries are names, and subsequent odd entry the corresponding pattern. </p></li>
</ul>
</dd>
</dl>
</dd></dl>
</div>
<div class="breathe-sectiondef docutils container">
<p class="breathe-sectiondef-title rubric">Private Members</p>
<dl class="cpp var">
<dt id="_CPPv4N11interpreter7patternE">
<span id="_CPPv3N11interpreter7patternE"></span><span id="_CPPv2N11interpreter7patternE"></span><span id="interpreter::pattern__std::map:ss.std::regex:"></span><span class="target" id="classinterpreter_1a37a46de76e9a2eb6929ce782486b1f4b"></span>std::map<std::string, std::regex> <code class="sig-name descname">pattern</code><a class="headerlink" href="#_CPPv4N11interpreter7patternE" title="Permalink to this definition">¶</a><br /></dt>
<dd></dd></dl>
<dl class="cpp var">
<dt id="_CPPv4N11interpreter8l_behindE">
<span id="_CPPv3N11interpreter8l_behindE"></span><span id="_CPPv2N11interpreter8l_behindE"></span><span id="interpreter::l_behind__std::vector:ss:"></span><span class="target" id="classinterpreter_1ab88e00025873670beecb0965d6650053"></span>std::vector<std::string> <code class="sig-name descname">l_behind</code><a class="headerlink" href="#_CPPv4N11interpreter8l_behindE" title="Permalink to this definition">¶</a><br /></dt>
<dd></dd></dl>
</div>
</dd></dl>
<dl class="cpp class">
<dt id="_CPPv46reader">
<span id="_CPPv36reader"></span><span id="_CPPv26reader"></span><span id="reader"></span><span class="target" id="classreader"></span><em class="property">class </em><code class="sig-name descname">reader</code> : <em class="property">public</em> <a class="reference internal" href="#_CPPv413reader_device" title="reader_device">reader_device</a><a class="headerlink" href="#_CPPv46reader" title="Permalink to this definition">¶</a><br /></dt>
<dd><em>#include <reader.hpp></em><p>The reader class provides functionality to communicate with the CR95HF transceiver board. </p>
<div class="breathe-sectiondef docutils container">
<p class="breathe-sectiondef-title rubric">Public Functions</p>
<dl class="cpp function">
<dt id="_CPPv4N6reader6readerER6config">
<span id="_CPPv3N6reader6readerER6config"></span><span id="_CPPv2N6reader6readerER6config"></span><span id="reader::reader__configR"></span><span class="target" id="classreader_1a3b06708cfa03c3eacb30bab8b1f51e94"></span><code class="sig-name descname">reader</code><span class="sig-paren">(</span><a class="reference internal" href="#_CPPv46config" title="config">config</a> &<em>con</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N6reader6readerER6config" title="Permalink to this definition">¶</a><br /></dt>
<dd><p>Constructor for the reader which utilize the current configuration. <dl class="simple">
<dt><strong>Parameters</strong></dt><dd><ul class="breatheparameterlist simple">
<li><p><code class="docutils literal notranslate"><span class="pre">con</span></code>: the configuration object of the component. </p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="cpp function">
<dt id="_CPPv4N6reader3runEv">
<span id="_CPPv3N6reader3runEv"></span><span id="_CPPv2N6reader3runEv"></span><span id="reader::run"></span><span class="target" id="classreader_1a3da4db3e1484d34e53f87c749fe73f08"></span>void <code class="sig-name descname">run</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N6reader3runEv" title="Permalink to this definition">¶</a><br /></dt>
<dd><p>Provides continuous execution of the CR95HF transceiver board per the configuration object. </p>
</dd></dl>
<dl class="cpp function">
<dt id="_CPPv4N6reader24toggle_deactivator_readyEv">
<span id="_CPPv3N6reader24toggle_deactivator_readyEv"></span><span id="_CPPv2N6reader24toggle_deactivator_readyEv"></span><span id="reader::toggle_deactivator_ready"></span><span class="target" id="classreader_1acffd30776c46b95ac04a521832c09dc2"></span>void <code class="sig-name descname">toggle_deactivator_ready</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N6reader24toggle_deactivator_readyEv" title="Permalink to this definition">¶</a><br /></dt>
<dd><p>Toggles flag for whether the tag deactivator of the reader device is awake and ready. </p>
</dd></dl>
</div>
<div class="breathe-sectiondef docutils container">
<p class="breathe-sectiondef-title rubric">Private Functions</p>
<dl class="cpp function">
<dt id="_CPPv4N6reader20establish_connectionEv">
<span id="_CPPv3N6reader20establish_connectionEv"></span><span id="_CPPv2N6reader20establish_connectionEv"></span><span id="reader::establish_connection"></span><span class="target" id="classreader_1a0dc18bafe2b07f1ab967c3156d8d8969"></span>int <code class="sig-name descname">establish_connection</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N6reader20establish_connectionEv" title="Permalink to this definition">¶</a><br /></dt>
<dd></dd></dl>
<dl class="cpp function">
<dt id="_CPPv4N6reader15select_protocolEv">
<span id="_CPPv3N6reader15select_protocolEv"></span><span id="_CPPv2N6reader15select_protocolEv"></span><span id="reader::select_protocol"></span><span class="target" id="classreader_1adf977c246d4973a9c74d43b9787eb197"></span>int <code class="sig-name descname">select_protocol</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N6reader15select_protocolEv" title="Permalink to this definition">¶</a><br /></dt>
<dd></dd></dl>
<dl class="cpp function">
<dt id="_CPPv4N6reader13scan_for_tagsER8tag_data">