/usr/share/doc/libucommon-dev/a00091.html is in libucommon-doc 3.2.0-0ubuntu1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 | <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>UCommon: ucc::NamedTree Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.6.3 -->
<div class="navigation" id="top">
<div class="tabs">
<ul>
<li><a href="main.html"><span>Main Page</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li class="current"><a href="annotated.html"><span>Data Structures</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
<li><a href="examples.html"><span>Examples</span></a></li>
</ul>
</div>
<div class="tabs">
<ul>
<li><a href="annotated.html"><span>Data Structures</span></a></li>
<li><a href="classes.html"><span>Data Structure Index</span></a></li>
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Data Fields</span></a></li>
</ul>
</div>
<div class="navpath"><a class="el" href="a00214.html">ucc</a>::<a class="el" href="a00091.html">NamedTree</a>
</div>
</div>
<div class="contents">
<h1>ucc::NamedTree Class Reference</h1><!-- doxytag: class="ucc::NamedTree" --><!-- doxytag: inherits="ucc::NamedObject" -->
<p>The named tree class is used to form a tree oriented list of associated objects.
<a href="#_details">More...</a></p>
<p><code>#include <<a class="el" href="a00195_source.html">linked.h</a>></code></p>
<div class="dynheader">
Inheritance diagram for ucc::NamedTree:</div>
<div class="dynsection">
<div class="center"><img src="a00457.png" border="0" usemap="#ucc_1_1_named_tree_inherit__map" alt="Inheritance graph"/></div>
<map name="ucc_1_1_named_tree_inherit__map" id="ucc_1_1_named_tree_inherit__map">
<area shape="rect" id="node11" href="a00174.html" title="Embed data objects into a tree structured memory database." alt="" coords="5,392,149,421"/><area shape="rect" id="node2" href="a00090.html" title="A linked object base class with members found by name." alt="" coords="8,237,147,267"/><area shape="rect" id="node4" href="a00100.html" title="A linked object base class for ordered objects." alt="" coords="5,160,149,189"/><area shape="rect" id="node6" href="a00069.html" title="Common base class for all objects that can be formed into a linked list." alt="" coords="11,83,144,112"/><area shape="rect" id="node8" href="a00093.html" title="A common base class for all managed objects." alt="" coords="31,5,124,35"/></map>
<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
<div class="dynheader">
Collaboration diagram for ucc::NamedTree:</div>
<div class="dynsection">
<div class="center"><img src="a00458.png" border="0" usemap="#ucc_1_1_named_tree_coll__map" alt="Collaboration graph"/></div>
<map name="ucc_1_1_named_tree_coll__map" id="ucc_1_1_named_tree_coll__map">
<area shape="rect" id="node2" href="a00090.html" title="A linked object base class with members found by name." alt="" coords="5,299,144,328"/><area shape="rect" id="node4" href="a00100.html" title="A linked object base class for ordered objects." alt="" coords="53,187,197,216"/><area shape="rect" id="node11" href="a00099.html" title="An index container for maintaining an ordered list of objects." alt="" coords="168,299,307,328"/><area shape="rect" id="node6" href="a00069.html" title="Common base class for all objects that can be formed into a linked list." alt="" coords="59,96,192,125"/><area shape="rect" id="node8" href="a00093.html" title="A common base class for all managed objects." alt="" coords="79,5,172,35"/></map>
<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td colspan="2"><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00091.html">NamedTree</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00091.html#a84d23b6cc4602225c7d40459cc9f9dd0">find</a> (const char *name) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Find a child node of our object with the specified name. <a href="#a84d23b6cc4602225c7d40459cc9f9dd0"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00091.html">NamedTree</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00091.html#aa3fe17109a62ae9aaa939dfd5296b95b">getChild</a> (const char *name) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Find a direct child of our node which matches the specified name. <a href="#aa3fe17109a62ae9aaa939dfd5296b95b"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00091.html">NamedTree</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00091.html#ad553ecec86497e7ae7aba4cd646baaee">getFirst</a> (void) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get first child node in our ordered list of children. <a href="#ad553ecec86497e7ae7aba4cd646baaee"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00099.html">OrderedIndex</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00091.html#a10ffac7ad77a894dc7263fcd58663e48">getIndex</a> (void) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the ordered index of our child nodes. <a href="#a10ffac7ad77a894dc7263fcd58663e48"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00091.html">NamedTree</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00091.html#a004db01da217bd59aff1de44cc91a947">getIndexed</a> (unsigned index) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get child by index number. <a href="#a004db01da217bd59aff1de44cc91a947"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00091.html">NamedTree</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00091.html#a382cef4fac0e2bb9570c4a60c0f06c14">getLeaf</a> (const char *name) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Find a direct leaf node on our node. <a href="#a382cef4fac0e2bb9570c4a60c0f06c14"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00091.html">NamedTree</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00091.html#a9897638754f6d57453002582e281dc07">getParent</a> (void) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get parent node we are listed as a child on. <a href="#a9897638754f6d57453002582e281dc07"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="a00091.html#ae9ad15913b1c5f42feed8715c67e1f93">isLeaf</a> (void) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Test if node has children. <a href="#ae9ad15913b1c5f42feed8715c67e1f93"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="a00091.html#a9ecda05f7d9e721a80e91da1d9c13044">isRoot</a> (void) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Test if node is root node. <a href="#a9ecda05f7d9e721a80e91da1d9c13044"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00091.html">NamedTree</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00091.html#a5b699c18c902a8e024baf50575b32fa5">leaf</a> (const char *name) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Find a child leaf node of our object with the specified name. <a href="#a5b699c18c902a8e024baf50575b32fa5"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00091.html#a8595e2fc2dd69c2e24037950015ac9d8">operator bool</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Test if this node has a name. <a href="#a8595e2fc2dd69c2e24037950015ac9d8"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="a00091.html#a4a65caa183a600dd141ac2ba3bcfdabf">operator!</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Test if this node is unnamed. <a href="#a4a65caa183a600dd141ac2ba3bcfdabf"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00091.html">NamedTree</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00091.html#a65609593e61f90ccd3f7a3d57b1a3c33">path</a> (const char *path) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Find a subnode by a dot seperated list of node names. <a href="#a65609593e61f90ccd3f7a3d57b1a3c33"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00091.html#ab8dba2e7749b0f4aaf55422e4b39beb1">relist</a> (<a class="el" href="a00091.html">NamedTree</a> *trunk=NULL)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Default relist is by tail. <a href="#ab8dba2e7749b0f4aaf55422e4b39beb1"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00091.html#af78cf88212666bad33ed16aed6891a20">relistHead</a> (<a class="el" href="a00091.html">NamedTree</a> *trunk)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Add leaf to a trunk, by reverse order. <a href="#af78cf88212666bad33ed16aed6891a20"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00091.html#a8ee67376e7f08d207200aeaa3fa04933">relistTail</a> (<a class="el" href="a00091.html">NamedTree</a> *trunk)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Add leaf to a trunk, by order. <a href="#a8ee67376e7f08d207200aeaa3fa04933"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00091.html#a53bb31249199b7cd5ba71f1a30808ea3">remove</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Remove our node from our parent list. <a href="#a53bb31249199b7cd5ba71f1a30808ea3"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00091.html#af192cb210e15707f84bdb935f699bef2">setId</a> (char *name)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set or replace the name id of this node. <a href="#af192cb210e15707f84bdb935f699bef2"></a><br/></td></tr>
<tr><td colspan="2"><h2>Protected Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00091.html#a5de77ca06bc9f2d1eab4a3734d340620">NamedTree</a> (const <a class="el" href="a00091.html">NamedTree</a> &source)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Construct a copy of the tree. <a href="#a5de77ca06bc9f2d1eab4a3734d340620"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00091.html#a09141f2987c0ae27858f3bc0f293e3c9">NamedTree</a> (<a class="el" href="a00091.html">NamedTree</a> *parent, char *name)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Create a tree node as a child of an existing node. <a href="#a09141f2987c0ae27858f3bc0f293e3c9"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00091.html#a367bf3d971d20752889e20c99861bdc2">NamedTree</a> (char *name=NULL)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Create a stand-alone or root tree node, with an optional name. <a href="#a367bf3d971d20752889e20c99861bdc2"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00091.html#a9b541c664524bccca16f767ffabb18f5">purge</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Performs object destruction. <a href="#a9b541c664524bccca16f767ffabb18f5"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="a00091.html#a362528d9db1e8116c553791bdaeb7e81">~NamedTree</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Delete node in a tree. <a href="#a362528d9db1e8116c553791bdaeb7e81"></a><br/></td></tr>
<tr><td colspan="2"><h2>Protected Attributes</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a0952ca7fd92936306348fa83527c634b"></a><!-- doxytag: member="ucc::NamedTree::child" ref="a0952ca7fd92936306348fa83527c634b" args="" -->
<a class="el" href="a00099.html">OrderedIndex</a> </td><td class="memItemRight" valign="bottom"><b>child</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="acef66ec4fd1a460ddbf6277a2effbd88"></a><!-- doxytag: member="ucc::NamedTree::parent" ref="acef66ec4fd1a460ddbf6277a2effbd88" args="" -->
<a class="el" href="a00091.html">NamedTree</a> * </td><td class="memItemRight" valign="bottom"><b>parent</b></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>The named tree class is used to form a tree oriented list of associated objects. </p>
<p>Typical uses for such data structures might be to form a parsed XML document, or for forming complex configuration management systems or for forming system resource management trees. </p>
<dl class="author"><dt><b>Author:</b></dt><dd>David Sugar <<a href="mailto:dyfet@gnutelephony.org">dyfet@gnutelephony.org</a>> </dd></dl>
<p>Definition at line <a class="el" href="a00195_source.html#l00560">560</a> of file <a class="el" href="a00195_source.html">linked.h</a>.</p>
<hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="a367bf3d971d20752889e20c99861bdc2"></a><!-- doxytag: member="ucc::NamedTree::NamedTree" ref="a367bf3d971d20752889e20c99861bdc2" args="(char *name=NULL)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">ucc::NamedTree::NamedTree </td>
<td>(</td>
<td class="paramtype">char * </td>
<td class="paramname"> <em>name</em> = <code>NULL</code></td>
<td> ) </td>
<td><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Create a stand-alone or root tree node, with an optional name. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>name</em> </td><td>for this node. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a09141f2987c0ae27858f3bc0f293e3c9"></a><!-- doxytag: member="ucc::NamedTree::NamedTree" ref="a09141f2987c0ae27858f3bc0f293e3c9" args="(NamedTree *parent, char *name)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">ucc::NamedTree::NamedTree </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a00091.html">NamedTree</a> * </td>
<td class="paramname"> <em>parent</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">char * </td>
<td class="paramname"> <em>name</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Create a tree node as a child of an existing node. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>parent</em> </td><td>node we are listed under. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>name</em> </td><td>of our node. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a5de77ca06bc9f2d1eab4a3734d340620"></a><!-- doxytag: member="ucc::NamedTree::NamedTree" ref="a5de77ca06bc9f2d1eab4a3734d340620" args="(const NamedTree &source)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">ucc::NamedTree::NamedTree </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="a00091.html">NamedTree</a> & </td>
<td class="paramname"> <em>source</em></td>
<td> ) </td>
<td><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Construct a copy of the tree. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>source</em> </td><td>object to copy from. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a362528d9db1e8116c553791bdaeb7e81"></a><!-- doxytag: member="ucc::NamedTree::~NamedTree" ref="a362528d9db1e8116c553791bdaeb7e81" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual ucc::NamedTree::~NamedTree </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [protected, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Delete node in a tree. </p>
<p>If we delete a node, we must delist it from it's parent. We must also delink any child nodes. This is done by calling the <a class="el" href="a00091.html#a9b541c664524bccca16f767ffabb18f5" title="Performs object destruction.">purge()</a> member. </p>
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a84d23b6cc4602225c7d40459cc9f9dd0"></a><!-- doxytag: member="ucc::NamedTree::find" ref="a84d23b6cc4602225c7d40459cc9f9dd0" args="(const char *name) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="a00091.html">NamedTree</a>* ucc::NamedTree::find </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>name</em></td>
<td> ) </td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Find a child node of our object with the specified name. </p>
<p>This will also recursivily search all child nodes that have children until the named node can be found. This seeks a child node that has children. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>name</em> </td><td>to search for. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>tree object found or NULL. </dd></dl>
<p>Reimplemented in <a class="el" href="a00174.html#ab750326ecdac8709d1edae78c5d80342">ucc::treemap< T ></a>.</p>
</div>
</div>
<a class="anchor" id="aa3fe17109a62ae9aaa939dfd5296b95b"></a><!-- doxytag: member="ucc::NamedTree::getChild" ref="aa3fe17109a62ae9aaa939dfd5296b95b" args="(const char *name) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="a00091.html">NamedTree</a>* ucc::NamedTree::getChild </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>name</em></td>
<td> ) </td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Find a direct child of our node which matches the specified name. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>name</em> </td><td>of child node to find. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>tree node object of child or NULL. </dd></dl>
<p>Reimplemented in <a class="el" href="a00174.html#a3b58b2c542b9405011d5638217d3b99d">ucc::treemap< T ></a>.</p>
</div>
</div>
<a class="anchor" id="ad553ecec86497e7ae7aba4cd646baaee"></a><!-- doxytag: member="ucc::NamedTree::getFirst" ref="ad553ecec86497e7ae7aba4cd646baaee" args="(void) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="a00091.html">NamedTree</a>* ucc::NamedTree::getFirst </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Get first child node in our ordered list of children. </p>
<p>This might be used to iterate child nodes. This may also be used to get unamed child nodes. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>first child node or NULL if no children. </dd></dl>
<p>Reimplemented in <a class="el" href="a00174.html#a0db1c39391cc461581f6f7a9461434b4">ucc::treemap< T ></a>.</p>
<p>Definition at line <a class="el" href="a00195_source.html#l00652">652</a> of file <a class="el" href="a00195_source.html">linked.h</a>.</p>
</div>
</div>
<a class="anchor" id="a10ffac7ad77a894dc7263fcd58663e48"></a><!-- doxytag: member="ucc::NamedTree::getIndex" ref="a10ffac7ad77a894dc7263fcd58663e48" args="(void) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="a00099.html">OrderedIndex</a>* ucc::NamedTree::getIndex </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Get the ordered index of our child nodes. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>ordered index of our children. </dd></dl>
<p>Definition at line <a class="el" href="a00195_source.html#l00674">674</a> of file <a class="el" href="a00195_source.html">linked.h</a>.</p>
</div>
</div>
<a class="anchor" id="a004db01da217bd59aff1de44cc91a947"></a><!-- doxytag: member="ucc::NamedTree::getIndexed" ref="a004db01da217bd59aff1de44cc91a947" args="(unsigned index) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="a00091.html">NamedTree</a>* ucc::NamedTree::getIndexed </td>
<td>(</td>
<td class="paramtype">unsigned </td>
<td class="paramname"> <em>index</em></td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Get child by index number. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>index</em> </td><td>of child to fetch. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>indexed child node. </dd></dl>
<p>Reimplemented in <a class="el" href="a00174.html#a4e4071e8056e601684504483511fb2f7">ucc::treemap< T ></a>.</p>
<p>Definition at line <a class="el" href="a00195_source.html#l00667">667</a> of file <a class="el" href="a00195_source.html">linked.h</a>.</p>
</div>
</div>
<a class="anchor" id="a382cef4fac0e2bb9570c4a60c0f06c14"></a><!-- doxytag: member="ucc::NamedTree::getLeaf" ref="a382cef4fac0e2bb9570c4a60c0f06c14" args="(const char *name) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="a00091.html">NamedTree</a>* ucc::NamedTree::getLeaf </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>name</em></td>
<td> ) </td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Find a direct leaf node on our node. </p>
<p>A leaf node is a node that has no children of it's own. This does not perform a recursive search. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>name</em> </td><td>of leaf child node to find. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>tree node object of leaf or NULL. </dd></dl>
<p>Reimplemented in <a class="el" href="a00174.html#af64983695bcc19b1f9749addfdeab82f">ucc::treemap< T ></a>.</p>
</div>
</div>
<a class="anchor" id="a9897638754f6d57453002582e281dc07"></a><!-- doxytag: member="ucc::NamedTree::getParent" ref="a9897638754f6d57453002582e281dc07" args="(void) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="a00091.html">NamedTree</a>* ucc::NamedTree::getParent </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Get parent node we are listed as a child on. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>parent node or NULL if none. </dd></dl>
<p>Reimplemented in <a class="el" href="a00174.html#acd4b3beb01b0b09b1cda682496f91a35">ucc::treemap< T ></a>.</p>
<p>Definition at line <a class="el" href="a00195_source.html#l00659">659</a> of file <a class="el" href="a00195_source.html">linked.h</a>.</p>
</div>
</div>
<a class="anchor" id="ae9ad15913b1c5f42feed8715c67e1f93"></a><!-- doxytag: member="ucc::NamedTree::isLeaf" ref="ae9ad15913b1c5f42feed8715c67e1f93" args="(void) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool ucc::NamedTree::isLeaf </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Test if node has children. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>true if node contains child nodes. </dd></dl>
<p>Definition at line <a class="el" href="a00195_source.html#l00708">708</a> of file <a class="el" href="a00195_source.html">linked.h</a>.</p>
</div>
</div>
<a class="anchor" id="a9ecda05f7d9e721a80e91da1d9c13044"></a><!-- doxytag: member="ucc::NamedTree::isRoot" ref="a9ecda05f7d9e721a80e91da1d9c13044" args="(void) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool ucc::NamedTree::isRoot </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Test if node is root node. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>true if node is root node. </dd></dl>
<p>Definition at line <a class="el" href="a00195_source.html#l00715">715</a> of file <a class="el" href="a00195_source.html">linked.h</a>.</p>
</div>
</div>
<a class="anchor" id="a5b699c18c902a8e024baf50575b32fa5"></a><!-- doxytag: member="ucc::NamedTree::leaf" ref="a5b699c18c902a8e024baf50575b32fa5" args="(const char *name) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="a00091.html">NamedTree</a>* ucc::NamedTree::leaf </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>name</em></td>
<td> ) </td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Find a child leaf node of our object with the specified name. </p>
<p>This will recursivily search all our child nodes until it can find a leaf node containing the specified id but that holds no further children. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>name</em> </td><td>of leaf node to search for. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>tree node object found or NULL. </dd></dl>
<p>Reimplemented in <a class="el" href="a00174.html#a18c64639889fb23e2a3a3e835713afa9">ucc::treemap< T ></a>.</p>
</div>
</div>
<a class="anchor" id="a8595e2fc2dd69c2e24037950015ac9d8"></a><!-- doxytag: member="ucc::NamedTree::operator bool" ref="a8595e2fc2dd69c2e24037950015ac9d8" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">ucc::NamedTree::operator bool </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Test if this node has a name. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>true if name is set. </dd></dl>
<p>Definition at line <a class="el" href="a00195_source.html#l00681">681</a> of file <a class="el" href="a00195_source.html">linked.h</a>.</p>
</div>
</div>
<a class="anchor" id="a4a65caa183a600dd141ac2ba3bcfdabf"></a><!-- doxytag: member="ucc::NamedTree::operator!" ref="a4a65caa183a600dd141ac2ba3bcfdabf" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool ucc::NamedTree::operator! </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Test if this node is unnamed. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>false if name is set. </dd></dl>
<p>Definition at line <a class="el" href="a00195_source.html#l00688">688</a> of file <a class="el" href="a00195_source.html">linked.h</a>.</p>
</div>
</div>
<a class="anchor" id="a65609593e61f90ccd3f7a3d57b1a3c33"></a><!-- doxytag: member="ucc::NamedTree::path" ref="a65609593e61f90ccd3f7a3d57b1a3c33" args="(const char *path) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="a00091.html">NamedTree</a>* ucc::NamedTree::path </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>path</em></td>
<td> ) </td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Find a subnode by a dot seperated list of node names. </p>
<p>If one or more lead dots are used, then the search will go through parent node levels of our node. The dot seperated list could be thought of as a kind of pathname where dot is used like slash. This implies that individual nodes can never use names which contain dot's if the path function will be used. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>path</em> </td><td>name string being sought. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>tree node object found at the path or NULL. </dd></dl>
<p>Reimplemented in <a class="el" href="a00174.html#aefc2e13654080ca0963f4ffd3a3637f8">ucc::treemap< T ></a>.</p>
</div>
</div>
<a class="anchor" id="a9b541c664524bccca16f767ffabb18f5"></a><!-- doxytag: member="ucc::NamedTree::purge" ref="a9b541c664524bccca16f767ffabb18f5" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ucc::NamedTree::purge </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Performs object destruction. </p>
<p>Note, if we delete a named tree object the name of our member object is assumed to be a dynamically allocated string that will also be free'd. </p>
</div>
</div>
<a class="anchor" id="ab8dba2e7749b0f4aaf55422e4b39beb1"></a><!-- doxytag: member="ucc::NamedTree::relist" ref="ab8dba2e7749b0f4aaf55422e4b39beb1" args="(NamedTree *trunk=NULL)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ucc::NamedTree::relist </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a00091.html">NamedTree</a> * </td>
<td class="paramname"> <em>trunk</em> = <code>NULL</code></td>
<td> ) </td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Default relist is by tail. </p>
<p>.. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>trunk</em> </td><td>we add leaf node to, NULL to delist. </td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="a00195_source.html#l00734">734</a> of file <a class="el" href="a00195_source.html">linked.h</a>.</p>
</div>
</div>
<a class="anchor" id="af78cf88212666bad33ed16aed6891a20"></a><!-- doxytag: member="ucc::NamedTree::relistHead" ref="af78cf88212666bad33ed16aed6891a20" args="(NamedTree *trunk)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ucc::NamedTree::relistHead </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a00091.html">NamedTree</a> * </td>
<td class="paramname"> <em>trunk</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Add leaf to a trunk, by reverse order. </p>
<p>If NULL, just remove. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>trunk</em> </td><td>we add leaf node to. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a8ee67376e7f08d207200aeaa3fa04933"></a><!-- doxytag: member="ucc::NamedTree::relistTail" ref="a8ee67376e7f08d207200aeaa3fa04933" args="(NamedTree *trunk)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ucc::NamedTree::relistTail </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a00091.html">NamedTree</a> * </td>
<td class="paramname"> <em>trunk</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Add leaf to a trunk, by order. </p>
<p>If NULL, just remove. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>trunk</em> </td><td>we add leaf node to. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a53bb31249199b7cd5ba71f1a30808ea3"></a><!-- doxytag: member="ucc::NamedTree::remove" ref="a53bb31249199b7cd5ba71f1a30808ea3" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ucc::NamedTree::remove </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Remove our node from our parent list. </p>
<p>The name is set to NULL to keep delete from freeing the name string. </p>
</div>
</div>
<a class="anchor" id="af192cb210e15707f84bdb935f699bef2"></a><!-- doxytag: member="ucc::NamedTree::setId" ref="af192cb210e15707f84bdb935f699bef2" args="(char *name)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ucc::NamedTree::setId </td>
<td>(</td>
<td class="paramtype">char * </td>
<td class="paramname"> <em>name</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Set or replace the name id of this node. </p>
<p>This will free the string if a name had already been set. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>name</em> </td><td>for this node to set. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>ucommon/<a class="el" href="a00195_source.html">linked.h</a></li>
</ul>
</div>
<hr class="footer"/><address style="text-align: right;"><small>Generated on Tue Jul 6 08:22:36 2010 for UCommon by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.3 </small></address>
</body>
</html>
|