libmia-2.0-doc 2.0.13-1 / usr / share / doc / mia-2.0 / libdoc / classTDictMap.html

This file is indexed.

/usr/share/doc/mia-2.0/libdoc/classTDictMap.html is in libmia-2.0-doc 2.0.13-1.

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
<!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"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.6"/>
<title>TDictMap&lt; T &gt; Class Template Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<!-- end header part -->
<!-- Generated by Doxygen 1.8.6 -->
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
      <li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
      <li><a href="modules.html"><span>Modules</span></a></li>
      <li class="current"><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
      <li><a href="files.html"><span>Files</span></a></li>
    </ul>
  </div>
  <div id="navrow2" class="tabs2">
    <ul class="tablist">
      <li><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
      <li><a href="classes.html"><span>Data&#160;Structure&#160;Index</span></a></li>
      <li><a href="hierarchy.html"><span>Class&#160;Hierarchy</span></a></li>
      <li><a href="functions.html"><span>Data&#160;Fields</span></a></li>
    </ul>
  </div>
</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="#nested-classes">Data Structures</a> &#124;
<a href="#pub-types">Public Types</a> &#124;
<a href="#pub-methods">Public Member Functions</a>  </div>
  <div class="headertitle">
<div class="title">TDictMap&lt; T &gt; Class Template Reference<div class="ingroups"><a class="el" href="group__cmdline.html">Command line and parameter parsing</a></div></div>  </div>
</div><!--header-->
<div class="contents">

<p>A mapper from emums to string values. - usefull for names flags.  
 <a href="classTDictMap.html#details">More...</a></p>

<p><code>#include &lt;<a class="el" href="dictmap_8hh_source.html">mia/core/dictmap.hh</a>&gt;</code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
Data Structures</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structTDictMap_1_1Table.html">Table</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-types"></a>
Public Types</h2></td></tr>
<tr class="memitem:a632d709bca660216502a11974e2be071"><td class="memItemLeft" align="right" valign="top">typedef std::map&lt; T, std::pair<br class="typebreak"/>
&lt; std::string, std::string &gt; &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTDictMap.html#a632d709bca660216502a11974e2be071">THelpMap</a></td></tr>
<tr class="separator:a632d709bca660216502a11974e2be071"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a47df1ddfc2d16d41b466be8b117197a3"><td class="memItemLeft" align="right" valign="top">const char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTDictMap.html#a47df1ddfc2d16d41b466be8b117197a3">get_help</a> (T value) const </td></tr>
<tr class="separator:a47df1ddfc2d16d41b466be8b117197a3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9ed21b513449ca598efe966922c0159a"><td class="memItemLeft" align="right" valign="top">THelpMap::const_iterator&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTDictMap.html#a9ed21b513449ca598efe966922c0159a">get_help_begin</a> () const </td></tr>
<tr class="separator:a9ed21b513449ca598efe966922c0159a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5b00e6643cb0dbcb06ef34a3b1db5d8d"><td class="memItemLeft" align="right" valign="top">THelpMap::const_iterator&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTDictMap.html#a5b00e6643cb0dbcb06ef34a3b1db5d8d">get_help_end</a> () const </td></tr>
<tr class="separator:a5b00e6643cb0dbcb06ef34a3b1db5d8d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a42260d668a191a68e5aaf0f5e6094bf6"><td class="memItemLeft" align="right" valign="top">const char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTDictMap.html#a42260d668a191a68e5aaf0f5e6094bf6">get_name</a> (T value) const </td></tr>
<tr class="separator:a42260d668a191a68e5aaf0f5e6094bf6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aba38cb30705d0390fae7a88d80222b39"><td class="memItemLeft" align="right" valign="top">const std::set&lt; std::string &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTDictMap.html#aba38cb30705d0390fae7a88d80222b39">get_name_set</a> () const </td></tr>
<tr class="separator:aba38cb30705d0390fae7a88d80222b39"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aef360caf3338d3459854ab004a1cf36c"><td class="memItemLeft" align="right" valign="top">T&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTDictMap.html#aef360caf3338d3459854ab004a1cf36c">get_value</a> (const char *name) const </td></tr>
<tr class="separator:aef360caf3338d3459854ab004a1cf36c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9e008cf6f0a6961697fedda168cff1f3"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTDictMap.html#a9e008cf6f0a6961697fedda168cff1f3">TDictMap</a> (const <a class="el" href="structTDictMap_1_1Table.html">Table</a> *table, bool last_is_default=false)</td></tr>
<tr class="separator:a9e008cf6f0a6961697fedda168cff1f3"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><h3>template&lt;typename T&gt;<br/>
class TDictMap&lt; T &gt;</h3>

<p>A mapper from emums to string values. - usefull for names flags. </p>
<dl class="todo"><dt><b><a class="el" href="todo.html#_todo000003">Todo:</a></b></dt><dd>extend it to also contain help strings for each flag. </dd></dl>

<p>Definition at line <a class="el" href="dictmap_8hh_source.html#l00045">45</a> of file <a class="el" href="dictmap_8hh_source.html">dictmap.hh</a>.</p>
</div><h2 class="groupheader">Member Typedef Documentation</h2>
<a class="anchor" id="a632d709bca660216502a11974e2be071"></a>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename T&gt; </div>
      <table class="memname">
        <tr>
          <td class="memname">typedef std::map&lt;T, std::pair&lt;std::string, std::string&gt; &gt; <a class="el" href="classTDictMap.html">TDictMap</a>&lt; T &gt;::<a class="el" href="classTDictMap.html#a632d709bca660216502a11974e2be071">THelpMap</a></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>This map is used to reference the help strings </p>

<p>Definition at line <a class="el" href="dictmap_8hh_source.html#l00050">50</a> of file <a class="el" href="dictmap_8hh_source.html">dictmap.hh</a>.</p>

</div>
</div>
<h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="a9e008cf6f0a6961697fedda168cff1f3"></a>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename T &gt; </div>
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classTDictMap.html">TDictMap</a>&lt; T &gt;::<a class="el" href="classTDictMap.html">TDictMap</a> </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="structTDictMap_1_1Table.html">Table</a> *&#160;</td>
          <td class="paramname"><em>table</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">bool&#160;</td>
          <td class="paramname"><em>last_is_default</em> = <code>false</code>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Create the map by providing an initialisation map </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">table</td><td>the initialisation table, needs to be terminated by a {NULL, some_value} pair. </td></tr>
    <tr><td class="paramname">last_is_default</td><td><em>true</em> if the value provided with the NULL name is the default return value if unknown names are given. If false, an unknown name in <a class="el" href="classTDictMap.html#aef360caf3338d3459854ab004a1cf36c">get_value()</a> will throw <em>std::invalid_argument</em> exception. </td></tr>
  </table>
  </dd>
</dl>

<p>Definition at line <a class="el" href="dictmap_8hh_source.html#l00131">131</a> of file <a class="el" href="dictmap_8hh_source.html">dictmap.hh</a>.</p>

<p>References <a class="el" href="dictmap_8hh_source.html#l00060">TDictMap&lt; T &gt;::Table::help</a>, <a class="el" href="dictmap_8hh_source.html#l00056">TDictMap&lt; T &gt;::Table::name</a>, and <a class="el" href="dictmap_8hh_source.html#l00058">TDictMap&lt; T &gt;::Table::value</a>.</p>

</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="a47df1ddfc2d16d41b466be8b117197a3"></a>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename T&gt; </div>
      <table class="memname">
        <tr>
          <td class="memname">const char * <a class="el" href="classTDictMap.html">TDictMap</a>&lt; T &gt;::get_help </td>
          <td>(</td>
          <td class="paramtype">T&#160;</td>
          <td class="paramname"><em>value</em></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
</div><div class="memdoc">
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">value</td><td></td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>corresponding flag </dd></dl>
<dl class="section remark"><dt>Remarks</dt><dd>throws std::invalid_argument if the value is unknown </dd></dl>

<p>Definition at line <a class="el" href="dictmap_8hh_source.html#l00178">178</a> of file <a class="el" href="dictmap_8hh_source.html">dictmap.hh</a>.</p>

</div>
</div>
<a class="anchor" id="a9ed21b513449ca598efe966922c0159a"></a>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename T &gt; </div>
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classTDictMap.html">TDictMap</a>&lt; T &gt;::THelpMap::const_iterator <a class="el" href="classTDictMap.html">TDictMap</a>&lt; T &gt;::get_help_begin </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
</div><div class="memdoc">
<dl class="section return"><dt>Returns</dt><dd>start of help map </dd></dl>

<p>Definition at line <a class="el" href="dictmap_8hh_source.html#l00195">195</a> of file <a class="el" href="dictmap_8hh_source.html">dictmap.hh</a>.</p>

</div>
</div>
<a class="anchor" id="a5b00e6643cb0dbcb06ef34a3b1db5d8d"></a>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename T &gt; </div>
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classTDictMap.html">TDictMap</a>&lt; T &gt;::THelpMap::const_iterator <a class="el" href="classTDictMap.html">TDictMap</a>&lt; T &gt;::get_help_end </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
</div><div class="memdoc">
<dl class="section return"><dt>Returns</dt><dd>end of help map </dd></dl>

<p>Definition at line <a class="el" href="dictmap_8hh_source.html#l00201">201</a> of file <a class="el" href="dictmap_8hh_source.html">dictmap.hh</a>.</p>

</div>
</div>
<a class="anchor" id="a42260d668a191a68e5aaf0f5e6094bf6"></a>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename T&gt; </div>
      <table class="memname">
        <tr>
          <td class="memname">const char * <a class="el" href="classTDictMap.html">TDictMap</a>&lt; T &gt;::get_name </td>
          <td>(</td>
          <td class="paramtype">T&#160;</td>
          <td class="paramname"><em>value</em></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
</div><div class="memdoc">
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">value</td><td></td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>corresponding flag </dd></dl>
<dl class="section remark"><dt>Remarks</dt><dd>throws std::invalid_argument if the value is unknown </dd></dl>

<p>Definition at line <a class="el" href="dictmap_8hh_source.html#l00164">164</a> of file <a class="el" href="dictmap_8hh_source.html">dictmap.hh</a>.</p>

</div>
</div>
<a class="anchor" id="aba38cb30705d0390fae7a88d80222b39"></a>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename T &gt; </div>
      <table class="memname">
        <tr>
          <td class="memname">const std::set&lt; std::string &gt; <a class="el" href="classTDictMap.html">TDictMap</a>&lt; T &gt;::get_name_set </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
</div><div class="memdoc">
<dl class="section return"><dt>Returns</dt><dd>a set of all available names </dd></dl>

<p>Definition at line <a class="el" href="dictmap_8hh_source.html#l00187">187</a> of file <a class="el" href="dictmap_8hh_source.html">dictmap.hh</a>.</p>

</div>
</div>
<a class="anchor" id="aef360caf3338d3459854ab004a1cf36c"></a>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename T &gt; </div>
      <table class="memname">
        <tr>
          <td class="memname">T <a class="el" href="classTDictMap.html">TDictMap</a>&lt; T &gt;::get_value </td>
          <td>(</td>
          <td class="paramtype">const char *&#160;</td>
          <td class="paramname"><em>name</em></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
</div><div class="memdoc">
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">name</td><td></td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>corresponding flag </dd></dl>
<dl class="section remark"><dt>Remarks</dt><dd>throws std::invalid_argument if the name is unknown </dd></dl>

<p>Definition at line <a class="el" href="dictmap_8hh_source.html#l00150">150</a> of file <a class="el" href="dictmap_8hh_source.html">dictmap.hh</a>.</p>

</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="dictmap_8hh_source.html">dictmap.hh</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Sat Jan 25 2014 23:52:10 by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.6
</small></address>
</body>
</html>

APT Browse - Built by Thomas Orozco.