/usr/share/doc/mia-2.0/libdoc/classCCmdFlagOption.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 | <!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>CCmdFlagOption 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">CCmdFlagOption Class 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>Command line option that translates a string to a set of flags.
<a href="classCCmdFlagOption.html#details">More...</a></p>
<p><code>#include <<a class="el" href="cmdlineparser_8hh_source.html">mia/core/cmdlineparser.hh</a>></code></p>
<div class="dynheader">
Inheritance diagram for CCmdFlagOption:</div>
<div class="dyncontent">
<div class="center">
<img src="classCCmdFlagOption.png" usemap="#CCmdFlagOption_map" alt=""/>
<map id="CCmdFlagOption_map" name="CCmdFlagOption_map">
<area href="classCCmdOption.html" title="The base class for all command line options. " alt="CCmdOption" shape="rect" coords="0,0,108,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:aff2f9142ff595848c42c5c30540afbc3"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classCCmdFlagOption.html#aff2f9142ff595848c42c5c30540afbc3">CCmdFlagOption</a> (int &val, const <a class="el" href="classCFlagString.html">CFlagString</a> &map, char short_opt, const char *long_opt, const char *<a class="el" href="classCCmdOption.html#a19fc7def5c652c0f62a13d48b277ac07">long_help</a>, const char *short_help, bool flags=false)</td></tr>
<tr class="separator:aff2f9142ff595848c42c5c30540afbc3"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="inherit_header pub_methods_classCCmdOption"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classCCmdOption')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="classCCmdOption.html">CCmdOption</a></td></tr>
<tr class="memitem:a8c81fc15bc9cb27c06dcd998a6509655 inherit pub_methods_classCCmdOption"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCCmdOption.html#a8c81fc15bc9cb27c06dcd998a6509655">add_option</a> (<a class="el" href="cmdoption_8hh.html#a00dd4f17a2e8402a2c93a101e60c9089">CShortoptionMap</a> &sm, <a class="el" href="cmdoption_8hh.html#a96c8b06b3f0f527b09b420d417b8c808">CLongoptionMap</a> &lm)</td></tr>
<tr class="separator:a8c81fc15bc9cb27c06dcd998a6509655 inherit pub_methods_classCCmdOption"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a69b229ac03b8a4192428e0b558506920 inherit pub_methods_classCCmdOption"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classCCmdOption.html#a69b229ac03b8a4192428e0b558506920">CCmdOption</a> (char short_opt, const char *long_opt, const char *<a class="el" href="classCCmdOption.html#a19fc7def5c652c0f62a13d48b277ac07">long_help</a>, const char *short_help, bool <a class="el" href="classCCmdOption.html#a716f1c714a1345e8480288797fb0d075">required</a>)</td></tr>
<tr class="separator:a69b229ac03b8a4192428e0b558506920 inherit pub_methods_classCCmdOption"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a4b3b84e347ca4d6d608c77ff28856b39 inherit pub_methods_classCCmdOption"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCCmdOption.html#a4b3b84e347ca4d6d608c77ff28856b39">get_long_help</a> (std::ostream &os) const </td></tr>
<tr class="separator:a4b3b84e347ca4d6d608c77ff28856b39 inherit pub_methods_classCCmdOption"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a055f1dd375cb32a17c988bf5ad478e43 inherit pub_methods_classCCmdOption"><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classCCmdOption.html#a055f1dd375cb32a17c988bf5ad478e43">get_long_help_xml</a> (xmlpp::Element &parent, <a class="el" href="group__plugin.html#ga63c695cc3368b6ba07f01350034502d4">HandlerHelpMap</a> &handler_map) const </td></tr>
<tr class="separator:a055f1dd375cb32a17c988bf5ad478e43 inherit pub_methods_classCCmdOption"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a73e9f3e7edfa7addc6f12c8512699585 inherit pub_methods_classCCmdOption"><td class="memItemLeft" align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="classCCmdOption.html#a73e9f3e7edfa7addc6f12c8512699585">get_long_option</a> () const </td></tr>
<tr class="separator:a73e9f3e7edfa7addc6f12c8512699585 inherit pub_methods_classCCmdOption"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a83ea856757bcd76aa58cd66d17492db0 inherit pub_methods_classCCmdOption"><td class="memItemLeft" align="right" valign="top">size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classCCmdOption.html#a83ea856757bcd76aa58cd66d17492db0">get_needed_args</a> () const </td></tr>
<tr class="separator:a83ea856757bcd76aa58cd66d17492db0 inherit pub_methods_classCCmdOption"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:afcb7a4f5b17b4cd670451630f26e3984 inherit pub_methods_classCCmdOption"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCCmdOption.html#afcb7a4f5b17b4cd670451630f26e3984">get_opt_help</a> (std::ostream &os) const </td></tr>
<tr class="separator:afcb7a4f5b17b4cd670451630f26e3984 inherit pub_methods_classCCmdOption"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a021fcf06bae30f28d2ba9d7dcae951e3 inherit pub_methods_classCCmdOption"><td class="memItemLeft" align="right" valign="top">char </td><td class="memItemRight" valign="bottom"><a class="el" href="classCCmdOption.html#a021fcf06bae30f28d2ba9d7dcae951e3">get_short_option</a> () const </td></tr>
<tr class="separator:a021fcf06bae30f28d2ba9d7dcae951e3 inherit pub_methods_classCCmdOption"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ae413b26d169e6021cf14297f921ba3c4 inherit pub_methods_classCCmdOption"><td class="memItemLeft" align="right" valign="top">const std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classCCmdOption.html#ae413b26d169e6021cf14297f921ba3c4">get_value_as_string</a> () const </td></tr>
<tr class="separator:ae413b26d169e6021cf14297f921ba3c4 inherit pub_methods_classCCmdOption"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ae989695c0be1a54eb8ebcad03a613272 inherit pub_methods_classCCmdOption"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classCCmdOption.html#ae989695c0be1a54eb8ebcad03a613272">is_required</a> () const </td></tr>
<tr class="separator:ae989695c0be1a54eb8ebcad03a613272 inherit pub_methods_classCCmdOption"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a19fc7def5c652c0f62a13d48b277ac07 inherit pub_methods_classCCmdOption"><td class="memItemLeft" align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="classCCmdOption.html#a19fc7def5c652c0f62a13d48b277ac07">long_help</a> () const </td></tr>
<tr class="separator:a19fc7def5c652c0f62a13d48b277ac07 inherit pub_methods_classCCmdOption"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:af654f5526bdf941ad823be4c716a3dd4 inherit pub_methods_classCCmdOption"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCCmdOption.html#af654f5526bdf941ad823be4c716a3dd4">post_set</a> ()</td></tr>
<tr class="separator:af654f5526bdf941ad823be4c716a3dd4 inherit pub_methods_classCCmdOption"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a4c6bf31b28a32f954a83b233916186d1 inherit pub_methods_classCCmdOption"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCCmdOption.html#a4c6bf31b28a32f954a83b233916186d1">print_short_help</a> (std::ostream &os) const </td></tr>
<tr class="separator:a4c6bf31b28a32f954a83b233916186d1 inherit pub_methods_classCCmdOption"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a93ada1fdfa23b62baeb8197ba6dfaeab inherit pub_methods_classCCmdOption"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCCmdOption.html#a93ada1fdfa23b62baeb8197ba6dfaeab">set_value</a> (const char *str_value)</td></tr>
<tr class="separator:a93ada1fdfa23b62baeb8197ba6dfaeab inherit pub_methods_classCCmdOption"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a4cf9c80694a328973d21597e335f733e inherit pub_methods_classCCmdOption"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCCmdOption.html#a4cf9c80694a328973d21597e335f733e">write_value</a> (std::ostream &os) const </td></tr>
<tr class="separator:a4cf9c80694a328973d21597e335f733e inherit pub_methods_classCCmdOption"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a81ed97734265e1d04ec341587cf514ea inherit pub_methods_classCCmdOption"><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classCCmdOption.html#a81ed97734265e1d04ec341587cf514ea">~CCmdOption</a> ()</td></tr>
<tr class="memdesc:a81ed97734265e1d04ec341587cf514ea inherit pub_methods_classCCmdOption"><td class="mdescLeft"> </td><td class="mdescRight">ensure virtual destruction <a href="#a81ed97734265e1d04ec341587cf514ea">More...</a><br/></td></tr>
<tr class="separator:a81ed97734265e1d04ec341587cf514ea inherit pub_methods_classCCmdOption"><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 pub_static_attribs_classCCmdOption"><td colspan="2" onclick="javascript:toggleInherit('pub_static_attribs_classCCmdOption')"><img src="closed.png" alt="-"/> Static Public Attributes inherited from <a class="el" href="classCCmdOption.html">CCmdOption</a></td></tr>
<tr class="memitem:ac7cad9455fb313a409fd089a6371d69a inherit pub_static_attribs_classCCmdOption"><td class="memItemLeft" align="right" valign="top">static const bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classCCmdOption.html#ac7cad9455fb313a409fd089a6371d69a">not_required</a></td></tr>
<tr class="memdesc:ac7cad9455fb313a409fd089a6371d69a inherit pub_static_attribs_classCCmdOption"><td class="mdescLeft"> </td><td class="mdescRight">readability constant to show that an option is not required <a href="#ac7cad9455fb313a409fd089a6371d69a">More...</a><br/></td></tr>
<tr class="separator:ac7cad9455fb313a409fd089a6371d69a inherit pub_static_attribs_classCCmdOption"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a716f1c714a1345e8480288797fb0d075 inherit pub_static_attribs_classCCmdOption"><td class="memItemLeft" align="right" valign="top">static const bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classCCmdOption.html#a716f1c714a1345e8480288797fb0d075">required</a></td></tr>
<tr class="memdesc:a716f1c714a1345e8480288797fb0d075 inherit pub_static_attribs_classCCmdOption"><td class="mdescLeft"> </td><td class="mdescRight">readability constant to show that an option is required <a href="#a716f1c714a1345e8480288797fb0d075">More...</a><br/></td></tr>
<tr class="separator:a716f1c714a1345e8480288797fb0d075 inherit pub_static_attribs_classCCmdOption"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="inherit_header pro_methods_classCCmdOption"><td colspan="2" onclick="javascript:toggleInherit('pro_methods_classCCmdOption')"><img src="closed.png" alt="-"/> Protected Member Functions inherited from <a class="el" href="classCCmdOption.html">CCmdOption</a></td></tr>
<tr class="memitem:a680fd9e5e2d6a8dedd4fcb0bbb6d25c8 inherit pro_methods_classCCmdOption"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCCmdOption.html#a680fd9e5e2d6a8dedd4fcb0bbb6d25c8">clear_required</a> ()</td></tr>
<tr class="memdesc:a680fd9e5e2d6a8dedd4fcb0bbb6d25c8 inherit pro_methods_classCCmdOption"><td class="mdescLeft"> </td><td class="mdescRight">clear the "required" flag <a href="#a680fd9e5e2d6a8dedd4fcb0bbb6d25c8">More...</a><br/></td></tr>
<tr class="separator:a680fd9e5e2d6a8dedd4fcb0bbb6d25c8 inherit pro_methods_classCCmdOption"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Command line option that translates a string to a set of flags. </p>
<p>Definition at line <a class="el" href="cmdlineparser_8hh_source.html#l00133">133</a> of file <a class="el" href="cmdlineparser_8hh_source.html">cmdlineparser.hh</a>.</p>
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
<a class="anchor" id="aff2f9142ff595848c42c5c30540afbc3"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">CCmdFlagOption::CCmdFlagOption </td>
<td>(</td>
<td class="paramtype">int & </td>
<td class="paramname"><em>val</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classCFlagString.html">CFlagString</a> & </td>
<td class="paramname"><em>map</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">char </td>
<td class="paramname"><em>short_opt</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>long_opt</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>long_help</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>short_help</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"><em>flags</em> = <code>false</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Constructor of the command option </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in,out]</td><td class="paramname">val</td><td>variable to hold the parsed option value - pass in the default value - </td></tr>
<tr><td class="paramdir"></td><td class="paramname">map</td><td>the lookup table for the option </td></tr>
<tr><td class="paramdir"></td><td class="paramname">short_opt</td><td>short option name (or 0) </td></tr>
<tr><td class="paramdir"></td><td class="paramname">long_opt</td><td>long option name (must not be NULL) </td></tr>
<tr><td class="paramdir"></td><td class="paramname">long_help</td><td>long help string (must not be NULL) </td></tr>
<tr><td class="paramdir"></td><td class="paramname">short_help</td><td>short help string </td></tr>
<tr><td class="paramdir"></td><td class="paramname">flags</td><td>if this is set to true, extra checking will be done weather the option is really set </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="cmdlineparser_8hh_source.html">cmdlineparser.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>
|