/usr/share/doc/mia-2.0/libdoc/classCStringParameter.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 | <!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>CStringParameter Class 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 Page</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li><a href="modules.html"><span>Modules</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>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<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><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> </div>
<div class="headertitle">
<div class="title">CStringParameter Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>an string parameter
<a href="classCStringParameter.html#details">More...</a></p>
<p><code>#include <<a class="el" href="parameter_8hh_source.html">mia/core/parameter.hh</a>></code></p>
<div class="dynheader">
Inheritance diagram for CStringParameter:</div>
<div class="dyncontent">
<div class="center">
<img src="classCStringParameter.png" usemap="#CStringParameter_map" alt=""/>
<map id="CStringParameter_map" name="CStringParameter_map">
<area href="classCParameter.html" title="The base class for parameters used in complex options. " alt="CParameter" shape="rect" coords="0,0,112,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:a3c46bd2f126ab5e5a11dbe1fb5aa5c48"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classCStringParameter.html#a3c46bd2f126ab5e5a11dbe1fb5aa5c48">CStringParameter</a> (std::string &<a class="el" href="classCParameter.html#a6264144ef3f115af00021a632264db8e">value</a>, bool required, const char *<a class="el" href="classCParameter.html#a882ad136c7c557d332e215590f43b529">descr</a>, const <a class="el" href="classCPluginHandlerBase.html">CPluginHandlerBase</a> *plugin_hint=NULL)</td></tr>
<tr class="separator:a3c46bd2f126ab5e5a11dbe1fb5aa5c48"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="inherit_header pub_methods_classCParameter"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classCParameter')"><img src="closed.png" alt="-"/> 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 </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> &handler_map) const </td></tr>
<tr class="separator:a94ba12dbfab92b213f573c10726cbcca inherit pub_methods_classCParameter"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a6d74e5adaecc979ca8b61e67b35b89a5 inherit pub_methods_classCParameter"><td class="memItemLeft" align="right" valign="top"> </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"> </td></tr>
<tr class="memitem:a882ad136c7c557d332e215590f43b529 inherit pub_methods_classCParameter"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCParameter.html#a882ad136c7c557d332e215590f43b529">descr</a> (std::ostream &os) const </td></tr>
<tr class="separator:a882ad136c7c557d332e215590f43b529 inherit pub_methods_classCParameter"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a50e0585eb4f6aec6e7f06a1ad57a00a1 inherit pub_methods_classCParameter"><td class="memItemLeft" align="right" valign="top">std::string </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"> </td></tr>
<tr class="memitem:ad2dd0218fb8a9888e274625c7278a90b inherit pub_methods_classCParameter"><td class="memItemLeft" align="right" valign="top">const char * </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"> </td></tr>
<tr class="memitem:ab46d72c0a1114dd66aee4d3391dc8f25 inherit pub_methods_classCParameter"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCParameter.html#ab46d72c0a1114dd66aee4d3391dc8f25">get_help_xml</a> (xmlpp::Element &root) const </td></tr>
<tr class="separator:ab46d72c0a1114dd66aee4d3391dc8f25 inherit pub_methods_classCParameter"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a892f3e8005c6cbaa28d062f6139f57be inherit pub_methods_classCParameter"><td class="memItemLeft" align="right" valign="top">std::string </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"> </td></tr>
<tr class="memitem:a54f33bb1a4f5cad0231253cdffd32f50 inherit pub_methods_classCParameter"><td class="memItemLeft" align="right" valign="top">virtual void </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"> </td></tr>
<tr class="memitem:acbcc034b32bb30dc0f5c37a534d05eb1 inherit pub_methods_classCParameter"><td class="memItemLeft" align="right" valign="top">bool </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"> </td></tr>
<tr class="memitem:ab0702508e41ba942c04caf8b03874b65 inherit pub_methods_classCParameter"><td class="memItemLeft" align="right" valign="top">void </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"> </td></tr>
<tr class="memitem:a16d92972d536487c83497896cf72c212 inherit pub_methods_classCParameter"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classCParameter.html#a16d92972d536487c83497896cf72c212">set</a> (const std::string &str_value)</td></tr>
<tr class="separator:a16d92972d536487c83497896cf72c212 inherit pub_methods_classCParameter"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a9fbb02a366339bccbb8dc48401fe0a4e inherit pub_methods_classCParameter"><td class="memItemLeft" align="right" valign="top">const char * </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"> </td></tr>
<tr class="memitem:a6264144ef3f115af00021a632264db8e inherit pub_methods_classCParameter"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCParameter.html#a6264144ef3f115af00021a632264db8e">value</a> (std::ostream &os) const </td></tr>
<tr class="separator:a6264144ef3f115af00021a632264db8e inherit pub_methods_classCParameter"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ab52a12bfa54d7efe1307629656b4d1fa inherit pub_methods_classCParameter"><td class="memItemLeft" align="right" valign="top">virtual </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"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="inherited"></a>
Additional Inherited Members</h2></td></tr>
<tr class="inherit_header pro_methods_classCParameter"><td colspan="2" onclick="javascript:toggleInherit('pro_methods_classCParameter')"><img src="closed.png" alt="-"/> 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 </td><td class="memItemRight" valign="bottom"><a class="el" href="classCParameter.html#a4014c44a9e8cc7e876f6ea902d028b68">errmsg</a> (const std::string &err_value) const </td></tr>
<tr class="memdesc:a4014c44a9e8cc7e876f6ea902d028b68 inherit pro_methods_classCParameter"><td class="mdescLeft"> </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"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>an string parameter </p>
<p>Definition at line <a class="el" href="parameter_8hh_source.html#l00396">396</a> of file <a class="el" href="parameter_8hh_source.html">parameter.hh</a>.</p>
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
<a class="anchor" id="a3c46bd2f126ab5e5a11dbe1fb5aa5c48"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">CStringParameter::CStringParameter </td>
<td>(</td>
<td class="paramtype">std::string & </td>
<td class="paramname"><em>value</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"><em>required</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>descr</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classCPluginHandlerBase.html">CPluginHandlerBase</a> * </td>
<td class="paramname"><em>plugin_hint</em> = <code>NULL</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
</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  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.6
</small></address>
</body>
</html>
|