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
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
|
<!-- 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.6"/>
<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.4</span>
</div>
<div id="projectbrief">A C++ template which is unable and also not allowed to compile to obj-file first.</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.6 -->
</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:af40b0323858e6af56562351554c4dfe2"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classmeow_1_1Usage.html#af40b0323858e6af56562351554c4dfe2">optionAdd</a> (String opt, String const &des)</td></tr>
<tr class="memdesc:af40b0323858e6af56562351554c4dfe2"><td class="mdescLeft"> </td><td class="mdescRight">新增一個沒有額外選項的選項 <a href="#af40b0323858e6af56562351554c4dfe2">More...</a><br/></td></tr>
<tr class="separator:af40b0323858e6af56562351554c4dfe2"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:af4642c5d19cda946047934b3d1463f02"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classmeow_1_1Usage.html#af4642c5d19cda946047934b3d1463f02">optionAdd</a> (String opt, String const &des, String const &val_type, String const &val_default, bool must)</td></tr>
<tr class="memdesc:af4642c5d19cda946047934b3d1463f02"><td class="mdescLeft"> </td><td class="mdescRight">新增一個有額外選項的選項 <a href="#af4642c5d19cda946047934b3d1463f02">More...</a><br/></td></tr>
<tr class="separator:af4642c5d19cda946047934b3d1463f02"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aaa2f7c0049d1d09ae08ba8fed6f2a242"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classmeow_1_1Usage.html#aaa2f7c0049d1d09ae08ba8fed6f2a242">optionValueAcceptAdd</a> (String opt, String const &val, String const &des)</td></tr>
<tr class="memdesc:aaa2f7c0049d1d09ae08ba8fed6f2a242"><td class="mdescLeft"> </td><td class="mdescRight">針對-(opt)新增一個可接受的額外選項 <a href="#aaa2f7c0049d1d09ae08ba8fed6f2a242">More...</a><br/></td></tr>
<tr class="separator:aaa2f7c0049d1d09ae08ba8fed6f2a242"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a24d6ad17571474211da242b19bc5bdcf"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classmeow_1_1Usage.html#a24d6ad17571474211da242b19bc5bdcf">hasOptionSetup</a> (String opt) const </td></tr>
<tr class="memdesc:a24d6ad17571474211da242b19bc5bdcf"><td class="mdescLeft"> </td><td class="mdescRight">回傳是否有設定此選項 <a href="#a24d6ad17571474211da242b19bc5bdcf">More...</a><br/></td></tr>
<tr class="separator:a24d6ad17571474211da242b19bc5bdcf"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:abf96a39021fa349a881f850176b56bbb"><td class="memItemLeft" align="right" valign="top">size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classmeow_1_1Usage.html#abf96a39021fa349a881f850176b56bbb">optionValuesSize</a> (String opt) const </td></tr>
<tr class="memdesc:abf96a39021fa349a881f850176b56bbb"><td class="mdescLeft"> </td><td class="mdescRight">回傳參數 <b>-</b>(opt) 被設置幾次 <a href="#abf96a39021fa349a881f850176b56bbb">More...</a><br/></td></tr>
<tr class="separator:abf96a39021fa349a881f850176b56bbb"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a4decdd19345adcda3854fd13e3379d4f"><td class="memItemLeft" align="right" valign="top">String </td><td class="memItemRight" valign="bottom"><a class="el" href="classmeow_1_1Usage.html#a4decdd19345adcda3854fd13e3379d4f">optionValue</a> (String opt, size_t index) const </td></tr>
<tr class="memdesc:a4decdd19345adcda3854fd13e3379d4f"><td class="mdescLeft"> </td><td class="mdescRight">回傳參數 <b>-</b>(opt) 的第 <b>index</b> 個額外選項 <a href="#a4decdd19345adcda3854fd13e3379d4f">More...</a><br/></td></tr>
<tr class="separator:a4decdd19345adcda3854fd13e3379d4f"><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>
<p>Definition at line <a class="el" href="Usage_8h_source.html#l00026">26</a> of file <a class="el" href="Usage_8h_source.html">Usage.h</a>.</p>
</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>
<p>Definition at line <a class="el" href="Usage_8h_source.html#l00184">184</a> of file <a class="el" href="Usage_8h_source.html">Usage.h</a>.</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>
<p>Definition at line <a class="el" href="Usage_8h_source.html#l00192">192</a> of file <a class="el" href="Usage_8h_source.html">Usage.h</a>.</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>
<p>Definition at line <a class="el" href="Usage_8h_source.html#l00202">202</a> of file <a class="el" href="Usage_8h_source.html">Usage.h</a>.</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>
<p>Definition at line <a class="el" href="Usage_8h_source.html#l00414">414</a> of file <a class="el" href="Usage_8h_source.html">Usage.h</a>.</p>
</div>
</div>
<a class="anchor" id="a24d6ad17571474211da242b19bc5bdcf"></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">String </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>
<p>Definition at line <a class="el" href="Usage_8h_source.html#l00304">304</a> of file <a class="el" href="Usage_8h_source.html">Usage.h</a>.</p>
</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>
<p>Definition at line <a class="el" href="Usage_8h_source.html#l00216">216</a> of file <a class="el" href="Usage_8h_source.html">Usage.h</a>.</p>
</div>
</div>
<a class="anchor" id="af40b0323858e6af56562351554c4dfe2"></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">String </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>
<p>Definition at line <a class="el" href="Usage_8h_source.html#l00258">258</a> of file <a class="el" href="Usage_8h_source.html">Usage.h</a>.</p>
</div>
</div>
<a class="anchor" id="af4642c5d19cda946047934b3d1463f02"></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">String </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>
<p>Definition at line <a class="el" href="Usage_8h_source.html#l00274">274</a> of file <a class="el" href="Usage_8h_source.html">Usage.h</a>.</p>
</div>
</div>
<a class="anchor" id="a4decdd19345adcda3854fd13e3379d4f"></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">String </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>
<p>Definition at line <a class="el" href="Usage_8h_source.html#l00328">328</a> of file <a class="el" href="Usage_8h_source.html">Usage.h</a>.</p>
</div>
</div>
<a class="anchor" id="aaa2f7c0049d1d09ae08ba8fed6f2a242"></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">String </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>
<p>Definition at line <a class="el" href="Usage_8h_source.html#l00292">292</a> of file <a class="el" href="Usage_8h_source.html">Usage.h</a>.</p>
</div>
</div>
<a class="anchor" id="abf96a39021fa349a881f850176b56bbb"></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">String </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>
<p>Definition at line <a class="el" href="Usage_8h_source.html#l00315">315</a> of file <a class="el" href="Usage_8h_source.html">Usage.h</a>.</p>
</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>
<p>Definition at line <a class="el" href="Usage_8h_source.html#l00349">349</a> of file <a class="el" href="Usage_8h_source.html">Usage.h</a>.</p>
</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>
<p>Definition at line <a class="el" href="Usage_8h_source.html#l00361">361</a> of file <a class="el" href="Usage_8h_source.html">Usage.h</a>.</p>
</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>
<p>Definition at line <a class="el" href="Usage_8h_source.html#l00339">339</a> of file <a class="el" href="Usage_8h_source.html">Usage.h</a>.</p>
</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>
<p>Definition at line <a class="el" href="Usage_8h_source.html#l00239">239</a> of file <a class="el" href="Usage_8h_source.html">Usage.h</a>.</p>
</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>
<p>Definition at line <a class="el" href="Usage_8h_source.html#l00388">388</a> of file <a class="el" href="Usage_8h_source.html">Usage.h</a>.</p>
</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>
<p>Definition at line <a class="el" href="Usage_8h_source.html#l00370">370</a> of file <a class="el" href="Usage_8h_source.html">Usage.h</a>.</p>
</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>
<p>Definition at line <a class="el" href="Usage_8h_source.html#l00379">379</a> of file <a class="el" href="Usage_8h_source.html">Usage.h</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li>meowpp/<a class="el" href="Usage_8h_source.html">Usage.h</a></li>
<li>meowpp/<a class="el" href="Usage_8hpp_source.html">Usage.hpp</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 Mon Jun 23 2014 17:02:08 for Templates -- Meow by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.6 </li>
</ul>
</div>
</body>
</html>
|
