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
|
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
<title>Class template basic_ptree</title>
<link rel="stylesheet" href="../../../../doc/src/boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
<link rel="home" href="../../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset">
<link rel="up" href="../../property_tree/reference.html#header.boost.property_tree.ptree_hpp" title="Header <boost/property_tree/ptree.hpp>">
<link rel="prev" href="json_parser/write_json_id1137532.html" title="Function template write_json">
<link rel="next" href="path.html" title="Type definition path">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%"><tr>
<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../boost.png"></td>
<td align="center"><a href="../../../../index.html">Home</a></td>
<td align="center"><a href="../../../../libs/libraries.htm">Libraries</a></td>
<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td>
<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td>
<td align="center"><a href="../../../../more/index.htm">More</a></td>
</tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="json_parser/write_json_id1137532.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../property_tree/reference.html#header.boost.property_tree.ptree_hpp"><img src="../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="path.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
</div>
<div class="refentry">
<a name="boost.property_tree.basic_ptree"></a><div class="titlepage"></div>
<div class="refnamediv">
<h2><span class="refentrytitle">Class template basic_ptree</span></h2>
<p>boost::property_tree::basic_ptree</p>
</div>
<h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2>
<div xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv"><pre class="synopsis"><span class="comment">// In header: <<a class="link" href="../../property_tree/reference.html#header.boost.property_tree.ptree_hpp" title="Header <boost/property_tree/ptree.hpp>">boost/property_tree/ptree.hpp</a>>
</span><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> Key<span class="special">,</span> <span class="keyword">typename</span> Data<span class="special">,</span> <span class="keyword">typename</span> KeyCompare<span class="special">></span>
<span class="keyword">class</span> <a class="link" href="basic_ptree.html" title="Class template basic_ptree">basic_ptree</a> <span class="special">{</span>
<span class="keyword">public</span><span class="special">:</span>
<span class="comment">// <a class="link" href="basic_ptree.html#boost.property_tree.basic_ptreetypes">types</a></span>
<span class="keyword">typedef</span> <a class="link" href="basic_ptree.html" title="Class template basic_ptree">basic_ptree</a><span class="special"><</span> <span class="identifier">Key</span><span class="special">,</span> <span class="identifier">Data</span><span class="special">,</span> <span class="identifier">KeyCompare</span> <span class="special">></span> <a class="link" href="basic_ptree.html#boost.property_tree.basic_ptree.self_type"><span class="identifier">self_type</span></a><span class="special">;</span>
<span class="keyword">typedef</span> <span class="identifier">Key</span> <a name="boost.property_tree.basic_ptree.key_type"></a><span class="identifier">key_type</span><span class="special">;</span>
<span class="keyword">typedef</span> <span class="identifier">Data</span> <a name="boost.property_tree.basic_ptree.data_type"></a><span class="identifier">data_type</span><span class="special">;</span>
<span class="keyword">typedef</span> <span class="identifier">KeyCompare</span> <a name="boost.property_tree.basic_ptree.key_compare"></a><span class="identifier">key_compare</span><span class="special">;</span>
<span class="keyword">typedef</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">pair</span><span class="special"><</span> <span class="keyword">const</span> <span class="identifier">Key</span><span class="special">,</span> <a class="link" href="basic_ptree.html#boost.property_tree.basic_ptree.self_type">self_type</a> <span class="special">></span> <a name="boost.property_tree.basic_ptree.value_type"></a><span class="identifier">value_type</span><span class="special">;</span>
<span class="keyword">typedef</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> <a name="boost.property_tree.basic_ptree.size_type"></a><span class="identifier">size_type</span><span class="special">;</span>
<span class="keyword">typedef</span> <span class="identifier">path_of</span><span class="special"><</span> <span class="identifier">Key</span> <span class="special">></span><span class="special">::</span><span class="identifier">type</span> <a name="boost.property_tree.basic_ptree.path_type"></a><span class="identifier">path_type</span><span class="special">;</span>
<span class="comment">// <a class="link" href="basic_ptree.html#boost.property_tree.basic_ptreeconstruct-copy-destruct">construct/copy/destruct</a></span>
<a class="link" href="basic_ptree.html#id792754-bb"><span class="identifier">basic_ptree</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
<span class="keyword">explicit</span> <a class="link" href="basic_ptree.html#id792759-bb"><span class="identifier">basic_ptree</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">data_type</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span>
<a class="link" href="basic_ptree.html#id792773-bb"><span class="identifier">basic_ptree</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="basic_ptree.html#boost.property_tree.basic_ptree.self_type">self_type</a> <span class="special">&</span><span class="special">)</span><span class="special">;</span>
basic_ptree& <a class="link" href="basic_ptree.html#id792784-bb"><span class="keyword">operator</span><span class="special">=</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="basic_ptree.html#boost.property_tree.basic_ptree.self_type">self_type</a> <span class="special">&</span><span class="special">)</span><span class="special">;</span>
<a class="link" href="basic_ptree.html#id792783-bb"><span class="special">~</span><span class="identifier">basic_ptree</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
<span class="comment">// <a class="link" href="basic_ptree.html#id799768-bb">public member functions</a></span>
<span class="keyword">void</span> <a class="link" href="basic_ptree.html#id799771-bb"><span class="identifier">swap</span></a><span class="special">(</span><a class="link" href="basic_ptree.html#boost.property_tree.basic_ptree.self_type">self_type</a> <span class="special">&</span><span class="special">)</span><span class="special">;</span>
<span class="identifier">size_type</span> <a class="link" href="basic_ptree.html#id1159072-bb"><span class="identifier">size</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
<span class="identifier">size_type</span> <a class="link" href="basic_ptree.html#id1159084-bb"><span class="identifier">max_size</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
<span class="keyword">bool</span> <a class="link" href="basic_ptree.html#id1159091-bb"><span class="identifier">empty</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
<span class="identifier">iterator</span> <a class="link" href="basic_ptree.html#id1159103-bb"><span class="identifier">begin</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
<span class="identifier">const_iterator</span> <a class="link" href="basic_ptree.html#id1159111-bb"><span class="identifier">begin</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
<span class="identifier">iterator</span> <a class="link" href="basic_ptree.html#id1159118-bb"><span class="identifier">end</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
<span class="identifier">const_iterator</span> <a class="link" href="basic_ptree.html#id1159126-bb"><span class="identifier">end</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
<span class="identifier">reverse_iterator</span> <a class="link" href="basic_ptree.html#id1159134-bb"><span class="identifier">rbegin</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
<span class="identifier">const_reverse_iterator</span> <a class="link" href="basic_ptree.html#id1164279-bb"><span class="identifier">rbegin</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
<span class="identifier">reverse_iterator</span> <a class="link" href="basic_ptree.html#id1156004-bb"><span class="identifier">rend</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
<span class="identifier">const_reverse_iterator</span> <a class="link" href="basic_ptree.html#id1156012-bb"><span class="identifier">rend</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
<span class="identifier">value_type</span> <span class="special">&</span> <a class="link" href="basic_ptree.html#id1156020-bb"><span class="identifier">front</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
<span class="keyword">const</span> <span class="identifier">value_type</span> <span class="special">&</span> <a class="link" href="basic_ptree.html#id1156027-bb"><span class="identifier">front</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
<span class="identifier">value_type</span> <span class="special">&</span> <a class="link" href="basic_ptree.html#id1156035-bb"><span class="identifier">back</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
<span class="keyword">const</span> <span class="identifier">value_type</span> <span class="special">&</span> <a class="link" href="basic_ptree.html#id1156043-bb"><span class="identifier">back</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
<span class="identifier">iterator</span> <a class="link" href="basic_ptree.html#id1156051-bb"><span class="identifier">insert</span></a><span class="special">(</span><span class="identifier">iterator</span><span class="special">,</span> <span class="keyword">const</span> <span class="identifier">value_type</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span>
<span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> It<span class="special">></span> <span class="keyword">void</span> <a class="link" href="basic_ptree.html#id1156080-bb"><span class="identifier">insert</span></a><span class="special">(</span><span class="identifier">iterator</span><span class="special">,</span> <span class="identifier">It</span><span class="special">,</span> <span class="identifier">It</span><span class="special">)</span><span class="special">;</span>
<span class="identifier">iterator</span> <a class="link" href="basic_ptree.html#id1156120-bb"><span class="identifier">erase</span></a><span class="special">(</span><span class="identifier">iterator</span><span class="special">)</span><span class="special">;</span>
<span class="identifier">iterator</span> <a class="link" href="basic_ptree.html#id1156143-bb"><span class="identifier">erase</span></a><span class="special">(</span><span class="identifier">iterator</span><span class="special">,</span> <span class="identifier">iterator</span><span class="special">)</span><span class="special">;</span>
<span class="identifier">iterator</span> <a class="link" href="basic_ptree.html#id1156170-bb"><span class="identifier">push_front</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">value_type</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span>
<span class="identifier">iterator</span> <a class="link" href="basic_ptree.html#id1156187-bb"><span class="identifier">push_back</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">value_type</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span>
<span class="keyword">void</span> <a class="link" href="basic_ptree.html#id1156205-bb"><span class="identifier">pop_front</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
<span class="keyword">void</span> <a class="link" href="basic_ptree.html#id1156216-bb"><span class="identifier">pop_back</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
<span class="keyword">void</span> <a class="link" href="basic_ptree.html#id1156228-bb"><span class="identifier">reverse</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
<span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> Compare<span class="special">></span> <span class="keyword">void</span> <a class="link" href="basic_ptree.html#id1156240-bb"><span class="identifier">sort</span></a><span class="special">(</span><span class="identifier">Compare</span><span class="special">)</span><span class="special">;</span>
<span class="keyword">void</span> <a class="link" href="basic_ptree.html#id1135993-bb"><span class="identifier">sort</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
<span class="keyword">bool</span> <a class="link" href="basic_ptree.html#id1136005-bb"><span class="keyword">operator</span><span class="special">==</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="basic_ptree.html#boost.property_tree.basic_ptree.self_type">self_type</a> <span class="special">&</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
<span class="keyword">bool</span> <a class="link" href="basic_ptree.html#id1136028-bb"><span class="keyword">operator</span><span class="special">!=</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="basic_ptree.html#boost.property_tree.basic_ptree.self_type">self_type</a> <span class="special">&</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
<span class="identifier">assoc_iterator</span> <a class="link" href="basic_ptree.html#id1136045-bb"><span class="identifier">ordered_begin</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
<span class="identifier">const_assoc_iterator</span> <a class="link" href="basic_ptree.html#id1182593-bb"><span class="identifier">ordered_begin</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
<span class="identifier">assoc_iterator</span> <a class="link" href="basic_ptree.html#id790250-bb"><span class="identifier">not_found</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
<span class="identifier">const_assoc_iterator</span> <a class="link" href="basic_ptree.html#id790262-bb"><span class="identifier">not_found</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
<span class="identifier">assoc_iterator</span> <a class="link" href="basic_ptree.html#id790275-bb"><span class="identifier">find</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">key_type</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span>
<span class="identifier">const_assoc_iterator</span> <a class="link" href="basic_ptree.html#id790294-bb"><span class="identifier">find</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">key_type</span> <span class="special">&</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
<span class="identifier">std</span><span class="special">::</span><span class="identifier">pair</span><span class="special"><</span> <span class="identifier">assoc_iterator</span><span class="special">,</span> <span class="identifier">assoc_iterator</span> <span class="special">></span> <a class="link" href="basic_ptree.html#id790314-bb"><span class="identifier">equal_range</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">key_type</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span>
<span class="identifier">std</span><span class="special">::</span><span class="identifier">pair</span><span class="special"><</span> <span class="identifier">const_assoc_iterator</span><span class="special">,</span> <span class="identifier">const_assoc_iterator</span> <span class="special">></span>
<a class="link" href="basic_ptree.html#id790333-bb"><span class="identifier">equal_range</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">key_type</span> <span class="special">&</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
<span class="identifier">size_type</span> <a class="link" href="basic_ptree.html#id1140004-bb"><span class="identifier">count</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">key_type</span> <span class="special">&</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
<span class="identifier">size_type</span> <a class="link" href="basic_ptree.html#id1140022-bb"><span class="identifier">erase</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">key_type</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span>
<span class="identifier">iterator</span> <a class="link" href="basic_ptree.html#id1161774-bb"><span class="identifier">to_iterator</span></a><span class="special">(</span><span class="identifier">assoc_iterator</span><span class="special">)</span><span class="special">;</span>
<span class="identifier">const_iterator</span> <a class="link" href="basic_ptree.html#id1156339-bb"><span class="identifier">to_iterator</span></a><span class="special">(</span><span class="identifier">const_assoc_iterator</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
<span class="identifier">data_type</span> <span class="special">&</span> <a class="link" href="basic_ptree.html#id1156364-bb"><span class="identifier">data</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
<span class="keyword">const</span> <span class="identifier">data_type</span> <span class="special">&</span> <a class="link" href="basic_ptree.html#id1156376-bb"><span class="identifier">data</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
<span class="keyword">void</span> <a class="link" href="basic_ptree.html#id1156388-bb"><span class="identifier">clear</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
<a class="link" href="basic_ptree.html#boost.property_tree.basic_ptree.self_type">self_type</a> <span class="special">&</span> <a class="link" href="basic_ptree.html#id1156400-bb"><span class="identifier">get_child</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">path_type</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span>
<span class="keyword">const</span> <a class="link" href="basic_ptree.html#boost.property_tree.basic_ptree.self_type">self_type</a> <span class="special">&</span> <a class="link" href="basic_ptree.html#id1156442-bb"><span class="identifier">get_child</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">path_type</span> <span class="special">&</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
<a class="link" href="basic_ptree.html#boost.property_tree.basic_ptree.self_type">self_type</a> <span class="special">&</span> <a class="link" href="basic_ptree.html#id1156471-bb"><span class="identifier">get_child</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">path_type</span> <span class="special">&</span><span class="special">,</span> <a class="link" href="basic_ptree.html#boost.property_tree.basic_ptree.self_type">self_type</a> <span class="special">&</span><span class="special">)</span><span class="special">;</span>
<span class="keyword">const</span> <a class="link" href="basic_ptree.html#boost.property_tree.basic_ptree.self_type">self_type</a> <span class="special">&</span> <a class="link" href="basic_ptree.html#id1156503-bb"><span class="identifier">get_child</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">path_type</span> <span class="special">&</span><span class="special">,</span> <span class="keyword">const</span> <a class="link" href="basic_ptree.html#boost.property_tree.basic_ptree.self_type">self_type</a> <span class="special">&</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
<span class="identifier">optional</span><span class="special"><</span> <a class="link" href="basic_ptree.html#boost.property_tree.basic_ptree.self_type">self_type</a> <span class="special">&</span> <span class="special">></span> <a class="link" href="basic_ptree.html#id1164545-bb"><span class="identifier">get_child_optional</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">path_type</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span>
<span class="identifier">optional</span><span class="special"><</span> <span class="keyword">const</span> <a class="link" href="basic_ptree.html#boost.property_tree.basic_ptree.self_type">self_type</a> <span class="special">&</span> <span class="special">></span> <a class="link" href="basic_ptree.html#id1164567-bb"><span class="identifier">get_child_optional</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">path_type</span> <span class="special">&</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
<a class="link" href="basic_ptree.html#boost.property_tree.basic_ptree.self_type">self_type</a> <span class="special">&</span> <a class="link" href="basic_ptree.html#id1164589-bb"><span class="identifier">put_child</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">path_type</span> <span class="special">&</span><span class="special">,</span> <span class="keyword">const</span> <a class="link" href="basic_ptree.html#boost.property_tree.basic_ptree.self_type">self_type</a> <span class="special">&</span><span class="special">)</span><span class="special">;</span>
<a class="link" href="basic_ptree.html#boost.property_tree.basic_ptree.self_type">self_type</a> <span class="special">&</span> <a class="link" href="basic_ptree.html#id1164634-bb"><span class="identifier">add_child</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">path_type</span> <span class="special">&</span><span class="special">,</span> <span class="keyword">const</span> <a class="link" href="basic_ptree.html#boost.property_tree.basic_ptree.self_type">self_type</a> <span class="special">&</span><span class="special">)</span><span class="special">;</span>
<span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> Type<span class="special">,</span> <span class="keyword">typename</span> Translator<span class="special">></span>
<span class="emphasis"><em><span class="identifier">unspecified</span></em></span> <a class="link" href="basic_ptree.html#id1164680-bb"><span class="identifier">get_value</span></a><span class="special">(</span><span class="identifier">Translator</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
<span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> Type<span class="special">></span> <span class="identifier">Type</span> <a class="link" href="basic_ptree.html#id801068-bb"><span class="identifier">get_value</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
<span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> Type<span class="special">,</span> <span class="keyword">typename</span> Translator<span class="special">></span>
<span class="identifier">Type</span> <a class="link" href="basic_ptree.html#id801097-bb"><span class="identifier">get_value</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">Type</span> <span class="special">&</span><span class="special">,</span> <span class="identifier">Translator</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
<span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> Ch<span class="special">,</span> <span class="keyword">typename</span> Translator<span class="special">></span>
<span class="emphasis"><em><span class="identifier">unspecified</span></em></span> <a class="link" href="basic_ptree.html#id1161577-bb"><span class="identifier">get_value</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">Ch</span> <span class="special">*</span><span class="special">,</span> <span class="identifier">Translator</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
<span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> Type<span class="special">></span> <span class="emphasis"><em><span class="identifier">unspecified</span></em></span> <a class="link" href="basic_ptree.html#id801169-bb"><span class="identifier">get_value</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">Type</span> <span class="special">&</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
<span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> Ch<span class="special">></span> <span class="emphasis"><em><span class="identifier">unspecified</span></em></span> <a class="link" href="basic_ptree.html#id801202-bb"><span class="identifier">get_value</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">Ch</span> <span class="special">*</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
<span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> Type<span class="special">,</span> <span class="keyword">typename</span> Translator<span class="special">></span>
<span class="identifier">optional</span><span class="special"><</span> <span class="identifier">Type</span> <span class="special">></span> <a class="link" href="basic_ptree.html#id801228-bb"><span class="identifier">get_value_optional</span></a><span class="special">(</span><span class="identifier">Translator</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
<span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> Type<span class="special">></span> <span class="identifier">optional</span><span class="special"><</span> <span class="identifier">Type</span> <span class="special">></span> <a class="link" href="basic_ptree.html#id801262-bb"><span class="identifier">get_value_optional</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
<span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> Type<span class="special">,</span> <span class="keyword">typename</span> Translator<span class="special">></span>
<span class="keyword">void</span> <a class="link" href="basic_ptree.html#id801286-bb"><span class="identifier">put_value</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">Type</span> <span class="special">&</span><span class="special">,</span> <span class="identifier">Translator</span><span class="special">)</span><span class="special">;</span>
<span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> Type<span class="special">></span> <span class="keyword">void</span> <a class="link" href="basic_ptree.html#id801328-bb"><span class="identifier">put_value</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">Type</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span>
<span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> Type<span class="special">,</span> <span class="keyword">typename</span> Translator<span class="special">></span>
<span class="emphasis"><em><span class="identifier">unspecified</span></em></span> <a class="link" href="basic_ptree.html#id801360-bb"><span class="identifier">get</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">path_type</span> <span class="special">&</span><span class="special">,</span> <span class="identifier">Translator</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
<span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> Type<span class="special">></span> <span class="identifier">Type</span> <a class="link" href="basic_ptree.html#id801396-bb"><span class="identifier">get</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">path_type</span> <span class="special">&</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
<span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> Type<span class="special">,</span> <span class="keyword">typename</span> Translator<span class="special">></span>
<span class="identifier">Type</span> <a class="link" href="basic_ptree.html#id801421-bb"><span class="identifier">get</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">path_type</span> <span class="special">&</span><span class="special">,</span> <span class="keyword">const</span> <span class="identifier">Type</span> <span class="special">&</span><span class="special">,</span> <span class="identifier">Translator</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
<span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> Ch<span class="special">,</span> <span class="keyword">typename</span> Translator<span class="special">></span>
<span class="emphasis"><em><span class="identifier">unspecified</span></em></span> <a class="link" href="basic_ptree.html#id801464-bb"><span class="identifier">get</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">path_type</span> <span class="special">&</span><span class="special">,</span> <span class="keyword">const</span> <span class="identifier">Ch</span> <span class="special">*</span><span class="special">,</span> <span class="identifier">Translator</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
<span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> Type<span class="special">></span>
<span class="emphasis"><em><span class="identifier">unspecified</span></em></span> <a class="link" href="basic_ptree.html#id801505-bb"><span class="identifier">get</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">path_type</span> <span class="special">&</span><span class="special">,</span> <span class="keyword">const</span> <span class="identifier">Type</span> <span class="special">&</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
<span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> Ch<span class="special">></span> <span class="emphasis"><em><span class="identifier">unspecified</span></em></span> <a class="link" href="basic_ptree.html#id792428-bb"><span class="identifier">get</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">path_type</span> <span class="special">&</span><span class="special">,</span> <span class="keyword">const</span> <span class="identifier">Ch</span> <span class="special">*</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
<span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> Type<span class="special">,</span> <span class="keyword">typename</span> Translator<span class="special">></span>
<span class="identifier">optional</span><span class="special"><</span> <span class="identifier">Type</span> <span class="special">></span> <a class="link" href="basic_ptree.html#id792460-bb"><span class="identifier">get_optional</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">path_type</span> <span class="special">&</span><span class="special">,</span> <span class="identifier">Translator</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
<span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> Type<span class="special">></span>
<span class="identifier">optional</span><span class="special"><</span> <span class="identifier">Type</span> <span class="special">></span> <a class="link" href="basic_ptree.html#id792501-bb"><span class="identifier">get_optional</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">path_type</span> <span class="special">&</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
<span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> Type<span class="special">,</span> <span class="keyword">typename</span> Translator<span class="special">></span>
<a class="link" href="basic_ptree.html#boost.property_tree.basic_ptree.self_type">self_type</a> <span class="special">&</span> <a class="link" href="basic_ptree.html#id792532-bb"><span class="identifier">put</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">path_type</span> <span class="special">&</span><span class="special">,</span> <span class="keyword">const</span> <span class="identifier">Type</span> <span class="special">&</span><span class="special">,</span> <span class="identifier">Translator</span><span class="special">)</span><span class="special">;</span>
<span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> Type<span class="special">></span> <a class="link" href="basic_ptree.html#boost.property_tree.basic_ptree.self_type">self_type</a> <span class="special">&</span> <a class="link" href="basic_ptree.html#id792587-bb"><span class="identifier">put</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">path_type</span> <span class="special">&</span><span class="special">,</span> <span class="keyword">const</span> <span class="identifier">Type</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span>
<span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> Type<span class="special">,</span> <span class="keyword">typename</span> Translator<span class="special">></span>
<a class="link" href="basic_ptree.html#boost.property_tree.basic_ptree.self_type">self_type</a> <span class="special">&</span> <a class="link" href="basic_ptree.html#id792632-bb"><span class="identifier">add</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">path_type</span> <span class="special">&</span><span class="special">,</span> <span class="keyword">const</span> <span class="identifier">Type</span> <span class="special">&</span><span class="special">,</span> <span class="identifier">Translator</span><span class="special">)</span><span class="special">;</span>
<span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> Type<span class="special">></span> <a class="link" href="basic_ptree.html#boost.property_tree.basic_ptree.self_type">self_type</a> <span class="special">&</span> <a class="link" href="basic_ptree.html#id792700-bb"><span class="identifier">add</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">path_type</span> <span class="special">&</span><span class="special">,</span> <span class="keyword">const</span> <span class="identifier">Type</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span>
<span class="comment">// <a class="link" href="basic_ptree.html#id792798-bb">private member functions</a></span>
<a class="link" href="basic_ptree.html#boost.property_tree.basic_ptree.self_type">self_type</a> <span class="special">*</span> <a class="link" href="basic_ptree.html#id792802-bb"><span class="identifier">walk_path</span></a><span class="special">(</span><span class="identifier">path_type</span> <span class="special">&</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
<a class="link" href="basic_ptree.html#boost.property_tree.basic_ptree.self_type">self_type</a> <span class="special">&</span> <a class="link" href="basic_ptree.html#id792817-bb"><span class="identifier">force_path</span></a><span class="special">(</span><span class="identifier">path_type</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span>
<span class="special">}</span><span class="special">;</span></pre></div>
<div class="refsect1">
<a name="id2608103"></a><h2>Description</h2>
<p>Property tree main structure. A property tree is a hierarchical data structure which has one element of type <code class="computeroutput">Data</code> in each node, as well as an ordered sequence of sub-nodes, which are additionally identified by a non-unique key of type <code class="computeroutput">Key</code>.</p>
<p>Key equivalency is defined by <code class="computeroutput">KeyCompare</code>, a predicate defining a strict weak ordering.</p>
<p>Property tree defines a Container-like interface to the (key-node) pairs of its direct sub-nodes. The iterators are bidirectional. The sequence of nodes is held in insertion order, not key order. </p>
<div class="refsect2">
<a name="id2608138"></a><h3>
<a name="boost.property_tree.basic_ptreetypes"></a><code class="computeroutput">basic_ptree</code>
public
types</h3>
<div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem">
<p>
<span class="keyword">typedef</span> <a class="link" href="basic_ptree.html" title="Class template basic_ptree">basic_ptree</a><span class="special"><</span> <span class="identifier">Key</span><span class="special">,</span> <span class="identifier">Data</span><span class="special">,</span> <span class="identifier">KeyCompare</span> <span class="special">></span> <a name="boost.property_tree.basic_ptree.self_type"></a><span class="identifier">self_type</span><span class="special">;</span></p>
<p>Simpler way to refer to this <a class="link" href="basic_ptree.html" title="Class template basic_ptree">basic_ptree</a><C,K,P,A> type. Note that this is private, and made public only for doxygen. </p>
</li></ol></div>
</div>
<div class="refsect2">
<a name="id2608236"></a><h3>
<a name="boost.property_tree.basic_ptreeconstruct-copy-destruct"></a><code class="computeroutput">basic_ptree</code>
public
construct/copy/destruct</h3>
<div class="orderedlist"><ol class="orderedlist" type="1">
<li class="listitem">
<pre class="literallayout"><a name="id792754-bb"></a><span class="identifier">basic_ptree</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre>
<p>Creates a node with no children and default-constructed data. </p>
</li>
<li class="listitem">
<pre class="literallayout"><span class="keyword">explicit</span> <a name="id792759-bb"></a><span class="identifier">basic_ptree</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">data_type</span> <span class="special">&</span> data<span class="special">)</span><span class="special">;</span></pre>
<p>Creates a node with no children and a copy of the given data. </p>
</li>
<li class="listitem"><pre class="literallayout"><a name="id792773-bb"></a><span class="identifier">basic_ptree</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="basic_ptree.html#boost.property_tree.basic_ptree.self_type">self_type</a> <span class="special">&</span> rhs<span class="special">)</span><span class="special">;</span></pre></li>
<li class="listitem">
<pre class="literallayout">basic_ptree& <a name="id792784-bb"></a><span class="keyword">operator</span><span class="special">=</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="basic_ptree.html#boost.property_tree.basic_ptree.self_type">self_type</a> <span class="special">&</span> rhs<span class="special">)</span><span class="special">;</span></pre>
<p>Basic guarantee only. </p>
</li>
<li class="listitem"><pre class="literallayout"><a name="id792783-bb"></a><span class="special">~</span><span class="identifier">basic_ptree</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre></li>
</ol></div>
</div>
<div class="refsect2">
<a name="id2608481"></a><h3>
<a name="id799768-bb"></a><code class="computeroutput">basic_ptree</code> public member functions</h3>
<div class="orderedlist"><ol class="orderedlist" type="1">
<li class="listitem">
<pre class="literallayout"><span class="keyword">void</span> <a name="id799771-bb"></a><span class="identifier">swap</span><span class="special">(</span><a class="link" href="basic_ptree.html#boost.property_tree.basic_ptree.self_type">self_type</a> <span class="special">&</span> rhs<span class="special">)</span><span class="special">;</span></pre>
<p>Swap with other tree. Only constant-time and nothrow if the data type's swap is. </p>
</li>
<li class="listitem">
<pre class="literallayout"><span class="identifier">size_type</span> <a name="id1159072-bb"></a><span class="identifier">size</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>
<p>The number of direct children of this node. </p>
</li>
<li class="listitem"><pre class="literallayout"><span class="identifier">size_type</span> <a name="id1159084-bb"></a><span class="identifier">max_size</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre></li>
<li class="listitem">
<pre class="literallayout"><span class="keyword">bool</span> <a name="id1159091-bb"></a><span class="identifier">empty</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>
<p>Whether there are any direct children. </p>
</li>
<li class="listitem"><pre class="literallayout"><span class="identifier">iterator</span> <a name="id1159103-bb"></a><span class="identifier">begin</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre></li>
<li class="listitem"><pre class="literallayout"><span class="identifier">const_iterator</span> <a name="id1159111-bb"></a><span class="identifier">begin</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre></li>
<li class="listitem"><pre class="literallayout"><span class="identifier">iterator</span> <a name="id1159118-bb"></a><span class="identifier">end</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre></li>
<li class="listitem"><pre class="literallayout"><span class="identifier">const_iterator</span> <a name="id1159126-bb"></a><span class="identifier">end</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre></li>
<li class="listitem"><pre class="literallayout"><span class="identifier">reverse_iterator</span> <a name="id1159134-bb"></a><span class="identifier">rbegin</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre></li>
<li class="listitem"><pre class="literallayout"><span class="identifier">const_reverse_iterator</span> <a name="id1164279-bb"></a><span class="identifier">rbegin</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre></li>
<li class="listitem"><pre class="literallayout"><span class="identifier">reverse_iterator</span> <a name="id1156004-bb"></a><span class="identifier">rend</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre></li>
<li class="listitem"><pre class="literallayout"><span class="identifier">const_reverse_iterator</span> <a name="id1156012-bb"></a><span class="identifier">rend</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre></li>
<li class="listitem"><pre class="literallayout"><span class="identifier">value_type</span> <span class="special">&</span> <a name="id1156020-bb"></a><span class="identifier">front</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre></li>
<li class="listitem"><pre class="literallayout"><span class="keyword">const</span> <span class="identifier">value_type</span> <span class="special">&</span> <a name="id1156027-bb"></a><span class="identifier">front</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre></li>
<li class="listitem"><pre class="literallayout"><span class="identifier">value_type</span> <span class="special">&</span> <a name="id1156035-bb"></a><span class="identifier">back</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre></li>
<li class="listitem"><pre class="literallayout"><span class="keyword">const</span> <span class="identifier">value_type</span> <span class="special">&</span> <a name="id1156043-bb"></a><span class="identifier">back</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre></li>
<li class="listitem">
<pre class="literallayout"><span class="identifier">iterator</span> <a name="id1156051-bb"></a><span class="identifier">insert</span><span class="special">(</span><span class="identifier">iterator</span> where<span class="special">,</span> <span class="keyword">const</span> <span class="identifier">value_type</span> <span class="special">&</span> value<span class="special">)</span><span class="special">;</span></pre>
<p>Insert a copy of the given tree with its key just before the given position in this node. This operation invalidates no iterators.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term">Returns:</span></p></td>
<td><p>An iterator to the newly created child. </p></td>
</tr></tbody>
</table></div>
</li>
<li class="listitem">
<pre class="literallayout"><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> It<span class="special">></span> <span class="keyword">void</span> <a name="id1156080-bb"></a><span class="identifier">insert</span><span class="special">(</span><span class="identifier">iterator</span> where<span class="special">,</span> <span class="identifier">It</span> first<span class="special">,</span> <span class="identifier">It</span> last<span class="special">)</span><span class="special">;</span></pre>
<p>Range insert. Equivalent to: </p>
<pre class="programlisting"> for(; first != last; ++first) insert(where, *first);
</pre>
<p> </p>
</li>
<li class="listitem">
<pre class="literallayout"><span class="identifier">iterator</span> <a name="id1156120-bb"></a><span class="identifier">erase</span><span class="special">(</span><span class="identifier">iterator</span> where<span class="special">)</span><span class="special">;</span></pre>
<p>Erase the child pointed at by the iterator. This operation invalidates the given iterator, as well as its equivalent assoc_iterator.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term">Returns:</span></p></td>
<td><p>A valid iterator pointing to the element after the erased. </p></td>
</tr></tbody>
</table></div>
</li>
<li class="listitem">
<pre class="literallayout"><span class="identifier">iterator</span> <a name="id1156143-bb"></a><span class="identifier">erase</span><span class="special">(</span><span class="identifier">iterator</span> first<span class="special">,</span> <span class="identifier">iterator</span> last<span class="special">)</span><span class="special">;</span></pre>
<p>Range erase. Equivalent to: </p>
<pre class="programlisting"> while(first != last;) first = erase(first);
</pre>
<p> </p>
</li>
<li class="listitem">
<pre class="literallayout"><span class="identifier">iterator</span> <a name="id1156170-bb"></a><span class="identifier">push_front</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">value_type</span> <span class="special">&</span> value<span class="special">)</span><span class="special">;</span></pre>
<p>Equivalent to insert(begin(), value). </p>
</li>
<li class="listitem">
<pre class="literallayout"><span class="identifier">iterator</span> <a name="id1156187-bb"></a><span class="identifier">push_back</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">value_type</span> <span class="special">&</span> value<span class="special">)</span><span class="special">;</span></pre>
<p>Equivalent to insert(end(), value). </p>
</li>
<li class="listitem">
<pre class="literallayout"><span class="keyword">void</span> <a name="id1156205-bb"></a><span class="identifier">pop_front</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre>
<p>Equivalent to erase(begin()). </p>
</li>
<li class="listitem">
<pre class="literallayout"><span class="keyword">void</span> <a name="id1156216-bb"></a><span class="identifier">pop_back</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre>
<p>Equivalent to erase(boost::prior(end())). </p>
</li>
<li class="listitem">
<pre class="literallayout"><span class="keyword">void</span> <a name="id1156228-bb"></a><span class="identifier">reverse</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre>
<p>Reverses the order of direct children in the property tree. </p>
</li>
<li class="listitem">
<pre class="literallayout"><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> Compare<span class="special">></span> <span class="keyword">void</span> <a name="id1156240-bb"></a><span class="identifier">sort</span><span class="special">(</span><span class="identifier">Compare</span> comp<span class="special">)</span><span class="special">;</span></pre>
<p>Sorts the direct children of this node according to the predicate. The predicate is passed the whole pair of key and child. </p>
</li>
<li class="listitem">
<pre class="literallayout"><span class="keyword">void</span> <a name="id1135993-bb"></a><span class="identifier">sort</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre>
<p>Sorts the direct children of this node according to key order. </p>
</li>
<li class="listitem">
<pre class="literallayout"><span class="keyword">bool</span> <a name="id1136005-bb"></a><span class="keyword">operator</span><span class="special">==</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="basic_ptree.html#boost.property_tree.basic_ptree.self_type">self_type</a> <span class="special">&</span> rhs<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>
<p>Two property trees are the same if they have the same data, the keys and order of their children are the same, and the children compare equal, recursively. </p>
</li>
<li class="listitem"><pre class="literallayout"><span class="keyword">bool</span> <a name="id1136028-bb"></a><span class="keyword">operator</span><span class="special">!=</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="basic_ptree.html#boost.property_tree.basic_ptree.self_type">self_type</a> <span class="special">&</span> rhs<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre></li>
<li class="listitem">
<pre class="literallayout"><span class="identifier">assoc_iterator</span> <a name="id1136045-bb"></a><span class="identifier">ordered_begin</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre>
<p>Returns an iterator to the first child, in key order. </p>
</li>
<li class="listitem">
<pre class="literallayout"><span class="identifier">const_assoc_iterator</span> <a name="id1182593-bb"></a><span class="identifier">ordered_begin</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>
<p>Returns an iterator to the first child, in key order. </p>
</li>
<li class="listitem">
<pre class="literallayout"><span class="identifier">assoc_iterator</span> <a name="id790250-bb"></a><span class="identifier">not_found</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre>
<p>Returns the not-found iterator. Equivalent to end() in a real associative container. </p>
</li>
<li class="listitem">
<pre class="literallayout"><span class="identifier">const_assoc_iterator</span> <a name="id790262-bb"></a><span class="identifier">not_found</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>
<p>Returns the not-found iterator. Equivalent to end() in a real associative container. </p>
</li>
<li class="listitem">
<pre class="literallayout"><span class="identifier">assoc_iterator</span> <a name="id790275-bb"></a><span class="identifier">find</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">key_type</span> <span class="special">&</span> key<span class="special">)</span><span class="special">;</span></pre>
<p>Find a child with the given key, or not_found() if there is none. There is no guarantee about which child is returned if multiple have the same key. </p>
</li>
<li class="listitem">
<pre class="literallayout"><span class="identifier">const_assoc_iterator</span> <a name="id790294-bb"></a><span class="identifier">find</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">key_type</span> <span class="special">&</span> key<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>
<p>Find a child with the given key, or not_found() if there is none. There is no guarantee about which child is returned if multiple have the same key. </p>
</li>
<li class="listitem">
<pre class="literallayout"><span class="identifier">std</span><span class="special">::</span><span class="identifier">pair</span><span class="special"><</span> <span class="identifier">assoc_iterator</span><span class="special">,</span> <span class="identifier">assoc_iterator</span> <span class="special">></span> <a name="id790314-bb"></a><span class="identifier">equal_range</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">key_type</span> <span class="special">&</span> key<span class="special">)</span><span class="special">;</span></pre>
<p>Find the range of children that have the given key. </p>
</li>
<li class="listitem">
<pre class="literallayout"><span class="identifier">std</span><span class="special">::</span><span class="identifier">pair</span><span class="special"><</span> <span class="identifier">const_assoc_iterator</span><span class="special">,</span> <span class="identifier">const_assoc_iterator</span> <span class="special">></span>
<a name="id790333-bb"></a><span class="identifier">equal_range</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">key_type</span> <span class="special">&</span> key<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>
<p>Find the range of children that have the given key. </p>
</li>
<li class="listitem">
<pre class="literallayout"><span class="identifier">size_type</span> <a name="id1140004-bb"></a><span class="identifier">count</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">key_type</span> <span class="special">&</span> key<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>
<p>Count the number of direct children with the given key. </p>
</li>
<li class="listitem">
<pre class="literallayout"><span class="identifier">size_type</span> <a name="id1140022-bb"></a><span class="identifier">erase</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">key_type</span> <span class="special">&</span> key<span class="special">)</span><span class="special">;</span></pre>
<p>Erase all direct children with the given key and return the count. </p>
</li>
<li class="listitem">
<pre class="literallayout"><span class="identifier">iterator</span> <a name="id1161774-bb"></a><span class="identifier">to_iterator</span><span class="special">(</span><span class="identifier">assoc_iterator</span> it<span class="special">)</span><span class="special">;</span></pre>
<p>Get the iterator that points to the same element as the argument. </p>
<div class="note"><table border="0" summary="Note">
<tr>
<td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="../../../../doc/src/images/note.png"></td>
<th align="left">Note</th>
</tr>
<tr><td align="left" valign="top"><p>A valid assoc_iterator range (a, b) does not imply that (to_iterator(a), to_iterator(b)) is a valid range. </p></td></tr>
</table></div>
<p>
</p>
</li>
<li class="listitem">
<pre class="literallayout"><span class="identifier">const_iterator</span> <a name="id1156339-bb"></a><span class="identifier">to_iterator</span><span class="special">(</span><span class="identifier">const_assoc_iterator</span> it<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>
<p>Get the iterator that points to the same element as the argument. </p>
<div class="note"><table border="0" summary="Note">
<tr>
<td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="../../../../doc/src/images/note.png"></td>
<th align="left">Note</th>
</tr>
<tr><td align="left" valign="top"><p>A valid const_assoc_iterator range (a, b) does not imply that (to_iterator(a), to_iterator(b)) is a valid range. </p></td></tr>
</table></div>
<p>
</p>
</li>
<li class="listitem">
<pre class="literallayout"><span class="identifier">data_type</span> <span class="special">&</span> <a name="id1156364-bb"></a><span class="identifier">data</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre>
<p>Reference to the actual data in this node. </p>
</li>
<li class="listitem">
<pre class="literallayout"><span class="keyword">const</span> <span class="identifier">data_type</span> <span class="special">&</span> <a name="id1156376-bb"></a><span class="identifier">data</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>
<p>Reference to the actual data in this node. </p>
</li>
<li class="listitem">
<pre class="literallayout"><span class="keyword">void</span> <a name="id1156388-bb"></a><span class="identifier">clear</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre>
<p>Clear this tree completely, of both data and children. </p>
</li>
<li class="listitem">
<pre class="literallayout"><a class="link" href="basic_ptree.html#boost.property_tree.basic_ptree.self_type">self_type</a> <span class="special">&</span> <a name="id1156400-bb"></a><span class="identifier">get_child</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">path_type</span> <span class="special">&</span> path<span class="special">)</span><span class="special">;</span></pre>
<p>Get the child at the given path, or throw <code class="computeroutput"><code class="computeroutput"><a class="link" href="ptree_bad_path.html" title="Class ptree_bad_path">ptree_bad_path</a></code></code>. </p>
<div class="note"><table border="0" summary="Note">
<tr>
<td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="../../../../doc/src/images/note.png"></td>
<th align="left">Note</th>
</tr>
<tr><td align="left" valign="top">
<p>Depending on the path, the result at each level may not be completely determinate, i.e. if the same key appears multiple times, which child is chosen is not specified. This can lead to the path not being resolved even though there is a descendant with this path. Example: </p>
<pre class="programlisting"> a -> b -> c
-> b
</pre>
<p> The path "a.b.c" will succeed if the resolution of "b" chooses the first such node, but fail if it chooses the second. </p>
</td></tr>
</table></div>
<p>
</p>
</li>
<li class="listitem">
<pre class="literallayout"><span class="keyword">const</span> <a class="link" href="basic_ptree.html#boost.property_tree.basic_ptree.self_type">self_type</a> <span class="special">&</span> <a name="id1156442-bb"></a><span class="identifier">get_child</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">path_type</span> <span class="special">&</span> path<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>
<p>Get the child at the given path, or throw <code class="computeroutput"><code class="computeroutput"><a class="link" href="ptree_bad_path.html" title="Class ptree_bad_path">ptree_bad_path</a></code></code>. </p>
</li>
<li class="listitem">
<pre class="literallayout"><a class="link" href="basic_ptree.html#boost.property_tree.basic_ptree.self_type">self_type</a> <span class="special">&</span> <a name="id1156471-bb"></a><span class="identifier">get_child</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">path_type</span> <span class="special">&</span> path<span class="special">,</span> <a class="link" href="basic_ptree.html#boost.property_tree.basic_ptree.self_type">self_type</a> <span class="special">&</span> default_value<span class="special">)</span><span class="special">;</span></pre>
<p>Get the child at the given path, or return <code class="computeroutput">default_value</code>. </p>
</li>
<li class="listitem">
<pre class="literallayout"><span class="keyword">const</span> <a class="link" href="basic_ptree.html#boost.property_tree.basic_ptree.self_type">self_type</a> <span class="special">&</span>
<a name="id1156503-bb"></a><span class="identifier">get_child</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">path_type</span> <span class="special">&</span> path<span class="special">,</span> <span class="keyword">const</span> <a class="link" href="basic_ptree.html#boost.property_tree.basic_ptree.self_type">self_type</a> <span class="special">&</span> default_value<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>
<p>Get the child at the given path, or return <code class="computeroutput">default_value</code>. </p>
</li>
<li class="listitem">
<pre class="literallayout"><span class="identifier">optional</span><span class="special"><</span> <a class="link" href="basic_ptree.html#boost.property_tree.basic_ptree.self_type">self_type</a> <span class="special">&</span> <span class="special">></span> <a name="id1164545-bb"></a><span class="identifier">get_child_optional</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">path_type</span> <span class="special">&</span> path<span class="special">)</span><span class="special">;</span></pre>
<p>Get the child at the given path, or return boost::null. </p>
</li>
<li class="listitem">
<pre class="literallayout"><span class="identifier">optional</span><span class="special"><</span> <span class="keyword">const</span> <a class="link" href="basic_ptree.html#boost.property_tree.basic_ptree.self_type">self_type</a> <span class="special">&</span> <span class="special">></span> <a name="id1164567-bb"></a><span class="identifier">get_child_optional</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">path_type</span> <span class="special">&</span> path<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>
<p>Get the child at the given path, or return boost::null. </p>
</li>
<li class="listitem">
<pre class="literallayout"><a class="link" href="basic_ptree.html#boost.property_tree.basic_ptree.self_type">self_type</a> <span class="special">&</span> <a name="id1164589-bb"></a><span class="identifier">put_child</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">path_type</span> <span class="special">&</span> path<span class="special">,</span> <span class="keyword">const</span> <a class="link" href="basic_ptree.html#boost.property_tree.basic_ptree.self_type">self_type</a> <span class="special">&</span> value<span class="special">)</span><span class="special">;</span></pre>
<p>Set the node at the given path to the given value. Create any missing parents. If the node at the path already exists, replace it.
</p>
<div class="note"><table border="0" summary="Note">
<tr>
<td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="../../../../doc/src/images/note.png"></td>
<th align="left">Note</th>
</tr>
<tr><td align="left" valign="top">
<p>Because of the way paths work, it is not generally guaranteed that a node newly created can be accessed using the same path. </p>
<p>If the path could refer to multiple nodes, it is unspecified which one gets replaced. </p>
</td></tr>
</table></div>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term">Returns:</span></p></td>
<td><p>A reference to the inserted subtree. </p></td>
</tr></tbody>
</table></div>
</li>
<li class="listitem">
<pre class="literallayout"><a class="link" href="basic_ptree.html#boost.property_tree.basic_ptree.self_type">self_type</a> <span class="special">&</span> <a name="id1164634-bb"></a><span class="identifier">add_child</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">path_type</span> <span class="special">&</span> path<span class="special">,</span> <span class="keyword">const</span> <a class="link" href="basic_ptree.html#boost.property_tree.basic_ptree.self_type">self_type</a> <span class="special">&</span> value<span class="special">)</span><span class="special">;</span></pre>
<p>Add the node at the given path. Create any missing parents. If there already is a node at the path, add another one with the same key.
</p>
<div class="note"><table border="0" summary="Note">
<tr>
<td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="../../../../doc/src/images/note.png"></td>
<th align="left">Note</th>
</tr>
<tr><td align="left" valign="top"><p>Because of the way paths work, it is not generally guaranteed that a node newly created can be accessed using the same path. </p></td></tr>
</table></div>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term">Parameters:</span></p></td>
<td><div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><code class="computeroutput">path</code></span></p></td>
<td><p>Path to the child. The last fragment must not have an index. </p></td>
</tr></tbody>
</table></div></td>
</tr>
<tr>
<td><p><span class="term">Returns:</span></p></td>
<td><p>A reference to the inserted subtree. </p></td>
</tr>
</tbody>
</table></div>
</li>
<li class="listitem">
<pre class="literallayout"><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> Type<span class="special">,</span> <span class="keyword">typename</span> Translator<span class="special">></span>
<span class="emphasis"><em><span class="identifier">unspecified</span></em></span> <a name="id1164680-bb"></a><span class="identifier">get_value</span><span class="special">(</span><span class="identifier">Translator</span> tr<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>
<p>Take the value of this node and attempt to translate it to a <code class="computeroutput">Type</code> object using the supplied translator.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term">Throws:</span></p></td>
<td>
<a class="link" href="ptree_bad_data.html" title="Class ptree_bad_data">ptree_bad_data</a> if the conversion fails. </td>
</tr></tbody>
</table></div>
</li>
<li class="listitem">
<pre class="literallayout"><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> Type<span class="special">></span> <span class="identifier">Type</span> <a name="id801068-bb"></a><span class="identifier">get_value</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>
<p>Take the value of this node and attempt to translate it to a <code class="computeroutput">Type</code> object using the default translator.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term">Throws:</span></p></td>
<td>
<a class="link" href="ptree_bad_data.html" title="Class ptree_bad_data">ptree_bad_data</a> if the conversion fails. </td>
</tr></tbody>
</table></div>
</li>
<li class="listitem">
<pre class="literallayout"><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> Type<span class="special">,</span> <span class="keyword">typename</span> Translator<span class="special">></span>
<span class="identifier">Type</span> <a name="id801097-bb"></a><span class="identifier">get_value</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">Type</span> <span class="special">&</span> default_value<span class="special">,</span> <span class="identifier">Translator</span> tr<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>
<p>Take the value of this node and attempt to translate it to a <code class="computeroutput">Type</code> object using the supplied translator. Return <code class="computeroutput">default_value</code> if this fails. </p>
</li>
<li class="listitem">
<pre class="literallayout"><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> Ch<span class="special">,</span> <span class="keyword">typename</span> Translator<span class="special">></span>
<span class="emphasis"><em><span class="identifier">unspecified</span></em></span> <a name="id1161577-bb"></a><span class="identifier">get_value</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">Ch</span> <span class="special">*</span> default_value<span class="special">,</span> <span class="identifier">Translator</span> tr<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>
<p>Make get_value do the right thing for string literals. </p>
</li>
<li class="listitem">
<pre class="literallayout"><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> Type<span class="special">></span>
<span class="emphasis"><em><span class="identifier">unspecified</span></em></span> <a name="id801169-bb"></a><span class="identifier">get_value</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">Type</span> <span class="special">&</span> default_value<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>
<p>Take the value of this node and attempt to translate it to a <code class="computeroutput">Type</code> object using the default translator. Return <code class="computeroutput">default_value</code> if this fails. </p>
</li>
<li class="listitem">
<pre class="literallayout"><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> Ch<span class="special">></span> <span class="emphasis"><em><span class="identifier">unspecified</span></em></span> <a name="id801202-bb"></a><span class="identifier">get_value</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">Ch</span> <span class="special">*</span> default_value<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>
<p>Make get_value do the right thing for string literals. </p>
</li>
<li class="listitem">
<pre class="literallayout"><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> Type<span class="special">,</span> <span class="keyword">typename</span> Translator<span class="special">></span>
<span class="identifier">optional</span><span class="special"><</span> <span class="identifier">Type</span> <span class="special">></span> <a name="id801228-bb"></a><span class="identifier">get_value_optional</span><span class="special">(</span><span class="identifier">Translator</span> tr<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>
<p>Take the value of this node and attempt to translate it to a <code class="computeroutput">Type</code> object using the supplied translator. Return boost::null if this fails. </p>
</li>
<li class="listitem">
<pre class="literallayout"><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> Type<span class="special">></span> <span class="identifier">optional</span><span class="special"><</span> <span class="identifier">Type</span> <span class="special">></span> <a name="id801262-bb"></a><span class="identifier">get_value_optional</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>
<p>Take the value of this node and attempt to translate it to a <code class="computeroutput">Type</code> object using the default translator. Return boost::null if this fails. </p>
</li>
<li class="listitem">
<pre class="literallayout"><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> Type<span class="special">,</span> <span class="keyword">typename</span> Translator<span class="special">></span>
<span class="keyword">void</span> <a name="id801286-bb"></a><span class="identifier">put_value</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">Type</span> <span class="special">&</span> value<span class="special">,</span> <span class="identifier">Translator</span> tr<span class="special">)</span><span class="special">;</span></pre>
<p>Replace the value at this node with the given value, translated to the tree's data type using the supplied translator.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term">Throws:</span></p></td>
<td>
<a class="link" href="ptree_bad_data.html" title="Class ptree_bad_data">ptree_bad_data</a> if the conversion fails. </td>
</tr></tbody>
</table></div>
</li>
<li class="listitem">
<pre class="literallayout"><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> Type<span class="special">></span> <span class="keyword">void</span> <a name="id801328-bb"></a><span class="identifier">put_value</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">Type</span> <span class="special">&</span> value<span class="special">)</span><span class="special">;</span></pre>
<p>Replace the value at this node with the given value, translated to the tree's data type using the default translator.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term">Throws:</span></p></td>
<td>
<a class="link" href="ptree_bad_data.html" title="Class ptree_bad_data">ptree_bad_data</a> if the conversion fails. </td>
</tr></tbody>
</table></div>
</li>
<li class="listitem">
<pre class="literallayout"><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> Type<span class="special">,</span> <span class="keyword">typename</span> Translator<span class="special">></span>
<span class="emphasis"><em><span class="identifier">unspecified</span></em></span> <a name="id801360-bb"></a><span class="identifier">get</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">path_type</span> <span class="special">&</span> path<span class="special">,</span> <span class="identifier">Translator</span> tr<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>
<p>Shorthand for get_child(path).get_value(tr). </p>
</li>
<li class="listitem">
<pre class="literallayout"><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> Type<span class="special">></span> <span class="identifier">Type</span> <a name="id801396-bb"></a><span class="identifier">get</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">path_type</span> <span class="special">&</span> path<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>
<p>Shorthand for get_child(path).get_value<Type>(). </p>
</li>
<li class="listitem">
<pre class="literallayout"><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> Type<span class="special">,</span> <span class="keyword">typename</span> Translator<span class="special">></span>
<span class="identifier">Type</span> <a name="id801421-bb"></a><span class="identifier">get</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">path_type</span> <span class="special">&</span> path<span class="special">,</span> <span class="keyword">const</span> <span class="identifier">Type</span> <span class="special">&</span> default_value<span class="special">,</span> <span class="identifier">Translator</span> tr<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>
<p>Shorthand for get_child(path, empty_ptree()) .get_value(default_value, tr). That is, return the translated value if possible, and the default value if the node doesn't exist or conversion fails. </p>
</li>
<li class="listitem">
<pre class="literallayout"><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> Ch<span class="special">,</span> <span class="keyword">typename</span> Translator<span class="special">></span>
<span class="emphasis"><em><span class="identifier">unspecified</span></em></span> <a name="id801464-bb"></a><span class="identifier">get</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">path_type</span> <span class="special">&</span> path<span class="special">,</span> <span class="keyword">const</span> <span class="identifier">Ch</span> <span class="special">*</span> default_value<span class="special">,</span>
<span class="identifier">Translator</span> tr<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>
<p>Make get do the right thing for string literals. </p>
</li>
<li class="listitem">
<pre class="literallayout"><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> Type<span class="special">></span>
<span class="emphasis"><em><span class="identifier">unspecified</span></em></span> <a name="id801505-bb"></a><span class="identifier">get</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">path_type</span> <span class="special">&</span> path<span class="special">,</span> <span class="keyword">const</span> <span class="identifier">Type</span> <span class="special">&</span> default_value<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>
<p>Shorthand for get_child(path, empty_ptree()) .get_value(default_value). That is, return the translated value if possible, and the default value if the node doesn't exist or conversion fails. </p>
</li>
<li class="listitem">
<pre class="literallayout"><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> Ch<span class="special">></span>
<span class="emphasis"><em><span class="identifier">unspecified</span></em></span> <a name="id792428-bb"></a><span class="identifier">get</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">path_type</span> <span class="special">&</span> path<span class="special">,</span> <span class="keyword">const</span> <span class="identifier">Ch</span> <span class="special">*</span> default_value<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>
<p>Make get do the right thing for string literals. </p>
</li>
<li class="listitem">
<pre class="literallayout"><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> Type<span class="special">,</span> <span class="keyword">typename</span> Translator<span class="special">></span>
<span class="identifier">optional</span><span class="special"><</span> <span class="identifier">Type</span> <span class="special">></span> <a name="id792460-bb"></a><span class="identifier">get_optional</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">path_type</span> <span class="special">&</span> path<span class="special">,</span> <span class="identifier">Translator</span> tr<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>
<p>Shorthand for: </p>
<pre class="programlisting"> if(optional\<self_type&\> node = get_child_optional(path))
return node->get_value_optional(tr);
return boost::null;
</pre>
<p> That is, return the value if it exists and can be converted, or nil. </p>
</li>
<li class="listitem">
<pre class="literallayout"><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> Type<span class="special">></span>
<span class="identifier">optional</span><span class="special"><</span> <span class="identifier">Type</span> <span class="special">></span> <a name="id792501-bb"></a><span class="identifier">get_optional</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">path_type</span> <span class="special">&</span> path<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>
<p>Shorthand for: </p>
<pre class="programlisting"> if(optional\<const self_type&\> node = get_child_optional(path))
return node->get_value_optional();
return boost::null;
</pre>
<p> That is, return the value if it exists and can be converted, or nil. </p>
</li>
<li class="listitem">
<pre class="literallayout"><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> Type<span class="special">,</span> <span class="keyword">typename</span> Translator<span class="special">></span>
<a class="link" href="basic_ptree.html#boost.property_tree.basic_ptree.self_type">self_type</a> <span class="special">&</span> <a name="id792532-bb"></a><span class="identifier">put</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">path_type</span> <span class="special">&</span> path<span class="special">,</span> <span class="keyword">const</span> <span class="identifier">Type</span> <span class="special">&</span> value<span class="special">,</span> <span class="identifier">Translator</span> tr<span class="special">)</span><span class="special">;</span></pre>
<p>Set the value of the node at the given path to the supplied value, translated to the tree's data type. If the node doesn't exist, it is created, including all its missing parents.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term">Returns:</span></p></td>
<td><p>The node that had its value changed. </p></td>
</tr>
<tr>
<td><p><span class="term">Throws:</span></p></td>
<td>
<a class="link" href="ptree_bad_data.html" title="Class ptree_bad_data">ptree_bad_data</a> if the conversion fails. </td>
</tr>
</tbody>
</table></div>
</li>
<li class="listitem">
<pre class="literallayout"><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> Type<span class="special">></span>
<a class="link" href="basic_ptree.html#boost.property_tree.basic_ptree.self_type">self_type</a> <span class="special">&</span> <a name="id792587-bb"></a><span class="identifier">put</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">path_type</span> <span class="special">&</span> path<span class="special">,</span> <span class="keyword">const</span> <span class="identifier">Type</span> <span class="special">&</span> value<span class="special">)</span><span class="special">;</span></pre>
<p>Set the value of the node at the given path to the supplied value, translated to the tree's data type. If the node doesn't exist, it is created, including all its missing parents.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term">Returns:</span></p></td>
<td><p>The node that had its value changed. </p></td>
</tr>
<tr>
<td><p><span class="term">Throws:</span></p></td>
<td>
<a class="link" href="ptree_bad_data.html" title="Class ptree_bad_data">ptree_bad_data</a> if the conversion fails. </td>
</tr>
</tbody>
</table></div>
</li>
<li class="listitem">
<pre class="literallayout"><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> Type<span class="special">,</span> <span class="keyword">typename</span> Translator<span class="special">></span>
<a class="link" href="basic_ptree.html#boost.property_tree.basic_ptree.self_type">self_type</a> <span class="special">&</span> <a name="id792632-bb"></a><span class="identifier">add</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">path_type</span> <span class="special">&</span> path<span class="special">,</span> <span class="keyword">const</span> <span class="identifier">Type</span> <span class="special">&</span> value<span class="special">,</span> <span class="identifier">Translator</span> tr<span class="special">)</span><span class="special">;</span></pre>
<p>If the node identified by the path does not exist, create it, including all its missing parents. If the node already exists, add a sibling with the same key. Set the newly created node's value to the given paremeter, translated with the supplied translator.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term">Parameters:</span></p></td>
<td><div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><code class="computeroutput">path</code></span></p></td>
<td><p>Path to the child. The last fragment must not have an index. </p></td>
</tr>
<tr>
<td><p><span class="term"><code class="computeroutput">tr</code></span></p></td>
<td><p>The translator to use. </p></td>
</tr>
<tr>
<td><p><span class="term"><code class="computeroutput">value</code></span></p></td>
<td><p>The value to add. </p></td>
</tr>
</tbody>
</table></div></td>
</tr>
<tr>
<td><p><span class="term">Returns:</span></p></td>
<td><p>The node that was added. </p></td>
</tr>
<tr>
<td><p><span class="term">Throws:</span></p></td>
<td>
<a class="link" href="ptree_bad_data.html" title="Class ptree_bad_data">ptree_bad_data</a> if the conversion fails. </td>
</tr>
</tbody>
</table></div>
</li>
<li class="listitem">
<pre class="literallayout"><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> Type<span class="special">></span>
<a class="link" href="basic_ptree.html#boost.property_tree.basic_ptree.self_type">self_type</a> <span class="special">&</span> <a name="id792700-bb"></a><span class="identifier">add</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">path_type</span> <span class="special">&</span> path<span class="special">,</span> <span class="keyword">const</span> <span class="identifier">Type</span> <span class="special">&</span> value<span class="special">)</span><span class="special">;</span></pre>
<p>If the node identified by the path does not exist, create it, including all its missing parents. If the node already exists, add a sibling with the same key. Set the newly created node's value to the given paremeter, translated with the supplied translator.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term">Parameters:</span></p></td>
<td><div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><code class="computeroutput">path</code></span></p></td>
<td><p>Path to the child. The last fragment must not have an index. </p></td>
</tr>
<tr>
<td><p><span class="term"><code class="computeroutput">value</code></span></p></td>
<td><p>The value to add. </p></td>
</tr>
</tbody>
</table></div></td>
</tr>
<tr>
<td><p><span class="term">Returns:</span></p></td>
<td><p>The node that was added. </p></td>
</tr>
<tr>
<td><p><span class="term">Throws:</span></p></td>
<td>
<a class="link" href="ptree_bad_data.html" title="Class ptree_bad_data">ptree_bad_data</a> if the conversion fails. </td>
</tr>
</tbody>
</table></div>
</li>
</ol></div>
</div>
<div class="refsect2">
<a name="id2614050"></a><h3>
<a name="id792798-bb"></a><code class="computeroutput">basic_ptree</code> private member functions</h3>
<div class="orderedlist"><ol class="orderedlist" type="1">
<li class="listitem"><pre class="literallayout"><a class="link" href="basic_ptree.html#boost.property_tree.basic_ptree.self_type">self_type</a> <span class="special">*</span> <a name="id792802-bb"></a><span class="identifier">walk_path</span><span class="special">(</span><span class="identifier">path_type</span> <span class="special">&</span> p<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre></li>
<li class="listitem"><pre class="literallayout"><a class="link" href="basic_ptree.html#boost.property_tree.basic_ptree.self_type">self_type</a> <span class="special">&</span> <a name="id792817-bb"></a><span class="identifier">force_path</span><span class="special">(</span><span class="identifier">path_type</span> <span class="special">&</span> p<span class="special">)</span><span class="special">;</span></pre></li>
</ol></div>
</div>
</div>
</div>
<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
<td align="left"></td>
<td align="right"><div class="copyright-footer">Copyright © 2008 Marcin Kalicinski<p>
Distributed under the Boost Software License, Version 1.0. (See accompanying
file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>)
</p>
</div></td>
</tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="json_parser/write_json_id1137532.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../property_tree/reference.html#header.boost.property_tree.ptree_hpp"><img src="../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="path.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
</div>
</body>
</html>
|
