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

This file is indexed.

/usr/share/doc/mia-2.0/libdoc/classCSetParameter.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
<!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>CSetParameter&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="#pub-methods">Public Member Functions</a> &#124;
<a href="#pro-methods">Protected Member Functions</a>  </div>
  <div class="headertitle">
<div class="title">CSetParameter&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 parameter that can only assume values out of a limited set.  
 <a href="classCSetParameter.html#details">More...</a></p>

<p><code>#include &lt;<a class="el" href="parameter_8hh_source.html">mia/core/parameter.hh</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for CSetParameter&lt; T &gt;:</div>
<div class="dyncontent">
 <div class="center">
  <img src="classCSetParameter.png" usemap="#CSetParameter&lt; T &gt;_map" alt=""/>
  <map id="CSetParameter&lt; T &gt;_map" name="CSetParameter&lt; T &gt;_map">
<area href="classCParameter.html" title="The base class for parameters used in complex options. " alt="CParameter" shape="rect" coords="0,0,128,24"/>
</map>
 </div></div>
<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:a2d2f96693b5146b5fdc500bf32f677fd"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCSetParameter.html#a2d2f96693b5146b5fdc500bf32f677fd">CSetParameter</a> (T &amp;<a class="el" href="classCParameter.html#a6264144ef3f115af00021a632264db8e">value</a>, const std::set&lt; T &gt; &amp;valid_set, const char *<a class="el" href="classCParameter.html#a882ad136c7c557d332e215590f43b529">descr</a>, bool required=false)</td></tr>
<tr class="separator:a2d2f96693b5146b5fdc500bf32f677fd"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pub_methods_classCParameter"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classCParameter')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="classCParameter.html">CParameter</a></td></tr>
<tr class="memitem:a94ba12dbfab92b213f573c10726cbcca inherit pub_methods_classCParameter"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCParameter.html#a94ba12dbfab92b213f573c10726cbcca">add_dependend_handler</a> (<a class="el" href="group__plugin.html#ga63c695cc3368b6ba07f01350034502d4">HandlerHelpMap</a> &amp;handler_map) const </td></tr>
<tr class="separator:a94ba12dbfab92b213f573c10726cbcca inherit pub_methods_classCParameter"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6d74e5adaecc979ca8b61e67b35b89a5 inherit pub_methods_classCParameter"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCParameter.html#a6d74e5adaecc979ca8b61e67b35b89a5">CParameter</a> (const char <a class="el" href="classCParameter.html#a9fbb02a366339bccbb8dc48401fe0a4e">type</a>[], bool required, const char *<a class="el" href="classCParameter.html#a882ad136c7c557d332e215590f43b529">descr</a>)</td></tr>
<tr class="separator:a6d74e5adaecc979ca8b61e67b35b89a5 inherit pub_methods_classCParameter"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a882ad136c7c557d332e215590f43b529 inherit pub_methods_classCParameter"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCParameter.html#a882ad136c7c557d332e215590f43b529">descr</a> (std::ostream &amp;os) const </td></tr>
<tr class="separator:a882ad136c7c557d332e215590f43b529 inherit pub_methods_classCParameter"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a50e0585eb4f6aec6e7f06a1ad57a00a1 inherit pub_methods_classCParameter"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCParameter.html#a50e0585eb4f6aec6e7f06a1ad57a00a1">get_default_value</a> () const </td></tr>
<tr class="separator:a50e0585eb4f6aec6e7f06a1ad57a00a1 inherit pub_methods_classCParameter"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad2dd0218fb8a9888e274625c7278a90b inherit pub_methods_classCParameter"><td class="memItemLeft" align="right" valign="top">const char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCParameter.html#ad2dd0218fb8a9888e274625c7278a90b">get_descr</a> () const </td></tr>
<tr class="separator:ad2dd0218fb8a9888e274625c7278a90b inherit pub_methods_classCParameter"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab46d72c0a1114dd66aee4d3391dc8f25 inherit pub_methods_classCParameter"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCParameter.html#ab46d72c0a1114dd66aee4d3391dc8f25">get_help_xml</a> (xmlpp::Element &amp;root) const </td></tr>
<tr class="separator:ab46d72c0a1114dd66aee4d3391dc8f25 inherit pub_methods_classCParameter"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a892f3e8005c6cbaa28d062f6139f57be inherit pub_methods_classCParameter"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCParameter.html#a892f3e8005c6cbaa28d062f6139f57be">get_value_as_string</a> () const </td></tr>
<tr class="separator:a892f3e8005c6cbaa28d062f6139f57be inherit pub_methods_classCParameter"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a54f33bb1a4f5cad0231253cdffd32f50 inherit pub_methods_classCParameter"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCParameter.html#a54f33bb1a4f5cad0231253cdffd32f50">post_set</a> ()</td></tr>
<tr class="separator:a54f33bb1a4f5cad0231253cdffd32f50 inherit pub_methods_classCParameter"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:acbcc034b32bb30dc0f5c37a534d05eb1 inherit pub_methods_classCParameter"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCParameter.html#acbcc034b32bb30dc0f5c37a534d05eb1">required_set</a> () const </td></tr>
<tr class="separator:acbcc034b32bb30dc0f5c37a534d05eb1 inherit pub_methods_classCParameter"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab0702508e41ba942c04caf8b03874b65 inherit pub_methods_classCParameter"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCParameter.html#ab0702508e41ba942c04caf8b03874b65">reset</a> ()</td></tr>
<tr class="separator:ab0702508e41ba942c04caf8b03874b65 inherit pub_methods_classCParameter"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a16d92972d536487c83497896cf72c212 inherit pub_methods_classCParameter"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCParameter.html#a16d92972d536487c83497896cf72c212">set</a> (const std::string &amp;str_value)</td></tr>
<tr class="separator:a16d92972d536487c83497896cf72c212 inherit pub_methods_classCParameter"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9fbb02a366339bccbb8dc48401fe0a4e inherit pub_methods_classCParameter"><td class="memItemLeft" align="right" valign="top">const char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCParameter.html#a9fbb02a366339bccbb8dc48401fe0a4e">type</a> () const </td></tr>
<tr class="separator:a9fbb02a366339bccbb8dc48401fe0a4e inherit pub_methods_classCParameter"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6264144ef3f115af00021a632264db8e inherit pub_methods_classCParameter"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCParameter.html#a6264144ef3f115af00021a632264db8e">value</a> (std::ostream &amp;os) const </td></tr>
<tr class="separator:a6264144ef3f115af00021a632264db8e inherit pub_methods_classCParameter"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab52a12bfa54d7efe1307629656b4d1fa inherit pub_methods_classCParameter"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCParameter.html#ab52a12bfa54d7efe1307629656b4d1fa">~CParameter</a> ()</td></tr>
<tr class="separator:ab52a12bfa54d7efe1307629656b4d1fa inherit pub_methods_classCParameter"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-methods"></a>
Protected Member Functions</h2></td></tr>
<tr class="memitem:a72ead67091bab6a3b2e2a3c233121d55"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCSetParameter.html#a72ead67091bab6a3b2e2a3c233121d55">do_descr</a> (std::ostream &amp;os) const </td></tr>
<tr class="separator:a72ead67091bab6a3b2e2a3c233121d55"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pro_methods_classCParameter"><td colspan="2" onclick="javascript:toggleInherit('pro_methods_classCParameter')"><img src="closed.png" alt="-"/>&#160;Protected Member Functions inherited from <a class="el" href="classCParameter.html">CParameter</a></td></tr>
<tr class="memitem:a4014c44a9e8cc7e876f6ea902d028b68 inherit pro_methods_classCParameter"><td class="memItemLeft" align="right" valign="top">const std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCParameter.html#a4014c44a9e8cc7e876f6ea902d028b68">errmsg</a> (const std::string &amp;err_value) const </td></tr>
<tr class="memdesc:a4014c44a9e8cc7e876f6ea902d028b68 inherit pro_methods_classCParameter"><td class="mdescLeft">&#160;</td><td class="mdescRight">create an error message by using the given value that raises the error  <a href="#a4014c44a9e8cc7e876f6ea902d028b68">More...</a><br/></td></tr>
<tr class="separator:a4014c44a9e8cc7e876f6ea902d028b68 inherit pro_methods_classCParameter"><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 CSetParameter&lt; T &gt;</h3>

<p>A parameter that can only assume values out of a limited set. </p>
<p>This parameter type is used for parameters that that can only assume values out of a limited set of values. Other than the <a class="el" href="classCDictParameter.html" title="Dictionary paramater. ">CDictParameter</a> this parameter may handle any type T that can be streamed. </p>
<dl class="tparams"><dt>Template Parameters</dt><dd>
  <table class="tparams">
    <tr><td class="paramname">T</td><td>the value type of the parameter </td></tr>
  </table>
  </dd>
</dl>

<p>Definition at line <a class="el" href="parameter_8hh_source.html#l00333">333</a> of file <a class="el" href="parameter_8hh_source.html">parameter.hh</a>.</p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="a2d2f96693b5146b5fdc500bf32f677fd"></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="classCSetParameter.html">CSetParameter</a>&lt; T &gt;::<a class="el" href="classCSetParameter.html">CSetParameter</a> </td>
          <td>(</td>
          <td class="paramtype">T &amp;&#160;</td>
          <td class="paramname"><em>value</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const std::set&lt; T &gt; &amp;&#160;</td>
          <td class="paramname"><em>valid_set</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const char *&#160;</td>
          <td class="paramname"><em>descr</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">bool&#160;</td>
          <td class="paramname"><em>required</em> = <code>false</code>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Constructor </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">value</td><td>reference to the parameter handled by this parameter object </td></tr>
    <tr><td class="paramname">valid_set</td><td>dictionary for parameter translation </td></tr>
    <tr><td class="paramname">descr</td><td>a description of the parameter </td></tr>
    <tr><td class="paramname">required</td><td>boolean to indicate whether the user must set the parameter </td></tr>
  </table>
  </dd>
</dl>

<p>Definition at line <a class="el" href="parameter_8hh_source.html#l00658">658</a> of file <a class="el" href="parameter_8hh_source.html">parameter.hh</a>.</p>

</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="a72ead67091bab6a3b2e2a3c233121d55"></a>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename T &gt; </div>
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">void <a class="el" href="classCSetParameter.html">CSetParameter</a>&lt; T &gt;::do_descr </td>
          <td>(</td>
          <td class="paramtype">std::ostream &amp;&#160;</td>
          <td class="paramname"><em>os</em></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span><span class="mlabel">virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">
<p>the implementation of the description-function </p>

<p>Implements <a class="el" href="classCParameter.html#afee1a9aa93d9fafb94f343840b05387e">CParameter</a>.</p>

<p>Definition at line <a class="el" href="parameter_8hh_source.html#l00682">682</a> of file <a class="el" href="parameter_8hh_source.html">parameter.hh</a>.</p>

</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="parameter_8hh_source.html">parameter.hh</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Sat Jan 25 2014 23:52:09 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.