<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
<title>Exiv2: Params Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css">
<link href="doxygen.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.5.9 -->
<div class="navigation" id="top">
<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 class="current"><a href="annotated.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>
<li>
<form action="search.php" method="get">
<table cellspacing="0" cellpadding="0" border="0">
<tr>
<td><label> <u>S</u>earch for </label></td>
<td><input type="text" name="query" value="" size="20" accesskey="s"/></td>
</tr>
</table>
</form>
</li>
</ul>
</div>
<div class="tabs">
<ul>
<li><a href="annotated.html"><span>Class List</span></a></li>
<li><a href="classes.html"><span>Class Index</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>
</div>
<div class="contents">
<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>
<div class="dynheader">
Inheritance diagram for Params:</div>
<div class="dynsection">
<p><center><img src="classParams__inherit__graph.png" border="0" usemap="#Params__inherit__map" alt="Inheritance graph"></center>
<map name="Params__inherit__map">
<area shape="rect" id="node2" href="classUtil_1_1Getopt.html" title="Parse the command line options of a program." alt="" coords="5,5,147,32"></map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div>
<div class="dynheader">
Collaboration diagram for Params:</div>
<div class="dynsection">
<p><center><img src="classParams__coll__graph.png" border="0" usemap="#Params__coll__map" alt="Collaboration graph"></center>
<map name="Params__coll__map">
<area shape="rect" id="node2" href="classUtil_1_1Getopt.html" title="Parse the command line options of a program." alt="" coords="1023,67,1164,93"><area shape="rect" id="node4" title="STL class." alt="" coords="311,143,441,169"><area shape="rect" id="node11" href="structModifyCmd.html" title="Structure for one parsed modification command." alt="" coords="605,168,717,195"><area shape="rect" id="node6" title="STL class." alt="" coords="7,143,257,169"><area shape="rect" id="node14" title="STL class." alt="" coords="571,288,752,315"><area shape="rect" id="node18" href="structParams_1_1YodAdjust.html" title="Structure for year, month and day adjustment command line arguments." alt="" coords="997,287,1189,313"><area shape="rect" id="node23" title="STL class." alt="" coords="585,345,737,372"></map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div>
<p>
<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>Classes</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">struct </td><td class="memItemRight" valign="bottom"><a class="el" href="structParams_1_1YodAdjust.html">YodAdjust</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Structure for year, month and day adjustment command line arguments. <a href="structParams_1_1YodAdjust.html#_details">More...</a><br></td></tr>
<tr><td colspan="2"><br><h2>Public Types</h2></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>pmComment</b>,
<b>pmPreview</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, 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#a92bcffc432ebf5f3db4b302b11e9db0">CommonTarget</a> { <br>
<b>ctExif</b> = 1,
<b>ctIptc</b> = 2,
<b>ctComment</b> = 4,
<b>ctThumb</b> = 8,
<br>
<b>ctXmp</b> = 16,
<b>ctXmpSidecar</b> = 32,
<b>ctPreview</b> = 64
<br>
}</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 class="memItemLeft" nowrap align="right" valign="top">enum </td><td class="memItemRight" valign="bottom"><a class="el" href="classParams.html#2bd54605371c167586b533e490bc2281">Yod</a> { <b>yodYear</b>,
<b>yodMonth</b>,
<b>yodDay</b>
}</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Enumerates year, month and day adjustments. <br></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"><a class="anchor" name="9930450e878547651383abbb09542015"></a><!-- doxytag: member="Params::PreviewNumbers" ref="9930450e878547651383abbb09542015" args="" -->
typedef std::set< int > </td><td class="memItemRight" valign="bottom"><a class="el" href="classParams.html#9930450e878547651383abbb09542015">PreviewNumbers</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Container for preview image numbers. <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" title="Implements the command line handling for the program.">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">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 timestamps flag. <a href="#10b02f6993a205d55e371af9c99ec446"></a><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"><a class="anchor" name="74076cfc604a52d6aa6ae72005171439"></a><!-- doxytag: member="Params::printItems_" ref="74076cfc604a52d6aa6ae72005171439" args="" -->
unsigned long </td><td class="memItemRight" valign="bottom"><a class="el" href="classParams.html#74076cfc604a52d6aa6ae72005171439">printItems_</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Print items. <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#5f4a5243c5c344d6b700f65155b8c1a2">printTags_</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="dad79422f55ee662b3d4dc6c2775eb18"></a><!-- doxytag: member="Params::yodAdjust_" ref="dad79422f55ee662b3d4dc6c2775eb18" args="[3]" -->
<a class="el" href="structParams_1_1YodAdjust.html">YodAdjust</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classParams.html#dad79422f55ee662b3d4dc6c2775eb18">yodAdjust_</a> [3]</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Year, month and day adjustment info. <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="57f44672ef8aa311c8645c003dd50a6e"></a><!-- doxytag: member="Params::formatSet_" ref="57f44672ef8aa311c8645c003dd50a6e" args="" -->
bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classParams.html#57f44672ef8aa311c8645c003dd50a6e">formatSet_</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Whether the format is set with -r. <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="3276c4224b059c6d0f11e6111b760516"></a><!-- doxytag: member="Params::previewNumbers_" ref="3276c4224b059c6d0f11e6111b760516" args="" -->
<a class="el" href="classParams.html#9930450e878547651383abbb09542015">PreviewNumbers</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classParams.html#3276c4224b059c6d0f11e6111b760516">previewNumbers_</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">List of preview numbers. <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" title="Parse the command line options of a program.">Util::Getopt</a> to use the command line argument parsing functionality 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" title="Implements the command line handling for the program.">Params</a>& params = <a class="code" href="classParams.html#e7e2ea302e1af9a646a57046850a6fc7" title="Controls all access to the global Params instance.">Params::instance</a>();
<span class="keywordflow">if</span> (params.<a class="code" href="classParams.html#3ba82915162067d66a83b54bca05e241" title="Call Getopt::getopt() with optstring, to inititate command line argument parsing...">getopt</a>(argc, argv)) {
params.<a class="code" href="classParams.html#89d66afdb73659019d84729d2baa9ef9" title="Print a minimal usage note to an output stream.">usage</a>();
<span class="keywordflow">return</span> 1;
}
<span class="keywordflow">if</span> (params.<a class="code" href="classParams.html#f0c857dcd39182bef8922169a41a9672" title="Help option flag.">help_</a>) {
params.<a class="code" href="classParams.html#e91b9ae6d86aa58ca7d1bc1f7542f22c" title="Print further usage explanations to an output stream.">help</a>();
<span class="keywordflow">return</span> 0;
}
<span class="keywordflow">if</span> (params.<a class="code" href="classParams.html#1f2b048e91a9290b0de832461ad17bf1" title="Version option flag.">version_</a>) {
params.<a class="code" href="classParams.html#9b1c3243120fea036a402b1ef5d1f6c3" title="Print version information to an output stream.">version</a>();
<span class="keywordflow">return</span> 0;
}
<span class="keywordflow">do</span> something useful here...
<span class="keywordflow">return</span> 0;
}
</pre></div> <hr><h2>Member Function Documentation</h2>
<a class="anchor" name="3ba82915162067d66a83b54bca05e241"></a><!-- doxytag: member="Params::getopt" ref="3ba82915162067d66a83b54bca05e241" args="(int argc, char *const argv[])" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int Params::getopt </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"> <em>argc</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">char *const </td>
<td class="paramname"> <em>argv</em>[]</td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<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 class="return" compact><dt><b>Returns:</b></dt><dd>0 if successful, >0 in case of errors. </dd></dl>
</div>
</div><p>
<a class="anchor" name="3ba82915162067d66a83b54bca05e241"></a><!-- doxytag: member="Params::getopt" ref="3ba82915162067d66a83b54bca05e241" args="(int argc, char *const argv[])" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int Params::getopt </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"> <em>argc</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">char *const </td>
<td class="paramname"> <em>argv</em>[]</td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<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 class="return" compact><dt><b>Returns:</b></dt><dd>0 if successful, >0 in case of errors. </dd></dl>
<p>References <a class="el" href="exiv2_8hpp_source.html#l00190">action_</a>, <a class="el" href="exiv2_8hpp_source.html#l00185">adjust_</a>, <a class="el" href="exiv2_8hpp_source.html#l00197">cmdFiles_</a>, <a class="el" href="exiv2_8hpp_source.html#l00198">cmdLines_</a>, <a class="el" href="exiv2_8hpp_source.html#l00201">directory_</a>, <a class="el" href="exiv2_8hpp_source.html#l00203">files_</a>, <a class="el" href="exiv2_8hpp_source.html#l00175">help_</a>, <a class="el" href="exiv2_8hpp_source.html#l00200">jpegComment_</a>, <a class="el" href="exiv2_8hpp_source.html#l00199">modifyCmds_</a>, <a class="el" href="utils_8hpp_source.html#l00117">Util::Getopt::progname()</a>, <a class="el" href="exiv2_8hpp_source.html#l00202">suffix_</a>, <a class="el" href="exiv2_8hpp_source.html#l00182">timestamp_</a>, <a class="el" href="exiv2_8hpp_source.html#l00183">timestampOnly_</a>, <a class="el" href="exiv2_8hpp_source.html#l00176">version_</a>, and <a class="el" href="exiv2_8hpp_source.html#l00194">yodAdjust_</a>.</p>
</div>
</div><p>
<a class="anchor" name="e7e2ea302e1af9a646a57046850a6fc7"></a><!-- doxytag: member="Params::instance" ref="e7e2ea302e1af9a646a57046850a6fc7" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classParams.html">Params</a> & Params::instance </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Controls all access to the global <a class="el" href="classParams.html" title="Implements the command line handling for the program.">Params</a> instance.
<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>Reference to the global <a class="el" href="classParams.html" title="Implements the command line handling for the program.">Params</a> instance. </dd></dl>
<p>Referenced by <a class="el" href="actions_8cpp_source.html#l01174">Action::Modify::applyCommands()</a>, <a class="el" href="actions_8cpp_source.html#l00874">Action::Erase::eraseComment()</a>, <a class="el" href="actions_8cpp_source.html#l00850">Action::Erase::eraseExifData()</a>, <a class="el" href="actions_8cpp_source.html#l00865">Action::Erase::eraseIptcData()</a>, <a class="el" href="actions_8cpp_source.html#l00836">Action::Erase::eraseThumbnail()</a>, <a class="el" href="actions_8cpp_source.html#l00883">Action::Erase::eraseXmpData()</a>, <a class="el" href="actions_8cpp_source.html#l00645">Action::Print::printComment()</a>, <a class="el" href="actions_8cpp_source.html#l00429">Action::Print::printLabel()</a>, <a class="el" href="actions_8cpp_source.html#l00474">Action::Print::printList()</a>, <a class="el" href="actions_8cpp_source.html#l00535">Action::Print::printMetadatum()</a>, <a class="el" href="actions_8cpp_source.html#l00662">Action::Print::printPreviewList()</a>, <a class="el" href="actions_8cpp_source.html#l01511">Action::FixIso::run()</a>, <a class="el" href="actions_8cpp_source.html#l01375">Action::Adjust::run()</a>, <a class="el" href="actions_8cpp_source.html#l01140">Action::Modify::run()</a>, <a class="el" href="actions_8cpp_source.html#l01041">Action::Insert::run()</a>, <a class="el" href="actions_8cpp_source.html#l00903">Action::Extract::run()</a>, <a class="el" href="actions_8cpp_source.html#l00787">Action::Erase::run()</a>, <a class="el" href="actions_8cpp_source.html#l00702">Action::Rename::run()</a>, <a class="el" href="actions_8cpp_source.html#l00229">Action::Print::run()</a>, <a class="el" href="actions_8cpp_source.html#l01009">Action::Extract::writePreviewFile()</a>, <a class="el" href="actions_8cpp_source.html#l00976">Action::Extract::writePreviews()</a>, and <a class="el" href="actions_8cpp_source.html#l00934">Action::Extract::writeThumbnail()</a>.</p>
</div>
</div><p>
<hr><h2>Member Data Documentation</h2>
<a class="anchor" name="10b02f6993a205d55e371af9c99ec446"></a><!-- doxytag: member="Params::preserve_" ref="10b02f6993a205d55e371af9c99ec446" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool <a class="el" href="classParams.html#10b02f6993a205d55e371af9c99ec446">Params::preserve_</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Preserve timestamps flag.
<p>
Preserve existing metadata option flag.
<p>Referenced by <a class="el" href="exiv2_8cpp_source.html#l00322">option()</a>.</p>
</div>
</div><p>
<a class="anchor" name="5f4a5243c5c344d6b700f65155b8c1a2"></a><!-- doxytag: member="Params::printTags_" ref="5f4a5243c5c344d6b700f65155b8c1a2" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">unsigned long <a class="el" href="classParams.html#5f4a5243c5c344d6b700f65155b8c1a2">Params::printTags_</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Print tags (bitmap of MetadataId flags).
<p>Referenced by <a class="el" href="actions_8cpp_source.html#l00474">Action::Print::printList()</a>.</p>
</div>
</div><p>
<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>
</div>
<hr size="1"><address style="text-align: right;"><small>Generated on Thu Jun 25 15:17:42 2009 for Exiv2 by
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.9 </small></address>
</body>
</html>
