diff options
| author | cathook <b01902109@csie.ntu.edu.tw> | 2014-06-01 13:56:57 +0800 |
|---|---|---|
| committer | cathook <b01902109@csie.ntu.edu.tw> | 2014-06-01 13:56:57 +0800 |
| commit | d5052f1c296dddf51b3e83d59bf3e3c1952cb2d0 (patch) | |
| tree | 16f7920c5079e0aefcf9509d2dbab59c464d42bd /doc/html/classmeow_1_1Usage.html | |
| parent | bd58f63900410ec4764031f2e6de2d75e91434b3 (diff) | |
| download | meow-d5052f1c296dddf51b3e83d59bf3e3c1952cb2d0.tar meow-d5052f1c296dddf51b3e83d59bf3e3c1952cb2d0.tar.gz meow-d5052f1c296dddf51b3e83d59bf3e3c1952cb2d0.tar.bz2 meow-d5052f1c296dddf51b3e83d59bf3e3c1952cb2d0.tar.lz meow-d5052f1c296dddf51b3e83d59bf3e3c1952cb2d0.tar.xz meow-d5052f1c296dddf51b3e83d59bf3e3c1952cb2d0.tar.zst meow-d5052f1c296dddf51b3e83d59bf3e3c1952cb2d0.zip | |
big chnage
Diffstat (limited to 'doc/html/classmeow_1_1Usage.html')
| -rw-r--r-- | doc/html/classmeow_1_1Usage.html | 797 |
1 files changed, 797 insertions, 0 deletions
diff --git a/doc/html/classmeow_1_1Usage.html b/doc/html/classmeow_1_1Usage.html new file mode 100644 index 0000000..68e689a --- /dev/null +++ b/doc/html/classmeow_1_1Usage.html @@ -0,0 +1,797 @@ +<!-- HTML header for doxygen 1.8.3.1--> +<!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.3.1"/> +<title>Templates -- Meow: meow::Usage 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="navtree.css" rel="stylesheet" type="text/css"/> +<script type="text/javascript" src="resize.js"></script> +<script type="text/javascript" src="navtree.js"></script> +<script type="text/javascript"> + $(document).ready(initResizable); + $(window).load(resizeHeight); +</script> +<link href="stylesheet.css" rel="stylesheet" type="text/css" /> +<link href="custom.css" rel="stylesheet" type="text/css"/> +</head> +<body> +<div id="top"><!-- do not remove this div, it is closed by doxygen! --> +<div id="titlearea"> +<table cellspacing="0" cellpadding="0"> + <tbody> + <tr style="height: 56px;"> + <td id="projectlogo"><img alt="Logo" src="logo.png"/></td> + <td style="padding-left: 0.5em;"> + <div id="projectname">Templates -- Meow +  <span id="projectnumber">1.1.2</span> + </div> + <div id="projectbrief">不能,也不應該先編譯成obj-file的templates</div> + </td> + </tr> + </tbody> +</table> +</div> +<!-- end header part --> +<!-- Generated by Doxygen 1.8.3.1 --> +</div><!-- top --> +<div id="side-nav" class="ui-resizable side-nav-resizable"> + <div id="nav-tree"> + <div id="nav-tree-contents"> + <div id="nav-sync" class="sync"></div> + </div> + </div> + <div id="splitbar" style="-moz-user-select:none;" + class="ui-resizable-handle"> + </div> +</div> +<script type="text/javascript"> +$(document).ready(function(){initNavTree('classmeow_1_1Usage.html','');}); +</script> +<div id="doc-content"> +<div class="header"> + <div class="summary"> +<a href="#nested-classes">Classes</a> | +<a href="#pub-methods">Public Member Functions</a> | +<a href="classmeow_1_1Usage-members.html">List of all members</a> </div> + <div class="headertitle"> +<div class="title">meow::Usage Class Reference</div> </div> +</div><!--header--> +<div class="contents"> + +<p>管理參數設置, 自訂usage document, 分析argc, argv + <a href="classmeow_1_1Usage.html#details">More...</a></p> + +<p><code>#include "<a class="el" href="Usage_8h_source.html">Usage.h</a>"</code></p> +<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:a5bcc22c9e69258c22462c1cb4e5b5400"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classmeow_1_1Usage.html#a5bcc22c9e69258c22462c1cb4e5b5400">Usage</a> ()</td></tr> +<tr class="memdesc:a5bcc22c9e69258c22462c1cb4e5b5400"><td class="mdescLeft"> </td><td class="mdescRight">constructor <a href="#a5bcc22c9e69258c22462c1cb4e5b5400">More...</a><br/></td></tr> +<tr class="separator:a5bcc22c9e69258c22462c1cb4e5b5400"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a93bca4e2025f46bac3fbfdc36d8ab649"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classmeow_1_1Usage.html#a93bca4e2025f46bac3fbfdc36d8ab649">Usage</a> (String const &name)</td></tr> +<tr class="memdesc:a93bca4e2025f46bac3fbfdc36d8ab649"><td class="mdescLeft"> </td><td class="mdescRight">constructor <a href="#a93bca4e2025f46bac3fbfdc36d8ab649">More...</a><br/></td></tr> +<tr class="separator:a93bca4e2025f46bac3fbfdc36d8ab649"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a20c74babb6cc473dd3abe2a31bbe32db"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classmeow_1_1Usage.html#a20c74babb6cc473dd3abe2a31bbe32db">Usage</a> (<a class="el" href="classmeow_1_1Usage.html">Usage</a> const &<a class="el" href="classmeow_1_1Usage.html#a974e116cde6295ed08d836b08e0c1e99">usage</a>)</td></tr> +<tr class="memdesc:a20c74babb6cc473dd3abe2a31bbe32db"><td class="mdescLeft"> </td><td class="mdescRight">constructor <a href="#a20c74babb6cc473dd3abe2a31bbe32db">More...</a><br/></td></tr> +<tr class="separator:a20c74babb6cc473dd3abe2a31bbe32db"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ad7db9a4197d9b281c47df0800ed63df0"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classmeow_1_1Usage.html#ad7db9a4197d9b281c47df0800ed63df0">import</a> (<a class="el" href="classmeow_1_1Usage.html">Usage</a> const &<a class="el" href="classmeow_1_1Usage.html#a974e116cde6295ed08d836b08e0c1e99">usage</a>)</td></tr> +<tr class="memdesc:ad7db9a4197d9b281c47df0800ed63df0"><td class="mdescLeft"> </td><td class="mdescRight">將另一個usage的設置匯入 <a href="#ad7db9a4197d9b281c47df0800ed63df0">More...</a><br/></td></tr> +<tr class="separator:ad7db9a4197d9b281c47df0800ed63df0"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ac09c339c31d602eca40df02c582d5241"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classmeow_1_1Usage.html#ac09c339c31d602eca40df02c582d5241">update</a> (<a class="el" href="classmeow_1_1Usage.html">Usage</a> const &<a class="el" href="classmeow_1_1Usage.html#a974e116cde6295ed08d836b08e0c1e99">usage</a>)</td></tr> +<tr class="memdesc:ac09c339c31d602eca40df02c582d5241"><td class="mdescLeft"> </td><td class="mdescRight">將另一個usage的選項設置加進來 <a href="#ac09c339c31d602eca40df02c582d5241">More...</a><br/></td></tr> +<tr class="separator:ac09c339c31d602eca40df02c582d5241"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a1fbd15f59f3fdbe5e817d540505d6d6c"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classmeow_1_1Usage.html#a1fbd15f59f3fdbe5e817d540505d6d6c">optionAdd</a> (unsigned char opt, String const &des)</td></tr> +<tr class="memdesc:a1fbd15f59f3fdbe5e817d540505d6d6c"><td class="mdescLeft"> </td><td class="mdescRight">新增一個沒有額外選項的選項 <a href="#a1fbd15f59f3fdbe5e817d540505d6d6c">More...</a><br/></td></tr> +<tr class="separator:a1fbd15f59f3fdbe5e817d540505d6d6c"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:af5a6f3dc4d2250dce3bd74d3de48714d"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classmeow_1_1Usage.html#af5a6f3dc4d2250dce3bd74d3de48714d">optionAdd</a> (unsigned char opt, String const &des, String const &val_type, String const &val_default, bool must)</td></tr> +<tr class="memdesc:af5a6f3dc4d2250dce3bd74d3de48714d"><td class="mdescLeft"> </td><td class="mdescRight">新增一個有額外選項的選項 <a href="#af5a6f3dc4d2250dce3bd74d3de48714d">More...</a><br/></td></tr> +<tr class="separator:af5a6f3dc4d2250dce3bd74d3de48714d"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a71ba10481062ed7088187cf27d7e0399"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classmeow_1_1Usage.html#a71ba10481062ed7088187cf27d7e0399">optionValueAcceptAdd</a> (unsigned char opt, String const &val, String const &des)</td></tr> +<tr class="memdesc:a71ba10481062ed7088187cf27d7e0399"><td class="mdescLeft"> </td><td class="mdescRight">針對-(opt)新增一個可接受的額外選項 <a href="#a71ba10481062ed7088187cf27d7e0399">More...</a><br/></td></tr> +<tr class="separator:a71ba10481062ed7088187cf27d7e0399"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a095271836eecf23940608c0eafcff841"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classmeow_1_1Usage.html#a095271836eecf23940608c0eafcff841">hasOptionSetup</a> (unsigned char opt) const </td></tr> +<tr class="memdesc:a095271836eecf23940608c0eafcff841"><td class="mdescLeft"> </td><td class="mdescRight">回傳是否有設定此選項 <a href="#a095271836eecf23940608c0eafcff841">More...</a><br/></td></tr> +<tr class="separator:a095271836eecf23940608c0eafcff841"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:acf478b89a1208024f9f37f1fe04add0d"><td class="memItemLeft" align="right" valign="top">size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classmeow_1_1Usage.html#acf478b89a1208024f9f37f1fe04add0d">optionValuesSize</a> (unsigned char opt) const </td></tr> +<tr class="memdesc:acf478b89a1208024f9f37f1fe04add0d"><td class="mdescLeft"> </td><td class="mdescRight">回傳參數 <b>-</b>(opt) 被設置幾次 <a href="#acf478b89a1208024f9f37f1fe04add0d">More...</a><br/></td></tr> +<tr class="separator:acf478b89a1208024f9f37f1fe04add0d"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a79dc9b39f0fa7c810e1c8cee29e2adac"><td class="memItemLeft" align="right" valign="top">String </td><td class="memItemRight" valign="bottom"><a class="el" href="classmeow_1_1Usage.html#a79dc9b39f0fa7c810e1c8cee29e2adac">optionValue</a> (unsigned char opt, size_t index) const </td></tr> +<tr class="memdesc:a79dc9b39f0fa7c810e1c8cee29e2adac"><td class="mdescLeft"> </td><td class="mdescRight">回傳參數 <b>-</b>(opt) 的第 <b>index</b> 個額外選項 <a href="#a79dc9b39f0fa7c810e1c8cee29e2adac">More...</a><br/></td></tr> +<tr class="separator:a79dc9b39f0fa7c810e1c8cee29e2adac"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:aef05aaef7ba6433b2f4c5f313f9c0752"><td class="memItemLeft" align="right" valign="top">size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classmeow_1_1Usage.html#aef05aaef7ba6433b2f4c5f313f9c0752">procArgsSize</a> () const </td></tr> +<tr class="memdesc:aef05aaef7ba6433b2f4c5f313f9c0752"><td class="mdescLeft"> </td><td class="mdescRight">取得有幾個process arguments <a href="#aef05aaef7ba6433b2f4c5f313f9c0752">More...</a><br/></td></tr> +<tr class="separator:aef05aaef7ba6433b2f4c5f313f9c0752"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a503b7e13dd79597020805b58d3d81d9d"><td class="memItemLeft" align="right" valign="top">String </td><td class="memItemRight" valign="bottom"><a class="el" href="classmeow_1_1Usage.html#a503b7e13dd79597020805b58d3d81d9d">procArg</a> (size_t index) const </td></tr> +<tr class="memdesc:a503b7e13dd79597020805b58d3d81d9d"><td class="mdescLeft"> </td><td class="mdescRight">取得第i個process argument <a href="#a503b7e13dd79597020805b58d3d81d9d">More...</a><br/></td></tr> +<tr class="separator:a503b7e13dd79597020805b58d3d81d9d"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:aa6a254158f9681e984424c2852fb20ee"><td class="memItemLeft" align="right" valign="top">Strings const & </td><td class="memItemRight" valign="bottom"><a class="el" href="classmeow_1_1Usage.html#aa6a254158f9681e984424c2852fb20ee">procArgs</a> () const </td></tr> +<tr class="memdesc:aa6a254158f9681e984424c2852fb20ee"><td class="mdescLeft"> </td><td class="mdescRight">取得process arguments array <a href="#aa6a254158f9681e984424c2852fb20ee">More...</a><br/></td></tr> +<tr class="separator:aa6a254158f9681e984424c2852fb20ee"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a05f4b23ce224661dbc7f308da4cb2709"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classmeow_1_1Usage.html#a05f4b23ce224661dbc7f308da4cb2709">usageBeginAdd</a> (String const &des)</td></tr> +<tr class="memdesc:a05f4b23ce224661dbc7f308da4cb2709"><td class="mdescLeft"> </td><td class="mdescRight">新增一段usage document於每個選項逐條說明之前 <a href="#a05f4b23ce224661dbc7f308da4cb2709">More...</a><br/></td></tr> +<tr class="separator:a05f4b23ce224661dbc7f308da4cb2709"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a4ee38098e5abdb6932a32c13a30f584d"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classmeow_1_1Usage.html#a4ee38098e5abdb6932a32c13a30f584d">usageEndAdd</a> (String const &des)</td></tr> +<tr class="memdesc:a4ee38098e5abdb6932a32c13a30f584d"><td class="mdescLeft"> </td><td class="mdescRight">新增一段usage document於每個選項逐條說明之後 <a href="#a4ee38098e5abdb6932a32c13a30f584d">More...</a><br/></td></tr> +<tr class="separator:a4ee38098e5abdb6932a32c13a30f584d"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a974e116cde6295ed08d836b08e0c1e99"><td class="memItemLeft" align="right" valign="top">String </td><td class="memItemRight" valign="bottom"><a class="el" href="classmeow_1_1Usage.html#a974e116cde6295ed08d836b08e0c1e99">usage</a> () const </td></tr> +<tr class="memdesc:a974e116cde6295ed08d836b08e0c1e99"><td class="mdescLeft"> </td><td class="mdescRight">回傳usage string <a href="#a974e116cde6295ed08d836b08e0c1e99">More...</a><br/></td></tr> +<tr class="separator:a974e116cde6295ed08d836b08e0c1e99"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a9c22701e09fec8e206118a95d7a082d1"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classmeow_1_1Usage.html#a9c22701e09fec8e206118a95d7a082d1">arguments</a> (<a class="el" href="classint.html">int</a> argc, char **argv, String *errmsg)</td></tr> +<tr class="memdesc:a9c22701e09fec8e206118a95d7a082d1"><td class="mdescLeft"> </td><td class="mdescRight">給定argc, argv, 將各參數設置 <a href="#a9c22701e09fec8e206118a95d7a082d1">More...</a><br/></td></tr> +<tr class="separator:a9c22701e09fec8e206118a95d7a082d1"><td class="memSeparator" colspan="2"> </td></tr> +</table> +<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> +<div class="textblock"><p>管理參數設置, 自訂usage document, 分析argc, argv </p> +<p><b><a class="el" href="classmeow_1_1Usage.html" title="管理參數設置, 自訂usage document, 分析argc, argv">Usage</a></b> 是用來分析argc, argv和輸出usage document的class. <br/> + argc, argv的部份, 有以下規則</p> +<ul> +<li><b>-c</b> 其中 <em>c</em> 可以代換成一個字符, 這種選像可能是 <b>有設置</b> 或 <b>沒設置</b> </li> +<li><b>-c</b> <em>value</em> 附加一個 <em>value</em> , 這種選項可以是 <b>選擇性</b> 或 <b>必要的</b> , 另外可以給定value的預設值以及哪些value是可接受</li> +<li><em>value</em> 其他, 一律視為 <b>process</b> <b>arguments</b> </li> +</ul> +<dl class="section author"><dt>Author</dt><dd>cathook </dd></dl> +</div><h2 class="groupheader">Constructor & Destructor Documentation</h2> +<a class="anchor" id="a5bcc22c9e69258c22462c1cb4e5b5400"></a> +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">meow::Usage::Usage </td> + <td>(</td> + <td class="paramname"></td><td>)</td> + <td></td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">inline</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> + +<p>constructor </p> +<p>所有說明文字中 <em><name></em> 都會被代換成空字串 </p> + +</div> +</div> +<a class="anchor" id="a93bca4e2025f46bac3fbfdc36d8ab649"></a> +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">meow::Usage::Usage </td> + <td>(</td> + <td class="paramtype">String const & </td> + <td class="paramname"><em>name</em></td><td>)</td> + <td></td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">inline</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> + +<p>constructor </p> +<p>所有說明文字中 <em>"<name>"</em> 都會被代換成空字串 <b>name</b> </p> + +</div> +</div> +<a class="anchor" id="a20c74babb6cc473dd3abe2a31bbe32db"></a> +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">meow::Usage::Usage </td> + <td>(</td> + <td class="paramtype"><a class="el" href="classmeow_1_1Usage.html">Usage</a> const & </td> + <td class="paramname"><em>usage</em></td><td>)</td> + <td></td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">inline</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> + +<p>constructor </p> +<p>將另一個usage原封不動的複製過來 </p> + +</div> +</div> +<h2 class="groupheader">Member Function Documentation</h2> +<a class="anchor" id="a9c22701e09fec8e206118a95d7a082d1"></a> +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">bool meow::Usage::arguments </td> + <td>(</td> + <td class="paramtype"><a class="el" href="classint.html">int</a> </td> + <td class="paramname"><em>argc</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">char ** </td> + <td class="paramname"><em>argv</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">String * </td> + <td class="paramname"><em>errmsg</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">inline</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> + +<p>給定argc, argv, 將各參數設置 </p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramdir">[in]</td><td class="paramname">argc,argv</td><td></td></tr> + <tr><td class="paramdir">[out]</td><td class="paramname">errmsg</td><td>將錯誤訊息寫到這裡 (若給定NULL pointer, 則會把錯誤訊息忽略) </td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd><code>true/false</code> <b>成功與否</b> (否的話代表有錯誤的設定值在其中) </dd></dl> + +</div> +</div> +<a class="anchor" id="a095271836eecf23940608c0eafcff841"></a> +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">bool meow::Usage::hasOptionSetup </td> + <td>(</td> + <td class="paramtype">unsigned char </td> + <td class="paramname"><em>opt</em></td><td>)</td> + <td> const</td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">inline</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> + +<p>回傳是否有設定此選項 </p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramdir">[in]</td><td class="paramname">opt</td><td>指定字符 </td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd><code>true/false</code> 表 <b>是否有設定此選項</b> </dd></dl> + +</div> +</div> +<a class="anchor" id="ad7db9a4197d9b281c47df0800ed63df0"></a> +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">bool meow::Usage::import </td> + <td>(</td> + <td class="paramtype"><a class="el" href="classmeow_1_1Usage.html">Usage</a> const & </td> + <td class="paramname"><em>usage</em></td><td>)</td> + <td></td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">inline</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> + +<p>將另一個usage的設置匯入 </p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramdir">[in]</td><td class="paramname">usage</td><td>另一個usage </td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd><code>true/false</code> 表示 <b>是否成功</b> </dd></dl> + +</div> +</div> +<a class="anchor" id="a1fbd15f59f3fdbe5e817d540505d6d6c"></a> +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">bool meow::Usage::optionAdd </td> + <td>(</td> + <td class="paramtype">unsigned char </td> + <td class="paramname"><em>opt</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">String const & </td> + <td class="paramname"><em>des</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">inline</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> + +<p>新增一個沒有額外選項的選項 </p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramdir">[in]</td><td class="paramname">opt</td><td>指定字符 </td></tr> + <tr><td class="paramdir">[in]</td><td class="paramname">des</td><td>即description, 用來解釋這個選項的意義用的 </td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd><code>true/false</code> 表 <b>是否成功</b> </dd></dl> + +</div> +</div> +<a class="anchor" id="af5a6f3dc4d2250dce3bd74d3de48714d"></a> +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">bool meow::Usage::optionAdd </td> + <td>(</td> + <td class="paramtype">unsigned char </td> + <td class="paramname"><em>opt</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">String const & </td> + <td class="paramname"><em>des</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">String const & </td> + <td class="paramname"><em>val_type</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">String const & </td> + <td class="paramname"><em>val_default</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">bool </td> + <td class="paramname"><em>must</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">inline</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> + +<p>新增一個有額外選項的選項 </p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramdir">[in]</td><td class="paramname">opt</td><td>指定字符 </td></tr> + <tr><td class="paramdir">[in]</td><td class="paramname">des</td><td>即description, 用來解釋這個選項的意義用的 </td></tr> + <tr><td class="paramdir">[in]</td><td class="paramname">val_type</td><td>表示額外選項的型態, 寫在USAGE裡面給人看用的 </td></tr> + <tr><td class="paramdir">[in]</td><td class="paramname">val_default</td><td>預設值, 若為空字串則當作沒有預設值 </td></tr> + <tr><td class="paramdir">[in]</td><td class="paramname">must</td><td>表示是否一定要設定 </td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd><code>true/false</code> 表 <b>是否成功</b> </dd></dl> + +</div> +</div> +<a class="anchor" id="a79dc9b39f0fa7c810e1c8cee29e2adac"></a> +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">String meow::Usage::optionValue </td> + <td>(</td> + <td class="paramtype">unsigned char </td> + <td class="paramname"><em>opt</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">size_t </td> + <td class="paramname"><em>index</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td> const</td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">inline</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> + +<p>回傳參數 <b>-</b>(opt) 的第 <b>index</b> 個額外選項 </p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramdir">[in]</td><td class="paramname">opt</td><td>指定字符 </td></tr> + <tr><td class="paramdir">[in]</td><td class="paramname">index</td><td>第幾個 </td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>回傳參數 <b>-</b>(opt) 的第 <b>index</b> 個額外選項 </dd></dl> + +</div> +</div> +<a class="anchor" id="a71ba10481062ed7088187cf27d7e0399"></a> +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">bool meow::Usage::optionValueAcceptAdd </td> + <td>(</td> + <td class="paramtype">unsigned char </td> + <td class="paramname"><em>opt</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">String const & </td> + <td class="paramname"><em>val</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">String const & </td> + <td class="paramname"><em>des</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">inline</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> + +<p>針對-(opt)新增一個可接受的額外選項 </p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramdir">[in]</td><td class="paramname">opt</td><td>指定字符 </td></tr> + <tr><td class="paramdir">[in]</td><td class="paramname">val</td><td>額外選項 </td></tr> + <tr><td class="paramdir">[in]</td><td class="paramname">des</td><td>關於此額外選項的說明 </td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd><code>true/false</code> 表 <b>是否成功</b> </dd></dl> + +</div> +</div> +<a class="anchor" id="acf478b89a1208024f9f37f1fe04add0d"></a> +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">size_t meow::Usage::optionValuesSize </td> + <td>(</td> + <td class="paramtype">unsigned char </td> + <td class="paramname"><em>opt</em></td><td>)</td> + <td> const</td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">inline</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> + +<p>回傳參數 <b>-</b>(opt) 被設置幾次 </p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramdir">[in]</td><td class="paramname">opt</td><td>指定字符 </td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>回傳次數 </dd></dl> + +</div> +</div> +<a class="anchor" id="a503b7e13dd79597020805b58d3d81d9d"></a> +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">String meow::Usage::procArg </td> + <td>(</td> + <td class="paramtype">size_t </td> + <td class="paramname"><em>index</em></td><td>)</td> + <td> const</td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">inline</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> + +<p>取得第i個process argument </p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramdir">[in]</td><td class="paramname">index</td><td>第幾個 </td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>回傳第 <em>index</em> 個 <b>process</b> <b>argument</b> </dd></dl> + +</div> +</div> +<a class="anchor" id="aa6a254158f9681e984424c2852fb20ee"></a> +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">Strings const& meow::Usage::procArgs </td> + <td>(</td> + <td class="paramname"></td><td>)</td> + <td> const</td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">inline</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> + +<p>取得process arguments array </p> +<dl class="section return"><dt>Returns</dt><dd>一個 <code>std::vector</code> , 包含所有 <b>Process</b> <b>arguments</b> </dd></dl> + +</div> +</div> +<a class="anchor" id="aef05aaef7ba6433b2f4c5f313f9c0752"></a> +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">size_t meow::Usage::procArgsSize </td> + <td>(</td> + <td class="paramname"></td><td>)</td> + <td> const</td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">inline</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> + +<p>取得有幾個process arguments </p> +<dl class="section return"><dt>Returns</dt><dd>有幾個process arguments </dd></dl> + +</div> +</div> +<a class="anchor" id="ac09c339c31d602eca40df02c582d5241"></a> +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">bool meow::Usage::update </td> + <td>(</td> + <td class="paramtype"><a class="el" href="classmeow_1_1Usage.html">Usage</a> const & </td> + <td class="paramname"><em>usage</em></td><td>)</td> + <td></td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">inline</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> + +<p>將另一個usage的選項設置加進來 </p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramdir">[in]</td><td class="paramname">usage</td><td>另一個usage </td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd><code>true/false</code> 表 <b>是否成功</b> </dd></dl> + +</div> +</div> +<a class="anchor" id="a974e116cde6295ed08d836b08e0c1e99"></a> +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">String meow::Usage::usage </td> + <td>(</td> + <td class="paramname"></td><td>)</td> + <td> const</td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">inline</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> + +<p>回傳usage string </p> +<dl class="section return"><dt>Returns</dt><dd><b>usage</b> <b>string</b> </dd></dl> + +</div> +</div> +<a class="anchor" id="a05f4b23ce224661dbc7f308da4cb2709"></a> +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">void meow::Usage::usageBeginAdd </td> + <td>(</td> + <td class="paramtype">String const & </td> + <td class="paramname"><em>des</em></td><td>)</td> + <td></td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">inline</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> + +<p>新增一段usage document於每個選項逐條說明之前 </p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramdir">[in]</td><td class="paramname">des</td><td>要新增的usage document </td></tr> + </table> + </dd> +</dl> + +</div> +</div> +<a class="anchor" id="a4ee38098e5abdb6932a32c13a30f584d"></a> +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">void meow::Usage::usageEndAdd </td> + <td>(</td> + <td class="paramtype">String const & </td> + <td class="paramname"><em>des</em></td><td>)</td> + <td></td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">inline</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> + +<p>新增一段usage document於每個選項逐條說明之後 </p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramdir">[in]</td><td class="paramname">des</td><td>要新增的usage document </td></tr> + </table> + </dd> +</dl> + +</div> +</div> +<hr/>The documentation for this class was generated from the following file:<ul> +<li>meowpp/<a class="el" href="Usage_8h_source.html">Usage.h</a></li> +</ul> +</div><!-- contents --> +</div><!-- doc-content --> +<!-- HTML footer for doxygen 1.8.3.1--> +<!-- start footer part --> +<div id="nav-path" class="navpath"><!-- id is needed for treeview function! --> + <ul> + <li class="navelem"><a class="el" href="namespacemeow.html">meow</a></li><li class="navelem"><a class="el" href="classmeow_1_1Usage.html">Usage</a></li> + <li class="footer">Generated on Sun Jun 1 2014 13:54:37 for Templates -- Meow by + <a href="http://www.doxygen.org/index.html"> + <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.3.1 </li> + </ul> +</div> +</body> +</html> |