/usr/share/doc/mia-2.0/libdoc/classCCmdOption.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 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 | <!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>CCmdOption 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> |
<a href="#pub-static-attribs">Static Public Attributes</a> |
<a href="#pro-methods">Protected Member Functions</a> </div>
<div class="headertitle">
<div class="title">CCmdOption Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span><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>The base class for all command line options.
<a href="classCCmdOption.html#details">More...</a></p>
<p><code>#include <<a class="el" href="cmdoption_8hh_source.html">mia/core/cmdoption.hh</a>></code></p>
<div class="dynheader">
Inheritance diagram for CCmdOption:</div>
<div class="dyncontent">
<div class="center">
<img src="classCCmdOption.png" usemap="#CCmdOption_map" alt=""/>
<map id="CCmdOption_map" name="CCmdOption_map">
<area href="classCCmdBoolOption.html" title="The command line option that sets a flag to true when given. " alt="CCmdBoolOption" shape="rect" coords="0,56,116,80"/>
<area href="classCCmdFlagOption.html" title="Command line option that translates a string to a set of flags. " alt="CCmdFlagOption" shape="rect" coords="126,56,242,80"/>
<area href="classCCmdStringOption.html" title="The command line option that expects a string. " alt="CCmdStringOption" shape="rect" coords="252,56,368,80"/>
<area href="classCHelpOption.html" title="A command line option that will appear in the help group and exits the program after printing the hel..." alt="CHelpOption" shape="rect" coords="378,56,494,80"/>
<area href="classCParamOption.html" title="command line option that handles a parameter " alt="CParamOption" shape="rect" coords="504,56,620,80"/>
<area href="classTCmdOption.html" title="Templated version based on CCmdOptionValue for values that can be converted to and from strings by st..." alt="TCmdOption< T >" shape="rect" coords="630,56,746,80"/>
</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:a8c81fc15bc9cb27c06dcd998a6509655"><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"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a69b229ac03b8a4192428e0b558506920"><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"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a4b3b84e347ca4d6d608c77ff28856b39"><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"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a055f1dd375cb32a17c988bf5ad478e43"><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"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a73e9f3e7edfa7addc6f12c8512699585"><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"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a83ea856757bcd76aa58cd66d17492db0"><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"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:afcb7a4f5b17b4cd670451630f26e3984"><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"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a021fcf06bae30f28d2ba9d7dcae951e3"><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"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ae413b26d169e6021cf14297f921ba3c4"><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"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ae989695c0be1a54eb8ebcad03a613272"><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"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a19fc7def5c652c0f62a13d48b277ac07"><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"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:af654f5526bdf941ad823be4c716a3dd4"><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"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a4c6bf31b28a32f954a83b233916186d1"><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"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a93ada1fdfa23b62baeb8197ba6dfaeab"><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"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a4cf9c80694a328973d21597e335f733e"><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"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a81ed97734265e1d04ec341587cf514ea"><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"><td class="mdescLeft"> </td><td class="mdescRight">ensure virtual destruction <a href="#a81ed97734265e1d04ec341587cf514ea">More...</a><br/></td></tr>
<tr class="separator:a81ed97734265e1d04ec341587cf514ea"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-attribs"></a>
Static Public Attributes</h2></td></tr>
<tr class="memitem:ac7cad9455fb313a409fd089a6371d69a"><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"><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"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a716f1c714a1345e8480288797fb0d075"><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"><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"><td class="memSeparator" colspan="2"> </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:a680fd9e5e2d6a8dedd4fcb0bbb6d25c8"><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"><td class="mdescLeft"> </td><td class="mdescRight">clear the "required" flag <a href="#a680fd9e5e2d6a8dedd4fcb0bbb6d25c8">More...</a><br/></td></tr>
<tr class="separator:a680fd9e5e2d6a8dedd4fcb0bbb6d25c8"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a75ec188dc834de793a60822d837e885a"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCCmdOption.html#a75ec188dc834de793a60822d837e885a">do_get_long_help</a> (std::ostream &os) const </td></tr>
<tr class="separator:a75ec188dc834de793a60822d837e885a"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>The base class for all command line options. </p>
<p>The base class of all possible command line options. It defines the interface of the options as well as some basic functionality to create help strings. </p>
<p>Definition at line <a class="el" href="cmdoption_8hh_source.html#l00050">50</a> of file <a class="el" href="cmdoption_8hh_source.html">cmdoption.hh</a>.</p>
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
<a class="anchor" id="a69b229ac03b8a4192428e0b558506920"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">CCmdOption::CCmdOption </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>required</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>The constructor </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">short_opt</td><td>the short option character </td></tr>
<tr><td class="paramname">long_opt</td><td>the long option name </td></tr>
<tr><td class="paramname">long_help</td><td>a long help string </td></tr>
<tr><td class="paramname">short_help</td><td>help to print out when only usage information is requested </td></tr>
<tr><td class="paramname">required</td><td>set to true if the option must be set by the user </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a81ed97734265e1d04ec341587cf514ea"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual CCmdOption::~CCmdOption </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>ensure virtual destruction </p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="a8c81fc15bc9cb27c06dcd998a6509655"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CCmdOption::add_option </td>
<td>(</td>
<td class="paramtype"><a class="el" href="cmdoption_8hh.html#a00dd4f17a2e8402a2c93a101e60c9089">CShortoptionMap</a> & </td>
<td class="paramname"><em>sm</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="cmdoption_8hh.html#a96c8b06b3f0f527b09b420d417b8c808">CLongoptionMap</a> & </td>
<td class="paramname"><em>lm</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Add this option to the given option maps </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">sm</td><td>a <em>CShortoptionMap</em> to add this option to </td></tr>
<tr><td class="paramname">lm</td><td>a <em>CLongoptionMap</em> to add this option to </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a680fd9e5e2d6a8dedd4fcb0bbb6d25c8"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void CCmdOption::clear_required </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>clear the "required" flag </p>
</div>
</div>
<a class="anchor" id="a75ec188dc834de793a60822d837e885a"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual void CCmdOption::do_get_long_help </td>
<td>(</td>
<td class="paramtype">std::ostream & </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>write the long help string to a stream </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">os</td><td>the output stream </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a4b3b84e347ca4d6d608c77ff28856b39"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CCmdOption::get_long_help </td>
<td>(</td>
<td class="paramtype">std::ostream & </td>
<td class="paramname"><em>os</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Print the long option name of the option to an output stream </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">os</td><td>the output stream </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a055f1dd375cb32a17c988bf5ad478e43"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::string CCmdOption::get_long_help_xml </td>
<td>(</td>
<td class="paramtype">xmlpp::Element & </td>
<td class="paramname"><em>parent</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__plugin.html#ga63c695cc3368b6ba07f01350034502d4">HandlerHelpMap</a> & </td>
<td class="paramname"><em>handler_map</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns help string tailered for the XML help creation system and adds used plug-in handlers to the helper map </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir"></td><td class="paramname">parent</td><td>the parent xml node to which to add documentation </td></tr>
<tr><td class="paramdir">[in,out]</td><td class="paramname">handler_map</td><td>the map of possibely recoursively called plug-in handlers </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>the text relate to the help </dd></dl>
<dl class="section remark"><dt>Remarks</dt><dd>the text should probably be added to the parent node instead. </dd></dl>
</div>
</div>
<a class="anchor" id="a73e9f3e7edfa7addc6f12c8512699585"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const char* CCmdOption::get_long_option </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>the long name of the option </dd></dl>
</div>
</div>
<a class="anchor" id="a83ea856757bcd76aa58cd66d17492db0"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">size_t CCmdOption::get_needed_args </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>how many arguments after the option argument on the command line will be used by this option </dd></dl>
</div>
</div>
<a class="anchor" id="afcb7a4f5b17b4cd670451630f26e3984"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CCmdOption::get_opt_help </td>
<td>(</td>
<td class="paramtype">std::ostream & </td>
<td class="paramname"><em>os</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Print the help of the option to an output stream </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">os</td><td>the output stream </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a021fcf06bae30f28d2ba9d7dcae951e3"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">char CCmdOption::get_short_option </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>the long name of the option </dd></dl>
</div>
</div>
<a class="anchor" id="ae413b26d169e6021cf14297f921ba3c4"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const std::string CCmdOption::get_value_as_string </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>the options value as string </dd></dl>
</div>
</div>
<a class="anchor" id="ae989695c0be1a54eb8ebcad03a613272"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool CCmdOption::is_required </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>true if the option is a required option and hasn't been set </dd></dl>
</div>
</div>
<a class="anchor" id="a19fc7def5c652c0f62a13d48b277ac07"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const char* CCmdOption::long_help </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>the long help string </dd></dl>
</div>
</div>
<a class="anchor" id="af654f5526bdf941ad823be4c716a3dd4"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CCmdOption::post_set </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>This function must be called after the parameter was set through a string in order to handle complex initialization like done for factory based command line parameters </p>
</div>
</div>
<a class="anchor" id="a4c6bf31b28a32f954a83b233916186d1"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CCmdOption::print_short_help </td>
<td>(</td>
<td class="paramtype">std::ostream & </td>
<td class="paramname"><em>os</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Print the short help of the option to an output stream </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">os</td><td>the output stream </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a93ada1fdfa23b62baeb8197ba6dfaeab"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CCmdOption::set_value </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>str_value</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set the value of the option parameter based on the input string </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">str_value</td><td>the string value to be vonverted to the option value </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a4cf9c80694a328973d21597e335f733e"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CCmdOption::write_value </td>
<td>(</td>
<td class="paramtype">std::ostream & </td>
<td class="paramname"><em>os</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Writes out the value of the option to an output stream </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">os</td><td>the output stream to write this options value to </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<h2 class="groupheader">Field Documentation</h2>
<a class="anchor" id="ac7cad9455fb313a409fd089a6371d69a"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">const bool CCmdOption::not_required</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>readability constant to show that an option is not required </p>
<p>Definition at line <a class="el" href="cmdoption_8hh_source.html#l00054">54</a> of file <a class="el" href="cmdoption_8hh_source.html">cmdoption.hh</a>.</p>
</div>
</div>
<a class="anchor" id="a716f1c714a1345e8480288797fb0d075"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">const bool CCmdOption::required</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>readability constant to show that an option is required </p>
<p>Definition at line <a class="el" href="cmdoption_8hh_source.html#l00057">57</a> of file <a class="el" href="cmdoption_8hh_source.html">cmdoption.hh</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="cmdoption_8hh_source.html">cmdoption.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>
|