source: NonGTP/FCollada/Documentation/class_f_u_unique_string_map_t.html @ 964

Revision 964, 8.7 KB checked in by igarcia, 19 years ago (diff)
Line 
1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
3<title>FCollada: FUUniqueStringMapT&lt; STRING_BUILDER &gt; Class Template Reference</title>
4<link href="doxygen.css" rel="stylesheet" type="text/css">
5<link href="tabs.css" rel="stylesheet" type="text/css">
6</head><body>
7<!-- Generated by Doxygen 1.4.6-NO -->
8<div class="tabs">
9  <ul>
10    <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
11    <li><a href="modules.html"><span>Modules</span></a></li>
12    <li><a href="namespaces.html"><span>Namespaces</span></a></li>
13    <li id="current"><a href="classes.html"><span>Classes</span></a></li>
14    <li><a href="files.html"><span>Files</span></a></li>
15    <li><a href="pages.html"><span>Related&nbsp;Pages</span></a></li>
16  </ul></div>
17<div class="tabs">
18  <ul>
19    <li><a href="classes.html"><span>Alphabetical&nbsp;List</span></a></li>
20    <li><a href="annotated.html"><span>Class&nbsp;List</span></a></li>
21    <li><a href="hierarchy.html"><span>Class&nbsp;Hierarchy</span></a></li>
22    <li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
23  </ul></div>
24<h1>FUUniqueStringMapT&lt; STRING_BUILDER &gt; Class Template Reference<br>
25<small>
26[<a class="el" href="group___f_utils.html">Utility Classes.</a>]</small>
27</h1><!-- doxytag: class="FUUniqueStringMapT" --><!-- doxytag: inherits="map&lt; STRING_BUILDER::String, void * &gt;" -->A set of unique strings. 
28<a href="#_details">More...</a>
29<p>
30<code>#include &lt;<a class="el" href="_f_u_unique_string_map_8h-source.html">FUUniqueStringMap.h</a>&gt;</code>
31<p>
32<p>Inheritance diagram for FUUniqueStringMapT&lt; STRING_BUILDER &gt;:
33<p><center><img src="class_f_u_unique_string_map_t.png" usemap="#FUUniqueStringMapT< STRING_BUILDER >_map" border="0" alt=""></center>
34<map name="FUUniqueStringMapT< STRING_BUILDER >_map">
35<area href="classmap.html" alt="map< STRING_BUILDER::String, void * >" shape="rect" coords="0,0,257,24">
36</map>
37<a href="class_f_u_unique_string_map_t-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
38<tr><td></td></tr>
39<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
40<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_u_unique_string_map_t.html#f6a56bd98b5fd7ee049e9f5bc5759e3c">AddUniqueString</a> (typename STRING_BUILDER::String &amp;wantedStr)</td></tr>
41
42<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Adds a string to the map.  <a href="#f6a56bd98b5fd7ee049e9f5bc5759e3c"></a><br></td></tr>
43<tr><td class="memItemLeft" nowrap align="right" valign="top">bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_u_unique_string_map_t.html#a54046c84579345f48e403b9d38adf6d">Exists</a> (const typename STRING_BUILDER::String &amp;str) const </td></tr>
44
45<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Retrieves whether a given string is contained within the map.  <a href="#a54046c84579345f48e403b9d38adf6d"></a><br></td></tr>
46<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_u_unique_string_map_t.html#a1ed539bc716f12e62783ef77b0fa5cb">Erase</a> (const typename STRING_BUILDER::String &amp;str)</td></tr>
47
48<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Erases a string from the map.  <a href="#a1ed539bc716f12e62783ef77b0fa5cb"></a><br></td></tr>
49</table>
50<hr><a name="_details"></a><h2>Detailed Description</h2>
51<h3>template&lt;typename STRING_BUILDER&gt;<br>
52 class FUUniqueStringMapT&lt; STRING_BUILDER &gt;</h3>
53
54A set of unique strings.
55<p>
56This class adds three functions to the STL map in order to keep the strings inside unique: AddUniqueString, Exists and Erase.
57<p>
58<hr><h2>Member Function Documentation</h2>
59<a class="anchor" name="f6a56bd98b5fd7ee049e9f5bc5759e3c"></a><!-- doxytag: member="FUUniqueStringMapT::AddUniqueString" ref="f6a56bd98b5fd7ee049e9f5bc5759e3c" args="(typename STRING_BUILDER::String &amp;wantedStr)" --><p>
60<table class="mdTable" cellpadding="2" cellspacing="0">
61  <tr>
62    <td class="mdRow">
63      <table cellpadding="0" cellspacing="0" border="0">
64        <tr>
65          <td class="mdPrefix" colspan="4">
66template&lt;typename Builder&gt; </td>
67        </tr>
68        <tr>
69          <td class="md" nowrap valign="top">void <a class="el" href="class_f_u_unique_string_map_t.html">FUUniqueStringMapT</a>&lt; Builder &gt;::AddUniqueString           </td>
70          <td class="md" valign="top">(&nbsp;</td>
71          <td class="md" nowrap valign="top">typename STRING_BUILDER::String &amp;&nbsp;</td>
72          <td class="mdname1" valign="top" nowrap> <em>wantedStr</em>          </td>
73          <td class="md" valign="top">&nbsp;)&nbsp;</td>
74          <td class="md" nowrap></td>
75        </tr>
76      </table>
77    </td>
78  </tr>
79</table>
80<table cellspacing="5" cellpadding="0" border="0">
81  <tr>
82    <td>
83      &nbsp;
84    </td>
85    <td>
86
87<p>
88Adds a string to the map.
89<p>
90If the string isn't unique, it will be modified in order to make it unique. <dl compact><dt><b>Parameters:</b></dt><dd>
91  <table border="0" cellspacing="2" cellpadding="0">
92    <tr><td valign="top"></td><td valign="top"><em>wantedStr</em>&nbsp;</td><td>The string to add. This reference will be directly modified to hold the actual unique string added to the map. </td></tr>
93  </table>
94</dl>
95    </td>
96  </tr>
97</table>
98<a class="anchor" name="a1ed539bc716f12e62783ef77b0fa5cb"></a><!-- doxytag: member="FUUniqueStringMapT::Erase" ref="a1ed539bc716f12e62783ef77b0fa5cb" args="(const typename STRING_BUILDER::String &amp;str)" --><p>
99<table class="mdTable" cellpadding="2" cellspacing="0">
100  <tr>
101    <td class="mdRow">
102      <table cellpadding="0" cellspacing="0" border="0">
103        <tr>
104          <td class="mdPrefix" colspan="4">
105template&lt;typename Builder&gt; </td>
106        </tr>
107        <tr>
108          <td class="md" nowrap valign="top">void <a class="el" href="class_f_u_unique_string_map_t.html">FUUniqueStringMapT</a>&lt; Builder &gt;::Erase           </td>
109          <td class="md" valign="top">(&nbsp;</td>
110          <td class="md" nowrap valign="top">const typename STRING_BUILDER::String &amp;&nbsp;</td>
111          <td class="mdname1" valign="top" nowrap> <em>str</em>          </td>
112          <td class="md" valign="top">&nbsp;)&nbsp;</td>
113          <td class="md" nowrap></td>
114        </tr>
115      </table>
116    </td>
117  </tr>
118</table>
119<table cellspacing="5" cellpadding="0" border="0">
120  <tr>
121    <td>
122      &nbsp;
123    </td>
124    <td>
125
126<p>
127Erases a string from the map.
128<p>
129<dl compact><dt><b>Parameters:</b></dt><dd>
130  <table border="0" cellspacing="2" cellpadding="0">
131    <tr><td valign="top"></td><td valign="top"><em>str</em>&nbsp;</td><td>A string contained within the map. </td></tr>
132  </table>
133</dl>
134    </td>
135  </tr>
136</table>
137<a class="anchor" name="a54046c84579345f48e403b9d38adf6d"></a><!-- doxytag: member="FUUniqueStringMapT::Exists" ref="a54046c84579345f48e403b9d38adf6d" args="(const typename STRING_BUILDER::String &amp;str) const " --><p>
138<table class="mdTable" cellpadding="2" cellspacing="0">
139  <tr>
140    <td class="mdRow">
141      <table cellpadding="0" cellspacing="0" border="0">
142        <tr>
143          <td class="mdPrefix" colspan="4">
144template&lt;typename Builder&gt; </td>
145        </tr>
146        <tr>
147          <td class="md" nowrap valign="top">bool <a class="el" href="class_f_u_unique_string_map_t.html">FUUniqueStringMapT</a>&lt; Builder &gt;::Exists           </td>
148          <td class="md" valign="top">(&nbsp;</td>
149          <td class="md" nowrap valign="top">const typename STRING_BUILDER::String &amp;&nbsp;</td>
150          <td class="mdname1" valign="top" nowrap> <em>str</em>          </td>
151          <td class="md" valign="top">&nbsp;)&nbsp;</td>
152          <td class="md" nowrap> const</td>
153        </tr>
154      </table>
155    </td>
156  </tr>
157</table>
158<table cellspacing="5" cellpadding="0" border="0">
159  <tr>
160    <td>
161      &nbsp;
162    </td>
163    <td>
164
165<p>
166Retrieves whether a given string is contained within the map.
167<p>
168<dl compact><dt><b>Parameters:</b></dt><dd>
169  <table border="0" cellspacing="2" cellpadding="0">
170    <tr><td valign="top"></td><td valign="top"><em>str</em>&nbsp;</td><td>The string. </td></tr>
171  </table>
172</dl>
173    </td>
174  </tr>
175</table>
176<hr>The documentation for this class was generated from the following file:<ul>
177<li>FUtils/<a class="el" href="_f_u_unique_string_map_8h-source.html">FUUniqueStringMap.h</a></ul>
178<hr size="1"><address style="align: right;"><small>Generated on Fri May 12 16:44:44 2006 for FCollada by&nbsp;
179<a href="http://www.doxygen.org/index.html">
180<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.6-NO </small></address>
181</body>
182</html>
Note: See TracBrowser for help on using the repository browser.