/usr/share/doc/libucommon-dev/a00090.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 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 | <!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::NamedObject 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="a00090.html">NamedObject</a>
</div>
</div>
<div class="contents">
<h1>ucc::NamedObject Class Reference</h1><!-- doxytag: class="ucc::NamedObject" --><!-- doxytag: inherits="ucc::OrderedObject" -->
<p>A linked object base class with members found by name.
<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::NamedObject:</div>
<div class="dynsection">
<div class="center"><img src="a00455.png" border="0" usemap="#ucc_1_1_named_object_inherit__map" alt="Inheritance graph"/></div>
<map name="ucc_1_1_named_object_inherit__map" id="ucc_1_1_named_object_inherit__map">
<area shape="rect" id="node9" href="a00091.html" title="The named tree class is used to form a tree oriented list of associated objects." alt="" coords="15,315,140,344"/><area shape="rect" id="node2" href="a00100.html" title="A linked object base class for ordered objects." alt="" coords="5,160,149,189"/><area shape="rect" id="node4" 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="node6" href="a00093.html" title="A common base class for all managed objects." alt="" coords="31,5,124,35"/><area shape="rect" id="node11" href="a00174.html" title="Embed data objects into a tree structured memory database." alt="" coords="5,392,149,421"/></map>
<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
<div class="dynheader">
Collaboration diagram for ucc::NamedObject:</div>
<div class="dynsection">
<div class="center"><img src="a00456.png" border="0" usemap="#ucc_1_1_named_object_coll__map" alt="Collaboration graph"/></div>
<map name="ucc_1_1_named_object_coll__map" id="ucc_1_1_named_object_coll__map">
<area shape="rect" id="node2" href="a00100.html" title="A linked object base class for ordered objects." alt="" coords="5,187,149,216"/><area shape="rect" id="node4" href="a00069.html" title="Common base class for all objects that can be formed into a linked list." alt="" coords="11,96,144,125"/><area shape="rect" id="node6" 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>
<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">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00090.html#a6b6b20d3a9f2bd11f3aa06207787c0e7">add</a> (<a class="el" href="a00090.html">NamedObject</a> **hash, char *name, unsigned size=1)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Add object to hash indexed list. <a href="#a6b6b20d3a9f2bd11f3aa06207787c0e7"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="a00090.html#a7fbaae2222c1d426118d0ef9cc9211f2">compare</a> (const char *name) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Compare the name of our object to see if equal. <a href="#a7fbaae2222c1d426118d0ef9cc9211f2"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">char * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00090.html#aac9a46fa502a90af1dfa15f1e3db0f51">getId</a> (void) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the named id string of this object. <a href="#aac9a46fa502a90af1dfa15f1e3db0f51"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00090.html">NamedObject</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00090.html#ac94a45bc0e7e47974b633631618ba7c8">getNext</a> (void) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get next effective object when iterating. <a href="#ac94a45bc0e7e47974b633631618ba7c8"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="a00090.html#a648563d4ccfac1d330a0ee16a7587f9d">operator!=</a> (const char *name) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Comparison operator between our name and a string. <a href="#a648563d4ccfac1d330a0ee16a7587f9d"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="a00090.html#a17f09254985bf541c53fdb6b73f63915">operator==</a> (const char *name) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Comparison operator between our name and a string. <a href="#a17f09254985bf541c53fdb6b73f63915"></a><br/></td></tr>
<tr><td colspan="2"><h2>Static Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static unsigned </td><td class="memItemRight" valign="bottom"><a class="el" href="a00090.html#a27303817912e104e29845b4b6adbdba1">count</a> (<a class="el" href="a00090.html">NamedObject</a> **hash, unsigned size)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Count the total named objects in a hash table. <a href="#a27303817912e104e29845b4b6adbdba1"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static <a class="el" href="a00090.html">NamedObject</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00090.html#ad697807015660c82e4931443e14fb9de">find</a> (<a class="el" href="a00090.html">NamedObject</a> *root, const char *name)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Find a named object from a simple list. <a href="#ad697807015660c82e4931443e14fb9de"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static <a class="el" href="a00090.html">NamedObject</a> ** </td><td class="memItemRight" valign="bottom"><a class="el" href="a00090.html#a76c510c86665294463a10fd182f16489">index</a> (<a class="el" href="a00090.html">NamedObject</a> **hash, unsigned size)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Convert a hash index into a linear object pointer array. <a href="#a76c510c86665294463a10fd182f16489"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static unsigned </td><td class="memItemRight" valign="bottom"><a class="el" href="a00090.html#a2f7e63dabd57c0ae4bee24d6f0786e86">keyindex</a> (const char *name, unsigned size)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Internal function to convert a name to a hash index number. <a href="#a2f7e63dabd57c0ae4bee24d6f0786e86"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static <a class="el" href="a00090.html">NamedObject</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00090.html#a713f9888bf8463255bf98a20915410a1">map</a> (<a class="el" href="a00090.html">NamedObject</a> **hash, const char *name, unsigned size)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Find a named object through a hash map table. <a href="#a713f9888bf8463255bf98a20915410a1"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00090.html#ab83b2a31974926f3b85fc426c09ff4fa">purge</a> (<a class="el" href="a00090.html">NamedObject</a> **hash, unsigned size)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Purge a hash indexed table of named objects. <a href="#ab83b2a31974926f3b85fc426c09ff4fa"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static <a class="el" href="a00090.html">NamedObject</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00090.html#a83a6961633e68e3a2516c380cb90c311">remove</a> (<a class="el" href="a00090.html">NamedObject</a> **hash, const char *name, unsigned size)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Remove an object from a hash map table. <a href="#a83a6961633e68e3a2516c380cb90c311"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static <a class="el" href="a00090.html">NamedObject</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00090.html#a89fc4af807b9301e156bf91a3d37d41b">remove</a> (<a class="el" href="a00090.html">NamedObject</a> **root, const char *name)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Remove a named object from a simple list. <a href="#a89fc4af807b9301e156bf91a3d37d41b"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static <a class="el" href="a00090.html">NamedObject</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00090.html#ac810215405e9dc5670b4dda6f9dd626b">skip</a> (<a class="el" href="a00090.html">NamedObject</a> **hash, <a class="el" href="a00090.html">NamedObject</a> *current, unsigned size)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Iterate through a hash map table. <a href="#ac810215405e9dc5670b4dda6f9dd626b"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static <a class="el" href="a00090.html">NamedObject</a> ** </td><td class="memItemRight" valign="bottom"><a class="el" href="a00090.html#a58d739df66ff9a3e882f326bf9057b9b">sort</a> (<a class="el" href="a00090.html">NamedObject</a> **list, size_t count=0)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Sort an array of named objects in alphabetical order. <a href="#a58d739df66ff9a3e882f326bf9057b9b"></a><br/></td></tr>
<tr><td colspan="2"><h2>Protected Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00090.html#a9b6d0ceb8554a79d5548bef01e7776fc">clearId</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">The behavior of clearing id's can be overriden if they are not assigned as strdup's from the heap. <a href="#a9b6d0ceb8554a79d5548bef01e7776fc"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00090.html#a8de4412595d307a270027b01fe2667e5">NamedObject</a> (<a class="el" href="a00099.html">OrderedIndex</a> *index, char *name)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Created a named object on an ordered list. <a href="#a8de4412595d307a270027b01fe2667e5"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00090.html#a71e1dd09ca13cfb02e664092dff9a07c">NamedObject</a> (<a class="el" href="a00090.html">NamedObject</a> **hash, char *name, unsigned size=1)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Create a named object and add to hash indexed list. <a href="#a71e1dd09ca13cfb02e664092dff9a07c"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a1a1ff8730997acd088d8553fc9939512"></a><!-- doxytag: member="ucc::NamedObject::NamedObject" ref="a1a1ff8730997acd088d8553fc9939512" args="()" -->
</td><td class="memItemRight" valign="bottom"><a class="el" href="a00090.html#a1a1ff8730997acd088d8553fc9939512">NamedObject</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Create an empty unnamed cell object. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00090.html#a05e97552566aaa625b56b373ffa73338">~NamedObject</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Destroy named object. <a href="#a05e97552566aaa625b56b373ffa73338"></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="acb4e8900f98d2ac897dc7371919a20d0"></a><!-- doxytag: member="ucc::NamedObject::id" ref="acb4e8900f98d2ac897dc7371919a20d0" args="" -->
char * </td><td class="memItemRight" valign="bottom"><b>id</b></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>A linked object base class with members found by name. </p>
<p>This class is used to help form named option lists and other forms of name indexed associative data structures. The id is assumed to be passed from a dupped or dynamically allocated string. If a constant string is used then you must not call delete for this object.</p>
<p>Named objects are either listed on an ordered list or keyed through an associate hash map table. When using a hash table, the name id string is used to determine the slot number to use in a list of n sized linked object lists. Hence, a hash index refers to a specific sized array of object indexes. </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#l00379">379</a> of file <a class="el" href="a00195_source.html">linked.h</a>.</p>
<hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="a71e1dd09ca13cfb02e664092dff9a07c"></a><!-- doxytag: member="ucc::NamedObject::NamedObject" ref="a71e1dd09ca13cfb02e664092dff9a07c" args="(NamedObject **hash, char *name, unsigned size=1)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">ucc::NamedObject::NamedObject </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a00090.html">NamedObject</a> ** </td>
<td class="paramname"> <em>hash</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">char * </td>
<td class="paramname"> <em>name</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned </td>
<td class="paramname"> <em>size</em> = <code>1</code></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 named object and add to hash indexed list. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>hash</em> </td><td>map table to list node on. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>name</em> </td><td>of the object we are listing. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>size</em> </td><td>of hash map table used. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a8de4412595d307a270027b01fe2667e5"></a><!-- doxytag: member="ucc::NamedObject::NamedObject" ref="a8de4412595d307a270027b01fe2667e5" args="(OrderedIndex *index, char *name)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">ucc::NamedObject::NamedObject </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a00099.html">OrderedIndex</a> * </td>
<td class="paramname"> <em>index</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>Created a named object on an ordered list. </p>
<p>This is commonly used to form attribute lists. </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>to list object on. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>name</em> </td><td>of the object we are listing. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a05e97552566aaa625b56b373ffa73338"></a><!-- doxytag: member="ucc::NamedObject::~NamedObject" ref="a05e97552566aaa625b56b373ffa73338" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">ucc::NamedObject::~NamedObject </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Destroy named object. </p>
<p>We do not always destroy named objects, since we may use them in reusable pools or we may initialize a list that we keep permenantly. If we do invoke delete for something based on <a class="el" href="a00090.html" title="A linked object base class with members found by name.">NamedObject</a>, then be aware the object id is assumed to be formed from a dup'd string which will also be freed unless clearId is overriden. </p>
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a6b6b20d3a9f2bd11f3aa06207787c0e7"></a><!-- doxytag: member="ucc::NamedObject::add" ref="a6b6b20d3a9f2bd11f3aa06207787c0e7" args="(NamedObject **hash, char *name, unsigned size=1)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ucc::NamedObject::add </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a00090.html">NamedObject</a> ** </td>
<td class="paramname"> <em>hash</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">char * </td>
<td class="paramname"> <em>name</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned </td>
<td class="paramname"> <em>size</em> = <code>1</code></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Add object to hash indexed list. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>hash</em> </td><td>map table to list node on. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>name</em> </td><td>of the object we are listing. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>size</em> </td><td>of hash map table used. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a9b6d0ceb8554a79d5548bef01e7776fc"></a><!-- doxytag: member="ucc::NamedObject::clearId" ref="a9b6d0ceb8554a79d5548bef01e7776fc" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void ucc::NamedObject::clearId </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [protected, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>The behavior of clearing id's can be overriden if they are not assigned as strdup's from the heap. </p>
<p>.. </p>
</div>
</div>
<a class="anchor" id="a7fbaae2222c1d426118d0ef9cc9211f2"></a><!-- doxytag: member="ucc::NamedObject::compare" ref="a7fbaae2222c1d426118d0ef9cc9211f2" args="(const char *name) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual bool ucc::NamedObject::compare </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>name</em></td>
<td> ) </td>
<td> const<code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Compare the name of our object to see if equal. </p>
<p>This is a virtual so that it can be overriden when using named lists or hash lookups that must be case insensitive. </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 compare our name to. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>true if effectivily equal. </dd></dl>
</div>
</div>
<a class="anchor" id="a27303817912e104e29845b4b6adbdba1"></a><!-- doxytag: member="ucc::NamedObject::count" ref="a27303817912e104e29845b4b6adbdba1" args="(NamedObject **hash, unsigned size)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static unsigned ucc::NamedObject::count </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a00090.html">NamedObject</a> ** </td>
<td class="paramname"> <em>hash</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned </td>
<td class="paramname"> <em>size</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Count the total named objects in a hash table. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>hash</em> </td><td>map table of objects to index. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>size</em> </td><td>of hash map table used. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="ad697807015660c82e4931443e14fb9de"></a><!-- doxytag: member="ucc::NamedObject::find" ref="ad697807015660c82e4931443e14fb9de" args="(NamedObject *root, const char *name)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="a00090.html">NamedObject</a>* ucc::NamedObject::find </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a00090.html">NamedObject</a> * </td>
<td class="paramname"> <em>root</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>name</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Find a named object from a simple list. </p>
<p>This may also use the begin() member of an ordered index of named objects. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>root</em> </td><td>node of named object list. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>name</em> </td><td>of object to find. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>object pointer or NULL if not found. </dd></dl>
</div>
</div>
<a class="anchor" id="aac9a46fa502a90af1dfa15f1e3db0f51"></a><!-- doxytag: member="ucc::NamedObject::getId" ref="aac9a46fa502a90af1dfa15f1e3db0f51" args="(void) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">char* ucc::NamedObject::getId </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 named id string of this object. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>name id. </dd></dl>
<p>Definition at line <a class="el" href="a00195_source.html#l00524">524</a> of file <a class="el" href="a00195_source.html">linked.h</a>.</p>
</div>
</div>
<a class="anchor" id="ac94a45bc0e7e47974b633631618ba7c8"></a><!-- doxytag: member="ucc::NamedObject::getNext" ref="ac94a45bc0e7e47974b633631618ba7c8" args="(void) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="a00090.html">NamedObject</a>* ucc::NamedObject::getNext </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 next effective object when iterating. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>next linked object in list. </dd></dl>
<p>Reimplemented from <a class="el" href="a00100.html#a474f11168e0fb3c9674df8ca949958c5">ucc::OrderedObject</a>.</p>
<p>Definition at line <a class="el" href="a00195_source.html#l00517">517</a> of file <a class="el" href="a00195_source.html">linked.h</a>.</p>
</div>
</div>
<a class="anchor" id="a76c510c86665294463a10fd182f16489"></a><!-- doxytag: member="ucc::NamedObject::index" ref="a76c510c86665294463a10fd182f16489" args="(NamedObject **hash, unsigned size)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="a00090.html">NamedObject</a>** ucc::NamedObject::index </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a00090.html">NamedObject</a> ** </td>
<td class="paramname"> <em>hash</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned </td>
<td class="paramname"> <em>size</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Convert a hash index into a linear object pointer array. </p>
<p>The object pointer array is created from the heap and must be deleted when no longer 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>hash</em> </td><td>map table of objects to index. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>size</em> </td><td>of hash map table used. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>array of named object pointers. </dd></dl>
</div>
</div>
<a class="anchor" id="a2f7e63dabd57c0ae4bee24d6f0786e86"></a><!-- doxytag: member="ucc::NamedObject::keyindex" ref="a2f7e63dabd57c0ae4bee24d6f0786e86" args="(const char *name, unsigned size)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static unsigned ucc::NamedObject::keyindex </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>name</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned </td>
<td class="paramname"> <em>size</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Internal function to convert a name to a hash 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>name</em> </td><td>to convert into index. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>size</em> </td><td>of map table. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a713f9888bf8463255bf98a20915410a1"></a><!-- doxytag: member="ucc::NamedObject::map" ref="a713f9888bf8463255bf98a20915410a1" args="(NamedObject **hash, const char *name, unsigned size)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="a00090.html">NamedObject</a>* ucc::NamedObject::map </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a00090.html">NamedObject</a> ** </td>
<td class="paramname"> <em>hash</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>name</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned </td>
<td class="paramname"> <em>size</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Find a named object through a hash map table. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>hash</em> </td><td>map table of objects to search. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>name</em> </td><td>of object to find. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>size</em> </td><td>of hash map table. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>object pointer or NULL if not found. </dd></dl>
</div>
</div>
<a class="anchor" id="a648563d4ccfac1d330a0ee16a7587f9d"></a><!-- doxytag: member="ucc::NamedObject::operator!=" ref="a648563d4ccfac1d330a0ee16a7587f9d" args="(const char *name) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool ucc::NamedObject::operator!= </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>name</em></td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Comparison operator between our name and a string. </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 compare with. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>true if not equal. </dd></dl>
<p>Definition at line <a class="el" href="a00195_source.html#l00549">549</a> of file <a class="el" href="a00195_source.html">linked.h</a>.</p>
</div>
</div>
<a class="anchor" id="a17f09254985bf541c53fdb6b73f63915"></a><!-- doxytag: member="ucc::NamedObject::operator==" ref="a17f09254985bf541c53fdb6b73f63915" args="(const char *name) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool ucc::NamedObject::operator== </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>name</em></td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Comparison operator between our name and a string. </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 compare with. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>true if equal. </dd></dl>
<p>Definition at line <a class="el" href="a00195_source.html#l00541">541</a> of file <a class="el" href="a00195_source.html">linked.h</a>.</p>
</div>
</div>
<a class="anchor" id="ab83b2a31974926f3b85fc426c09ff4fa"></a><!-- doxytag: member="ucc::NamedObject::purge" ref="ab83b2a31974926f3b85fc426c09ff4fa" args="(NamedObject **hash, unsigned size)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static void ucc::NamedObject::purge </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a00090.html">NamedObject</a> ** </td>
<td class="paramname"> <em>hash</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned </td>
<td class="paramname"> <em>size</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Purge a hash indexed table of named objects. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>hash</em> </td><td>map table to purge. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>size</em> </td><td>of hash map table used. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a83a6961633e68e3a2516c380cb90c311"></a><!-- doxytag: member="ucc::NamedObject::remove" ref="a83a6961633e68e3a2516c380cb90c311" args="(NamedObject **hash, const char *name, unsigned size)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="a00090.html">NamedObject</a>* ucc::NamedObject::remove </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a00090.html">NamedObject</a> ** </td>
<td class="paramname"> <em>hash</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>name</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned </td>
<td class="paramname"> <em>size</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Remove an object from a hash map table. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>hash</em> </td><td>map table of object to remove from. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>name</em> </td><td>of object to remove. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>size</em> </td><td>of hash map table. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>object that is removed or NULL if not found. </dd></dl>
</div>
</div>
<a class="anchor" id="a89fc4af807b9301e156bf91a3d37d41b"></a><!-- doxytag: member="ucc::NamedObject::remove" ref="a89fc4af807b9301e156bf91a3d37d41b" args="(NamedObject **root, const char *name)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="a00090.html">NamedObject</a>* ucc::NamedObject::remove </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a00090.html">NamedObject</a> ** </td>
<td class="paramname"> <em>root</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>name</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Remove a named object from a simple list. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>root</em> </td><td>node of named object list. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>name</em> </td><td>of object to find. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>object pointer or NULL if not found. </dd></dl>
</div>
</div>
<a class="anchor" id="ac810215405e9dc5670b4dda6f9dd626b"></a><!-- doxytag: member="ucc::NamedObject::skip" ref="ac810215405e9dc5670b4dda6f9dd626b" args="(NamedObject **hash, NamedObject *current, unsigned size)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="a00090.html">NamedObject</a>* ucc::NamedObject::skip </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a00090.html">NamedObject</a> ** </td>
<td class="paramname"> <em>hash</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="a00090.html">NamedObject</a> * </td>
<td class="paramname"> <em>current</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned </td>
<td class="paramname"> <em>size</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Iterate through a hash map table. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>hash</em> </td><td>map table to iterate. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>current</em> </td><td>named object we iterated or NULL to find start of list. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>size</em> </td><td>of map table. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>next named object in hash map or NULL if no more objects. </dd></dl>
</div>
</div>
<a class="anchor" id="a58d739df66ff9a3e882f326bf9057b9b"></a><!-- doxytag: member="ucc::NamedObject::sort" ref="a58d739df66ff9a3e882f326bf9057b9b" args="(NamedObject **list, size_t count=0)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="a00090.html">NamedObject</a>** ucc::NamedObject::sort </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a00090.html">NamedObject</a> ** </td>
<td class="paramname"> <em>list</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t </td>
<td class="paramname"> <em>count</em> = <code>0</code></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Sort an array of named objects in alphabetical order. </p>
<p>This would typically be used to sort a list created and returned by <a class="el" href="a00090.html#a76c510c86665294463a10fd182f16489" title="Convert a hash index into a linear object pointer array.">index()</a>. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>list</em> </td><td>of named objects to sort. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>count</em> </td><td>of objects in the list or 0 to find by NULL pointer. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>list in sorted order. </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>
|