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
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>Exiv2: Params Class Reference</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
<link href="tabs.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.4.6 -->
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li id="current"><a href="classes.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
<li><a href="examples.html"><span>Examples</span></a></li>
</ul></div>
<div class="tabs">
<ul>
<li><a href="classes.html"><span>Alphabetical List</span></a></li>
<li><a href="annotated.html"><span>Class List</span></a></li>
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class Members</span></a></li>
</ul></div>
<h1>Params Class Reference</h1><!-- doxytag: class="Params" --><!-- doxytag: inherits="Util::Getopt,Util::Getopt" -->Implements the command line handling for the program.
<a href="#_details">More...</a>
<p>
<code>#include <exiv2.hpp></code>
<p>
Inheritance diagram for Params:<p><center><img src="classParams__inherit__graph.png" border="0" usemap="#Params__inherit__map" alt="Inheritance graph"></center>
<map name="Params__inherit__map">
<area href="classUtil_1_1Getopt.html" shape="rect" coords="6,7,94,31" alt="">
</map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center>Collaboration diagram for Params:<p><center><img src="classParams__coll__graph.png" border="0" usemap="#Params__coll__map" alt="Collaboration graph"></center>
<map name="Params__coll__map">
<area href="classUtil_1_1Getopt.html" shape="rect" coords="145,304,233,328" alt="">
</map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center><a href="classParams-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Public Types</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="3ee16d0a5bc89c6ae3da8420a677554e"></a><!-- doxytag: member="Params::CmdFiles" ref="3ee16d0a5bc89c6ae3da8420a677554e" args="" -->
typedef std::vector< std::string > </td><td class="memItemRight" valign="bottom"><a class="el" href="classParams.html#3ee16d0a5bc89c6ae3da8420a677554e">CmdFiles</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Container for command files. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="3c0613498451b5729e5b32232a4fa39b"></a><!-- doxytag: member="Params::CmdLines" ref="3c0613498451b5729e5b32232a4fa39b" args="" -->
typedef std::vector< std::string > </td><td class="memItemRight" valign="bottom"><a class="el" href="classParams.html#3c0613498451b5729e5b32232a4fa39b">CmdLines</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Container for commands from the command line. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="4760eec97bf28489316873d58a3d9a36"></a><!-- doxytag: member="Params::Files" ref="4760eec97bf28489316873d58a3d9a36" args="" -->
typedef std::vector< std::string > </td><td class="memItemRight" valign="bottom"><a class="el" href="classParams.html#4760eec97bf28489316873d58a3d9a36">Files</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Container to store filenames. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">enum </td><td class="memItemRight" valign="bottom"><a class="el" href="classParams.html#c490e98ae38d6ee481c4b3826ddbaceb">PrintMode</a> { <b>pmSummary</b>,
<b>pmList</b>,
<b>pmIptc</b>,
<b>pmComment</b>
}</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Enumerates print modes. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">enum </td><td class="memItemRight" valign="bottom"><a class="el" href="classParams.html#c0129528bce4e090cfebdd1e3025d733">PrintItem</a> { <br>
<b>prTag</b> = 1,
<b>prGroup</b> = 2,
<b>prKey</b> = 4,
<b>prName</b> = 8,
<br>
<b>prLabel</b> = 16,
<b>prType</b> = 32,
<b>prCount</b> = 64,
<b>prSize</b> = 128,
<br>
<b>prValue</b> = 256,
<b>prTrans</b> = 512,
<b>prHex</b> = 1024
<br>
}</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Individual items to print. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">enum </td><td class="memItemRight" valign="bottom"><a class="el" href="classParams.html#a92bcffc432ebf5f3db4b302b11e9db0">CommonTarget</a> { <b>ctExif</b> = 1,
<b>ctIptc</b> = 2,
<b>ctComment</b> = 4,
<b>ctThumb</b> = 8
}</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Enumerates common targets, bitmap. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">enum </td><td class="memItemRight" valign="bottom"><a class="el" href="classParams.html#6904db5cbd6b193b2c1e981f984ba7ef">FileExistsPolicy</a> { <b>overwritePolicy</b>,
<b>renamePolicy</b>,
<b>askPolicy</b>
}</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Enumerates the policies to handle existing files in rename action. <br></td></tr>
<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="9482455c09621321d8227bb8c26be28c"></a><!-- doxytag: member="Params::cleanup" ref="9482455c09621321d8227bb8c26be28c" args="()" -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classParams.html#9482455c09621321d8227bb8c26be28c">cleanup</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Destructor. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classParams.html#3ba82915162067d66a83b54bca05e241">getopt</a> (int argc, char *const argv[])</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Call Getopt::getopt() with optstring, to inititate command line argument parsing, perform consistency checks after all command line arguments are parsed. <a href="#3ba82915162067d66a83b54bca05e241"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="8d28eab356e60994d9bcf6c9c6ff1cdb"></a><!-- doxytag: member="Params::option" ref="8d28eab356e60994d9bcf6c9c6ff1cdb" args="(int opt, const std::string &optarg, int optopt)" -->
virtual int </td><td class="memItemRight" valign="bottom"><a class="el" href="classParams.html#8d28eab356e60994d9bcf6c9c6ff1cdb">option</a> (int opt, const std::string &optarg, int optopt)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Handle options and their arguments. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="00a1171555548b5903e52a12354309b4"></a><!-- doxytag: member="Params::nonoption" ref="00a1171555548b5903e52a12354309b4" args="(const std::string &argv)" -->
virtual int </td><td class="memItemRight" valign="bottom"><a class="el" href="classParams.html#00a1171555548b5903e52a12354309b4">nonoption</a> (const std::string &argv)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Handle non-option parameters. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="89d66afdb73659019d84729d2baa9ef9"></a><!-- doxytag: member="Params::usage" ref="89d66afdb73659019d84729d2baa9ef9" args="(std::ostream &os=std::cout) const " -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classParams.html#89d66afdb73659019d84729d2baa9ef9">usage</a> (std::ostream &os=std::cout) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Print a minimal usage note to an output stream. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="e91b9ae6d86aa58ca7d1bc1f7542f22c"></a><!-- doxytag: member="Params::help" ref="e91b9ae6d86aa58ca7d1bc1f7542f22c" args="(std::ostream &os=std::cout) const " -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classParams.html#e91b9ae6d86aa58ca7d1bc1f7542f22c">help</a> (std::ostream &os=std::cout) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Print further usage explanations to an output stream. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="9b1c3243120fea036a402b1ef5d1f6c3"></a><!-- doxytag: member="Params::version" ref="9b1c3243120fea036a402b1ef5d1f6c3" args="(std::ostream &os=std::cout) const " -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classParams.html#9b1c3243120fea036a402b1ef5d1f6c3">version</a> (std::ostream &os=std::cout) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Print version information to an output stream. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="1c0d445a3ea36e3b4d8696c55217fdd2"></a><!-- doxytag: member="Params::Params" ref="1c0d445a3ea36e3b4d8696c55217fdd2" args="()" -->
</td><td class="memItemRight" valign="bottom"><a class="el" href="classParams.html#1c0d445a3ea36e3b4d8696c55217fdd2">Params</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Default constructor. Note that optstring_ is initialized here. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classParams.html#3ba82915162067d66a83b54bca05e241">getopt</a> (int argc, char *const argv[])</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Call Getopt::getopt() with optstring, to initiate command line argument parsing, perform consistency checks after all command line arguments are parsed. <a href="#3ba82915162067d66a83b54bca05e241"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="6db679664dff3fb8d1c807aa01c7aa45"></a><!-- doxytag: member="Params::option" ref="6db679664dff3fb8d1c807aa01c7aa45" args="(int opt, const std::string &optarg, int optopt)" -->
virtual int </td><td class="memItemRight" valign="bottom"><a class="el" href="classParams.html#6db679664dff3fb8d1c807aa01c7aa45">option</a> (int opt, const std::string &optarg, int optopt)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Handle options and their arguments. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="f788b09ae4abb849e760e3a46e92bcf2"></a><!-- doxytag: member="Params::nonoption" ref="f788b09ae4abb849e760e3a46e92bcf2" args="(const std::string &argv)" -->
virtual int </td><td class="memItemRight" valign="bottom"><a class="el" href="classParams.html#f788b09ae4abb849e760e3a46e92bcf2">nonoption</a> (const std::string &argv)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Handle non-option parameters. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="89d66afdb73659019d84729d2baa9ef9"></a><!-- doxytag: member="Params::usage" ref="89d66afdb73659019d84729d2baa9ef9" args="(std::ostream &os=std::cout) const " -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classParams.html#89d66afdb73659019d84729d2baa9ef9">usage</a> (std::ostream &os=std::cout) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Print a minimal usage note to an output stream. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="e91b9ae6d86aa58ca7d1bc1f7542f22c"></a><!-- doxytag: member="Params::help" ref="e91b9ae6d86aa58ca7d1bc1f7542f22c" args="(std::ostream &os=std::cout) const " -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classParams.html#e91b9ae6d86aa58ca7d1bc1f7542f22c">help</a> (std::ostream &os=std::cout) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Print further usage explanations to an output stream. <br></td></tr>
<tr><td colspan="2"><br><h2>Static Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">static <a class="el" href="classParams.html">Params</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classParams.html#e7e2ea302e1af9a646a57046850a6fc7">instance</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Controls all access to the global <a class="el" href="classParams.html">Params</a> instance. <a href="#e7e2ea302e1af9a646a57046850a6fc7"></a><br></td></tr>
<tr><td colspan="2"><br><h2>Public Attributes</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="f0c857dcd39182bef8922169a41a9672"></a><!-- doxytag: member="Params::help_" ref="f0c857dcd39182bef8922169a41a9672" args="" -->
bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classParams.html#f0c857dcd39182bef8922169a41a9672">help_</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Help option flag. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="1f2b048e91a9290b0de832461ad17bf1"></a><!-- doxytag: member="Params::version_" ref="1f2b048e91a9290b0de832461ad17bf1" args="" -->
bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classParams.html#1f2b048e91a9290b0de832461ad17bf1">version_</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Version option flag. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="3780008fd167a26f450f86a3d245d0f4"></a><!-- doxytag: member="Params::verbose_" ref="3780008fd167a26f450f86a3d245d0f4" args="" -->
bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classParams.html#3780008fd167a26f450f86a3d245d0f4">verbose_</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Verbose (talkative) option flag. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="38830685f4165d9bf59e04b63e14f8a1"></a><!-- doxytag: member="Params::force_" ref="38830685f4165d9bf59e04b63e14f8a1" args="" -->
bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classParams.html#38830685f4165d9bf59e04b63e14f8a1">force_</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Force overwrites flag. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="f0e20ffd358c9871b48b64911a7bae6d"></a><!-- doxytag: member="Params::binary_" ref="f0e20ffd358c9871b48b64911a7bae6d" args="" -->
bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classParams.html#f0e20ffd358c9871b48b64911a7bae6d">binary_</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Suppress long binary values. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="6bee2b60bff0fd80302f88bebbe92d00"></a><!-- doxytag: member="Params::unknown_" ref="6bee2b60bff0fd80302f88bebbe92d00" args="" -->
bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classParams.html#6bee2b60bff0fd80302f88bebbe92d00">unknown_</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Suppress unknown tags. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="10b02f6993a205d55e371af9c99ec446"></a><!-- doxytag: member="Params::preserve_" ref="10b02f6993a205d55e371af9c99ec446" args="" -->
bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classParams.html#10b02f6993a205d55e371af9c99ec446">preserve_</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Preserve existing metadata option flag. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="9fbb7b41344ee1bd376858c31a498a58"></a><!-- doxytag: member="Params::timestamp_" ref="9fbb7b41344ee1bd376858c31a498a58" args="" -->
bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classParams.html#9fbb7b41344ee1bd376858c31a498a58">timestamp_</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Rename also sets the file timestamp. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="c6d6478fc3f9d1257d74981d039f1b35"></a><!-- doxytag: member="Params::timestampOnly_" ref="c6d6478fc3f9d1257d74981d039f1b35" args="" -->
bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classParams.html#c6d6478fc3f9d1257d74981d039f1b35">timestampOnly_</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Rename only sets the file timestamp. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="976d918d69ed48713e078516c72195ef"></a><!-- doxytag: member="Params::fileExistsPolicy_" ref="976d918d69ed48713e078516c72195ef" args="" -->
<a class="el" href="classParams.html#6904db5cbd6b193b2c1e981f984ba7ef">FileExistsPolicy</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classParams.html#976d918d69ed48713e078516c72195ef">fileExistsPolicy_</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">What to do if file to rename exists. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="d8ff1a0c3297b1660e9efc03ef397dda"></a><!-- doxytag: member="Params::adjust_" ref="d8ff1a0c3297b1660e9efc03ef397dda" args="" -->
bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classParams.html#d8ff1a0c3297b1660e9efc03ef397dda">adjust_</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Adjustment flag. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="315817bd4a95fae7e0ce51cbc59d0b73"></a><!-- doxytag: member="Params::printMode_" ref="315817bd4a95fae7e0ce51cbc59d0b73" args="" -->
<a class="el" href="classParams.html#c490e98ae38d6ee481c4b3826ddbaceb">PrintMode</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classParams.html#315817bd4a95fae7e0ce51cbc59d0b73">printMode_</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Print mode. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">unsigned long </td><td class="memItemRight" valign="bottom"><a class="el" href="classParams.html#74076cfc604a52d6aa6ae72005171439">printItems_</a></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="f351636fd581fa9d5d7ba3bb214748b4"></a><!-- doxytag: member="Params::action_" ref="f351636fd581fa9d5d7ba3bb214748b4" args="" -->
int </td><td class="memItemRight" valign="bottom"><a class="el" href="classParams.html#f351636fd581fa9d5d7ba3bb214748b4">action_</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Action (integer rather than TaskType to avoid dependency). <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="1b0727408a23ae79073ed23899422497"></a><!-- doxytag: member="Params::target_" ref="1b0727408a23ae79073ed23899422497" args="" -->
int </td><td class="memItemRight" valign="bottom"><a class="el" href="classParams.html#1b0727408a23ae79073ed23899422497">target_</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">What common target to process. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="65fb87995fc95760133cc5c438f134ca"></a><!-- doxytag: member="Params::adjustment_" ref="65fb87995fc95760133cc5c438f134ca" args="" -->
long </td><td class="memItemRight" valign="bottom"><a class="el" href="classParams.html#65fb87995fc95760133cc5c438f134ca">adjustment_</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Adjustment in seconds. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="3291726d2fef924dbe75b9f590e2560c"></a><!-- doxytag: member="Params::format_" ref="3291726d2fef924dbe75b9f590e2560c" args="" -->
std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classParams.html#3291726d2fef924dbe75b9f590e2560c">format_</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Filename format (-r option arg). <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="31a9c0fea1eb0f185fdd561bd6bde6be"></a><!-- doxytag: member="Params::cmdFiles_" ref="31a9c0fea1eb0f185fdd561bd6bde6be" args="" -->
<a class="el" href="classParams.html#3ee16d0a5bc89c6ae3da8420a677554e">CmdFiles</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classParams.html#31a9c0fea1eb0f185fdd561bd6bde6be">cmdFiles_</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Names of the modification command files. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="75af62f6f0e1107e75a1aff721361f11"></a><!-- doxytag: member="Params::cmdLines_" ref="75af62f6f0e1107e75a1aff721361f11" args="" -->
<a class="el" href="classParams.html#3c0613498451b5729e5b32232a4fa39b">CmdLines</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classParams.html#75af62f6f0e1107e75a1aff721361f11">cmdLines_</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Commands from the command line. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="c5dd29cd9646b79992fa6c3ce5038262"></a><!-- doxytag: member="Params::modifyCmds_" ref="c5dd29cd9646b79992fa6c3ce5038262" args="" -->
<a class="el" href="exiv2_8hpp.html#7b6398c7c2e60a17c6aff1ff4b5de4f7">ModifyCmds</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classParams.html#c5dd29cd9646b79992fa6c3ce5038262">modifyCmds_</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Parsed modification commands. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="397459c7ed242ef7151d2a3652dda452"></a><!-- doxytag: member="Params::jpegComment_" ref="397459c7ed242ef7151d2a3652dda452" args="" -->
std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classParams.html#397459c7ed242ef7151d2a3652dda452">jpegComment_</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Jpeg comment to set in the image. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="58f1ad0d7dc7f0d43867016694d0ba8d"></a><!-- doxytag: member="Params::directory_" ref="58f1ad0d7dc7f0d43867016694d0ba8d" args="" -->
std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classParams.html#58f1ad0d7dc7f0d43867016694d0ba8d">directory_</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Location for files to extract/insert. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="b3ff04d4edef4e725866f6ca031f7a64"></a><!-- doxytag: member="Params::suffix_" ref="b3ff04d4edef4e725866f6ca031f7a64" args="" -->
std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classParams.html#b3ff04d4edef4e725866f6ca031f7a64">suffix_</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">File extension of the file to insert. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="e35b7af0ea7e9df2245c706783b7329e"></a><!-- doxytag: member="Params::files_" ref="e35b7af0ea7e9df2245c706783b7329e" args="" -->
<a class="el" href="classParams.html#4760eec97bf28489316873d58a3d9a36">Files</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classParams.html#e35b7af0ea7e9df2245c706783b7329e">files_</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">List of non-option arguments. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="7a01b5ff1c17593f1eecaf4e0df7db47"></a><!-- doxytag: member="Params::iptc_" ref="7a01b5ff1c17593f1eecaf4e0df7db47" args="" -->
bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classParams.html#7a01b5ff1c17593f1eecaf4e0df7db47">iptc_</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Iptc option flag. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="affe969d9556670ddfd83d410e006188"></a><!-- doxytag: member="Params::exif_" ref="affe969d9556670ddfd83d410e006188" args="" -->
bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classParams.html#affe969d9556670ddfd83d410e006188">exif_</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Exif option flag. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="cc2a1284cac26bf160f5d047d36191a8"></a><!-- doxytag: member="Params::comment_" ref="cc2a1284cac26bf160f5d047d36191a8" args="" -->
bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classParams.html#cc2a1284cac26bf160f5d047d36191a8">comment_</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">JPEG comment option flag. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="77c0853fd32e67fde5ed8fb584be056d"></a><!-- doxytag: member="Params::read_" ref="77c0853fd32e67fde5ed8fb584be056d" args="" -->
std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classParams.html#77c0853fd32e67fde5ed8fb584be056d">read_</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Source file. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="8367e5a194f49e139d059da770657023"></a><!-- doxytag: member="Params::write_" ref="8367e5a194f49e139d059da770657023" args="" -->
std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classParams.html#8367e5a194f49e139d059da770657023">write_</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Destination file. <br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
Implements the command line handling for the program.
<p>
Derives from <a class="el" href="classUtil_1_1Getopt.html">Util::Getopt</a> to use the command line argument parsing functionalty provided there. This class is implemented as a Singleton, i.e., there is only one global instance of it, which can be accessed from everywhere.<p>
<b>Usage example:</b> <br>
<div class="fragment"><pre class="fragment"><span class="preprocessor"> #include "params.h"</span>
<span class="keywordtype">int</span> main(<span class="keywordtype">int</span> argc, <span class="keywordtype">char</span>* <span class="keyword">const</span> argv[])
{
<a class="code" href="classParams.html">Params</a>& params = <a class="code" href="classParams.html#e7e2ea302e1af9a646a57046850a6fc7">Params::instance</a>();
<span class="keywordflow">if</span> (params.<a class="code" href="classParams.html#3ba82915162067d66a83b54bca05e241">getopt</a>(argc, argv)) {
params.<a class="code" href="classParams.html#89d66afdb73659019d84729d2baa9ef9">usage</a>();
<span class="keywordflow">return</span> 1;
}
<span class="keywordflow">if</span> (params.<a class="code" href="classParams.html#f0c857dcd39182bef8922169a41a9672">help_</a>) {
params.<a class="code" href="classParams.html#e91b9ae6d86aa58ca7d1bc1f7542f22c">help</a>();
<span class="keywordflow">return</span> 0;
}
<span class="keywordflow">if</span> (params.<a class="code" href="classParams.html#1f2b048e91a9290b0de832461ad17bf1">version_</a>) {
params.<a class="code" href="classParams.html#9b1c3243120fea036a402b1ef5d1f6c3">version</a>();
<span class="keywordflow">return</span> 0;
}
<span class="comment">// do something useful here...</span>
<span class="keywordflow">return</span> 0;
}
</pre></div>
<p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="3ba82915162067d66a83b54bca05e241"></a><!-- doxytag: member="Params::getopt" ref="3ba82915162067d66a83b54bca05e241" args="(int argc, char *const argv[])" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">int Params::getopt </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">int </td>
<td class="mdname" nowrap> <em>argc</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap>char *const </td>
<td class="mdname" nowrap> <em>argv</em>[]</td>
</tr>
<tr>
<td class="md"></td>
<td class="md">) </td>
<td class="md" colspan="2"></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Call Getopt::getopt() with optstring, to initiate command line argument parsing, perform consistency checks after all command line arguments are parsed.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>argc</em> </td><td>Argument count as passed to main() on program invocation. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>argv</em> </td><td>Argument array as passed to main() on program invocation.</td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>0 if successful, >0 in case of errors. </dd></dl>
</td>
</tr>
</table>
<a class="anchor" name="3ba82915162067d66a83b54bca05e241"></a><!-- doxytag: member="Params::getopt" ref="3ba82915162067d66a83b54bca05e241" args="(int argc, char *const argv[])" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">int Params::getopt </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">int </td>
<td class="mdname" nowrap> <em>argc</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap>char *const </td>
<td class="mdname" nowrap> <em>argv</em>[]</td>
</tr>
<tr>
<td class="md"></td>
<td class="md">) </td>
<td class="md" colspan="2"></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Call Getopt::getopt() with optstring, to inititate command line argument parsing, perform consistency checks after all command line arguments are parsed.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>argc</em> </td><td>Argument count as passed to main() on program invocation. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>argv</em> </td><td>Argument array as passed to main() on program invocation.</td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>0 if successful, >0 in case of errors. </dd></dl>
</td>
</tr>
</table>
<a class="anchor" name="e7e2ea302e1af9a646a57046850a6fc7"></a><!-- doxytag: member="Params::instance" ref="e7e2ea302e1af9a646a57046850a6fc7" args="()" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"><a class="el" href="classParams.html">Params</a> & Params::instance </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap><code> [static]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Controls all access to the global <a class="el" href="classParams.html">Params</a> instance.
<p>
<dl compact><dt><b>Returns:</b></dt><dd>Reference to the global <a class="el" href="classParams.html">Params</a> instance. </dd></dl>
</td>
</tr>
</table>
<hr><h2>Member Data Documentation</h2>
<a class="anchor" name="74076cfc604a52d6aa6ae72005171439"></a><!-- doxytag: member="Params::printItems_" ref="74076cfc604a52d6aa6ae72005171439" args="" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">unsigned long <a class="el" href="classParams.html#74076cfc604a52d6aa6ae72005171439">Params::printItems_</a> </td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Print items. </td>
</tr>
</table>
<hr>The documentation for this class was generated from the following files:<ul>
<li><a class="el" href="exiv2_8hpp.html">exiv2.hpp</a><li><a class="el" href="metacopy_8hpp.html">metacopy.hpp</a><li>exiv2.cpp<li>metacopy.cpp</ul>
<hr size="1"><address style="align: right;"><small>Generated on Fri Jun 2 23:54:38 2006 for Exiv2 by
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.6 </small></address>
</body>
</html>
|
