<!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: Exiv2::XmpData 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 class="navpath"><a class="el" href="namespaceExiv2.html">Exiv2</a>::<a class="el" href="classExiv2_1_1XmpData.html">XmpData</a>
</div>
</div>
<div class="contents">
<h1>Exiv2::XmpData Class Reference</h1><!-- doxytag: class="Exiv2::XmpData" -->A container for XMP data. This is a top-level class of the Exiv2 library.
<a href="#_details">More...</a>
<p>
<code>#include <xmp.hpp></code>
<p>
<div class="dynheader">
Collaboration diagram for Exiv2::XmpData:</div>
<div class="dynsection">
<p><center><img src="classExiv2_1_1XmpData__coll__graph.png" border="0" usemap="#Exiv2_1_1XmpData__coll__map" alt="Collaboration graph"></center>
<map name="Exiv2_1_1XmpData__coll__map">
<area shape="rect" id="node4" href="classExiv2_1_1Xmpdatum.html" title="Information related to an XMP property. An XMP metadatum consists of an XmpKey and..." alt="" coords="349,379,520,405"><area shape="rect" id="node6" href="classExiv2_1_1Metadatum.html" title="Abstract base class defining the interface to access information related to one metadata..." alt="" coords="113,288,295,315"><area shape="rect" id="node8" href="structExiv2_1_1Xmpdatum_1_1Impl.html" title="Internal Pimpl structure of class Xmpdatum." alt="" coords="319,288,551,315"><area shape="rect" id="node12" href="classExiv2_1_1XmpKey.html" title="Concrete keys for XMP metadata." alt="" coords="5,96,157,123"><area shape="rect" id="node14" href="classExiv2_1_1Key.html" title="Abstract base class defining the Key of a metadatum. Keys are used to identify and..." alt="" coords="21,5,141,32"><area shape="rect" id="node16" title="STL class." alt="" coords="181,96,381,123"><area shape="rect" id="node25" title="STL class." alt="" coords="508,147,689,173"><area shape="rect" id="node22" href="classExiv2_1_1Value.html" title="Common interface for all types of values used with metadata." alt="" coords="405,96,547,123"></map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div>
<p>
<a href="classExiv2_1_1XmpData-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="6ad054efbea675843895e3f74c3c1923"></a><!-- doxytag: member="Exiv2::XmpData::iterator" ref="6ad054efbea675843895e3f74c3c1923" args="" -->
typedef XmpMetadata::iterator </td><td class="memItemRight" valign="bottom"><a class="el" href="classExiv2_1_1XmpData.html#6ad054efbea675843895e3f74c3c1923">iterator</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">XmpMetadata iterator type. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="9c0a6575296f3da8bfc200091da40f2e"></a><!-- doxytag: member="Exiv2::XmpData::const_iterator" ref="9c0a6575296f3da8bfc200091da40f2e" args="" -->
typedef XmpMetadata::const_iterator </td><td class="memItemRight" valign="bottom"><a class="el" href="classExiv2_1_1XmpData.html#9c0a6575296f3da8bfc200091da40f2e">const_iterator</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">XmpMetadata const iterator type. <br></td></tr>
<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
<tr><td colspan="2"><div class="groupHeader">Manipulators</div></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classExiv2_1_1Xmpdatum.html">Xmpdatum</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classExiv2_1_1XmpData.html#ea04017bc03a315d2c8045f889233d54">operator[]</a> (const std::string &key)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns a reference to the Xmpdatum that is associated with a particular <em>key</em>. If XmpData does not already contain such an Xmpdatum, operator[] adds object <em>Xmpdatum(key)</em>. <a href="#ea04017bc03a315d2c8045f889233d54"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classExiv2_1_1XmpData.html#8ce28ae5c68a30b8e646c7ddfed75843">add</a> (const <a class="el" href="classExiv2_1_1XmpKey.html">XmpKey</a> &key, const <a class="el" href="classExiv2_1_1Value.html">Value</a> *value)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Add an Xmpdatum from the supplied key and value pair. This method copies (clones) the value. <a href="#8ce28ae5c68a30b8e646c7ddfed75843"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classExiv2_1_1XmpData.html#23383a89960ba5b9c6c753b4b0b83198">add</a> (const <a class="el" href="classExiv2_1_1Xmpdatum.html">Xmpdatum</a> &xmpdatum)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Add a copy of the <a class="el" href="classExiv2_1_1Xmpdatum.html" title="Information related to an XMP property. An XMP metadatum consists of an XmpKey and...">Xmpdatum</a> to the XMP metadata. <a href="#23383a89960ba5b9c6c753b4b0b83198"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classExiv2_1_1XmpData.html#6ad054efbea675843895e3f74c3c1923">iterator</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classExiv2_1_1XmpData.html#6c7f21d38928596ead01c988ea3e62d2">erase</a> (<a class="el" href="classExiv2_1_1XmpData.html#6ad054efbea675843895e3f74c3c1923">iterator</a> pos)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Delete the <a class="el" href="classExiv2_1_1Xmpdatum.html" title="Information related to an XMP property. An XMP metadatum consists of an XmpKey and...">Xmpdatum</a> at iterator position pos, return the position of the next <a class="el" href="classExiv2_1_1Xmpdatum.html" title="Information related to an XMP property. An XMP metadatum consists of an XmpKey and...">Xmpdatum</a>. <a href="#6c7f21d38928596ead01c988ea3e62d2"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="b7e69abc3ee547aacb45893aa8d83051"></a><!-- doxytag: member="Exiv2::XmpData::clear" ref="b7e69abc3ee547aacb45893aa8d83051" args="()" -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classExiv2_1_1XmpData.html#b7e69abc3ee547aacb45893aa8d83051">clear</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Delete all <a class="el" href="classExiv2_1_1Xmpdatum.html" title="Information related to an XMP property. An XMP metadatum consists of an XmpKey and...">Xmpdatum</a> instances resulting in an empty container. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="afa3be4e1c7056450d6448a9b5240e95"></a><!-- doxytag: member="Exiv2::XmpData::sortByKey" ref="afa3be4e1c7056450d6448a9b5240e95" args="()" -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classExiv2_1_1XmpData.html#afa3be4e1c7056450d6448a9b5240e95">sortByKey</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Sort metadata by key. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="b79f31eb811252976d01f2e69fa063a2"></a><!-- doxytag: member="Exiv2::XmpData::begin" ref="b79f31eb811252976d01f2e69fa063a2" args="()" -->
<a class="el" href="classExiv2_1_1XmpData.html#6ad054efbea675843895e3f74c3c1923">iterator</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classExiv2_1_1XmpData.html#b79f31eb811252976d01f2e69fa063a2">begin</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Begin of the metadata. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="232b8897f5d90a6bc087d7d010e80b92"></a><!-- doxytag: member="Exiv2::XmpData::end" ref="232b8897f5d90a6bc087d7d010e80b92" args="()" -->
<a class="el" href="classExiv2_1_1XmpData.html#6ad054efbea675843895e3f74c3c1923">iterator</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classExiv2_1_1XmpData.html#232b8897f5d90a6bc087d7d010e80b92">end</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">End of the metadata. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="91864d348037f21fedb7c0591180b37d"></a><!-- doxytag: member="Exiv2::XmpData::findKey" ref="91864d348037f21fedb7c0591180b37d" args="(const XmpKey &key)" -->
<a class="el" href="classExiv2_1_1XmpData.html#6ad054efbea675843895e3f74c3c1923">iterator</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classExiv2_1_1XmpData.html#91864d348037f21fedb7c0591180b37d">findKey</a> (const <a class="el" href="classExiv2_1_1XmpKey.html">XmpKey</a> &key)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Find the first <a class="el" href="classExiv2_1_1Xmpdatum.html" title="Information related to an XMP property. An XMP metadatum consists of an XmpKey and...">Xmpdatum</a> with the given key, return an iterator to it. <br></td></tr>
<tr><td colspan="2"><div class="groupHeader">Accessors</div></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="081f1eb67488b3a156c7dd8161b7e9d0"></a><!-- doxytag: member="Exiv2::XmpData::begin" ref="081f1eb67488b3a156c7dd8161b7e9d0" args="() const " -->
<a class="el" href="classExiv2_1_1XmpData.html#9c0a6575296f3da8bfc200091da40f2e">const_iterator</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classExiv2_1_1XmpData.html#081f1eb67488b3a156c7dd8161b7e9d0">begin</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Begin of the metadata. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="3b7f699ba39823b8c1d714e15afc1fcd"></a><!-- doxytag: member="Exiv2::XmpData::end" ref="3b7f699ba39823b8c1d714e15afc1fcd" args="() const " -->
<a class="el" href="classExiv2_1_1XmpData.html#9c0a6575296f3da8bfc200091da40f2e">const_iterator</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classExiv2_1_1XmpData.html#3b7f699ba39823b8c1d714e15afc1fcd">end</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">End of the metadata. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="9dfdeaa1a297d63a721fb7249ab00e12"></a><!-- doxytag: member="Exiv2::XmpData::findKey" ref="9dfdeaa1a297d63a721fb7249ab00e12" args="(const XmpKey &key) const " -->
<a class="el" href="classExiv2_1_1XmpData.html#9c0a6575296f3da8bfc200091da40f2e">const_iterator</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classExiv2_1_1XmpData.html#9dfdeaa1a297d63a721fb7249ab00e12">findKey</a> (const <a class="el" href="classExiv2_1_1XmpKey.html">XmpKey</a> &key) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Find the first <a class="el" href="classExiv2_1_1Xmpdatum.html" title="Information related to an XMP property. An XMP metadatum consists of an XmpKey and...">Xmpdatum</a> with the given key, return a const iterator to it. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="43064f07800d084d5c4f9413c704f298"></a><!-- doxytag: member="Exiv2::XmpData::empty" ref="43064f07800d084d5c4f9413c704f298" args="() const " -->
bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classExiv2_1_1XmpData.html#43064f07800d084d5c4f9413c704f298">empty</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return true if there is no XMP metadata. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="65b24c7bef3d7e9f2b58edfc19571753"></a><!-- doxytag: member="Exiv2::XmpData::count" ref="65b24c7bef3d7e9f2b58edfc19571753" args="() const " -->
long </td><td class="memItemRight" valign="bottom"><a class="el" href="classExiv2_1_1XmpData.html#65b24c7bef3d7e9f2b58edfc19571753">count</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the number of metadata entries. <br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
A container for XMP data. This is a top-level class of the Exiv2 library.
<p>
Provide high-level access to the XMP data of an image:<ul>
<li>read XMP information from an XML block</li><li>access metadata through keys and standard C++ iterators</li><li>add, modify and delete metadata</li><li>serialize XMP data to an XML block </li></ul>
<dl compact><dt><b>Examples: </b></dt><dd>
<p>
<a class="el" href="xmpsample_8cpp-example.html#_a0">xmpsample.cpp</a>.</dl><hr><h2>Member Function Documentation</h2>
<a class="anchor" name="23383a89960ba5b9c6c753b4b0b83198"></a><!-- doxytag: member="Exiv2::XmpData::add" ref="23383a89960ba5b9c6c753b4b0b83198" args="(const Xmpdatum &xmpdatum)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int Exiv2::XmpData::add </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classExiv2_1_1Xmpdatum.html">Xmpdatum</a> & </td>
<td class="paramname"> <em>xmpdatum</em> </td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Add a copy of the <a class="el" href="classExiv2_1_1Xmpdatum.html" title="Information related to an XMP property. An XMP metadatum consists of an XmpKey and...">Xmpdatum</a> to the XMP metadata.
<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>0 if successful. </dd></dl>
</div>
</div><p>
<a class="anchor" name="8ce28ae5c68a30b8e646c7ddfed75843"></a><!-- doxytag: member="Exiv2::XmpData::add" ref="8ce28ae5c68a30b8e646c7ddfed75843" args="(const XmpKey &key, const Value *value)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int Exiv2::XmpData::add </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classExiv2_1_1XmpKey.html">XmpKey</a> & </td>
<td class="paramname"> <em>key</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classExiv2_1_1Value.html">Value</a> * </td>
<td class="paramname"> <em>value</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Add an Xmpdatum from the supplied key and value pair. This method copies (clones) the value.
<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>0 if successful. </dd></dl>
<dl compact><dt><b>Examples: </b></dt><dd>
<a class="el" href="xmpsample_8cpp-example.html#a15">xmpsample.cpp</a>.</dl>
<p>Referenced by <a class="el" href="xmp_8cpp_source.html#l00434">Exiv2::XmpParser::decode()</a>, and <a class="el" href="xmp_8cpp_source.html#l00293">operator[]()</a>.</p>
</div>
</div><p>
<a class="anchor" name="6c7f21d38928596ead01c988ea3e62d2"></a><!-- doxytag: member="Exiv2::XmpData::erase" ref="6c7f21d38928596ead01c988ea3e62d2" args="(iterator pos)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classExiv2_1_1XmpData.html#6ad054efbea675843895e3f74c3c1923">XmpData::iterator</a> Exiv2::XmpData::erase </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classExiv2_1_1XmpData.html#6ad054efbea675843895e3f74c3c1923">XmpData::iterator</a> </td>
<td class="paramname"> <em>pos</em> </td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Delete the <a class="el" href="classExiv2_1_1Xmpdatum.html" title="Information related to an XMP property. An XMP metadatum consists of an XmpKey and...">Xmpdatum</a> at iterator position pos, return the position of the next <a class="el" href="classExiv2_1_1Xmpdatum.html" title="Information related to an XMP property. An XMP metadatum consists of an XmpKey and...">Xmpdatum</a>.
<p>
<dl class="note" compact><dt><b>Note:</b></dt><dd>Iterators into the metadata, including pos, are potentially invalidated by this call. </dd></dl>
<dl compact><dt><b>Examples: </b></dt><dd>
<a class="el" href="xmpsample_8cpp-example.html#a12">xmpsample.cpp</a>.</dl>
<p>Referenced by <a class="el" href="convert_8cpp_source.html#l00778">Exiv2::Converter::cnvXmpArray()</a>, <a class="el" href="convert_8cpp_source.html#l00761">Exiv2::Converter::cnvXmpComment()</a>, <a class="el" href="convert_8cpp_source.html#l00798">Exiv2::Converter::cnvXmpDate()</a>, <a class="el" href="convert_8cpp_source.html#l00928">Exiv2::Converter::cnvXmpFlash()</a>, <a class="el" href="convert_8cpp_source.html#l00989">Exiv2::Converter::cnvXmpGPSCoord()</a>, <a class="el" href="convert_8cpp_source.html#l00907">Exiv2::Converter::cnvXmpGPSVersion()</a>, <a class="el" href="convert_8cpp_source.html#l00740">Exiv2::Converter::cnvXmpValue()</a>, <a class="el" href="convert_8cpp_source.html#l01069">Exiv2::Converter::cnvXmpValueToIptc()</a>, and <a class="el" href="convert_8cpp_source.html#l00884">Exiv2::Converter::cnvXmpVersion()</a>.</p>
</div>
</div><p>
<a class="anchor" name="ea04017bc03a315d2c8045f889233d54"></a><!-- doxytag: member="Exiv2::XmpData::operator[]" ref="ea04017bc03a315d2c8045f889233d54" args="(const std::string &key)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classExiv2_1_1Xmpdatum.html">Xmpdatum</a> & Exiv2::XmpData::operator[] </td>
<td>(</td>
<td class="paramtype">const std::string & </td>
<td class="paramname"> <em>key</em> </td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Returns a reference to the Xmpdatum that is associated with a particular <em>key</em>. If XmpData does not already contain such an Xmpdatum, operator[] adds object <em>Xmpdatum(key)</em>.
<p>
<dl class="note" compact><dt><b>Note:</b></dt><dd>Since operator[] might insert a new element, it can't be a const member function. </dd></dl>
<p>References <a class="el" href="xmp_8cpp_source.html#l00304">add()</a>, <a class="el" href="xmp_8cpp_source.html#l00362">end()</a>, and <a class="el" href="xmp_8cpp_source.html#l00321">findKey()</a>.</p>
</div>
</div><p>
<hr>The documentation for this class was generated from the following files:<ul>
<li><a class="el" href="xmp_8hpp.html">xmp.hpp</a><li>xmp.cpp</ul>
</div>
<hr size="1"><address style="text-align: right;"><small>Generated on Thu Jun 25 15:18:10 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>
