<!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::XmpValue 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_1XmpValue.html">XmpValue</a>
</div>
</div>
<div class="contents">
<h1>Exiv2::XmpValue Class Reference</h1><!-- doxytag: class="Exiv2::XmpValue" --><!-- doxytag: inherits="Exiv2::Value" -->Base class for all <a class="el" href="namespaceExiv2.html" title="Provides classes and functions to encode and decode Exif and Iptc data. The libexiv2...">Exiv2</a> values used to store XMP property values.
<a href="#_details">More...</a>
<p>
<code>#include <value.hpp></code>
<p>
<div class="dynheader">
Inheritance diagram for Exiv2::XmpValue:</div>
<div class="dynsection">
<p><center><img src="classExiv2_1_1XmpValue__inherit__graph.png" border="0" usemap="#Exiv2_1_1XmpValue__inherit__map" alt="Inheritance graph"></center>
<map name="Exiv2_1_1XmpValue__inherit__map">
<area shape="rect" id="node5" href="classExiv2_1_1LangAltValue.html" title="Value type for XMP language alternative properties." alt="" coords="5,155,216,181"><area shape="rect" id="node7" href="classExiv2_1_1XmpArrayValue.html" title="Value type for simple arrays. Each item in the array is a simple value, without qualifiers..." alt="" coords="240,155,461,181"><area shape="rect" id="node9" href="classExiv2_1_1XmpTextValue.html" title="Value type suitable for simple XMP properties and XMP nodes of complex types which..." alt="" coords="485,155,696,181"><area shape="rect" id="node2" href="classExiv2_1_1Value.html" title="Common interface for all types of values used with metadata." alt="" coords="280,5,421,32"></map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div>
<div class="dynheader">
Collaboration diagram for Exiv2::XmpValue:</div>
<div class="dynsection">
<p><center><img src="classExiv2_1_1XmpValue__coll__graph.png" border="0" usemap="#Exiv2_1_1XmpValue__coll__map" alt="Collaboration graph"></center>
<map name="Exiv2_1_1XmpValue__coll__map">
<area shape="rect" id="node2" href="classExiv2_1_1Value.html" title="Common interface for all types of values used with metadata." alt="" coords="20,5,161,32"></map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div>
<p>
<a href="classExiv2_1_1XmpValue-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">enum </td><td class="memItemRight" valign="bottom"><a class="el" href="classExiv2_1_1XmpValue.html#dcef489707e5b72735cccb7bee57cf5c">XmpArrayType</a> { <b>xaNone</b>,
<b>xaAlt</b>,
<b>xaBag</b>,
<b>xaSeq</b>
}</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">XMP array types. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">enum </td><td class="memItemRight" valign="bottom"><a class="el" href="classExiv2_1_1XmpValue.html#417c4392d9251b143df126fa9e9d1025">XmpStruct</a> { <b>xsNone</b>,
<b>xsStruct</b>
}</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">XMP structure indicator. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="0559bb270b4d2ebc0d784b807c3af44a"></a><!-- doxytag: member="Exiv2::XmpValue::AutoPtr" ref="0559bb270b4d2ebc0d784b807c3af44a" args="" -->
typedef std::auto_ptr< <a class="el" href="classExiv2_1_1XmpValue.html">XmpValue</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classExiv2_1_1XmpValue.html#0559bb270b4d2ebc0d784b807c3af44a">AutoPtr</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Shortcut for a XmpValue auto pointer. <br></td></tr>
<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
<tr><td colspan="2"><div class="groupHeader">Creators</div></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="04fe5c2370ba38a8068040f92a865fec"></a><!-- doxytag: member="Exiv2::XmpValue::XmpValue" ref="04fe5c2370ba38a8068040f92a865fec" args="(TypeId typeId)" -->
</td><td class="memItemRight" valign="bottom"><b>XmpValue</b> (<a class="el" href="namespaceExiv2.html#5153319711f35fe81cbc13f4b852450c">TypeId</a> typeId)</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="5c61a16977660cb58c1b7d66369b9407"></a><!-- doxytag: member="Exiv2::XmpValue::xmpArrayType" ref="5c61a16977660cb58c1b7d66369b9407" args="() const " -->
<a class="el" href="classExiv2_1_1XmpValue.html#dcef489707e5b72735cccb7bee57cf5c">XmpArrayType</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classExiv2_1_1XmpValue.html#5c61a16977660cb58c1b7d66369b9407">xmpArrayType</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return XMP array type, indicates if an XMP value is an array. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ef802ac0e15118aaa78cc445203829e7"></a><!-- doxytag: member="Exiv2::XmpValue::xmpStruct" ref="ef802ac0e15118aaa78cc445203829e7" args="() const " -->
<a class="el" href="classExiv2_1_1XmpValue.html#417c4392d9251b143df126fa9e9d1025">XmpStruct</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classExiv2_1_1XmpValue.html#ef802ac0e15118aaa78cc445203829e7">xmpStruct</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return XMP struct, indicates if an XMP value is a structure. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="65190e7991cdfac16a0de236bd631eab"></a><!-- doxytag: member="Exiv2::XmpValue::size" ref="65190e7991cdfac16a0de236bd631eab" args="() const " -->
virtual long </td><td class="memItemRight" valign="bottom"><a class="el" href="classExiv2_1_1XmpValue.html#65190e7991cdfac16a0de236bd631eab">size</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return the size of the value in bytes. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual long </td><td class="memItemRight" valign="bottom"><a class="el" href="classExiv2_1_1XmpValue.html#9f1d71f7f5c51a8eb2932935980587b8">copy</a> (<a class="el" href="namespaceExiv2.html#16f60a5bd4207fe155f6cf93a15efa72">byte</a> *buf, <a class="el" href="namespaceExiv2.html#94c225faf6d6c611a3828fae1c28efa6">ByteOrder</a> byteOrder=invalidByteOrder) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Write value to a character data buffer. <a href="#9f1d71f7f5c51a8eb2932935980587b8"></a><br></td></tr>
<tr><td colspan="2"><div class="groupHeader">Manipulators</div></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="f9ca857d5c130ac36996d6a0519369df"></a><!-- doxytag: member="Exiv2::XmpValue::setXmpArrayType" ref="f9ca857d5c130ac36996d6a0519369df" args="(XmpArrayType xmpArrayType)" -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classExiv2_1_1XmpValue.html#f9ca857d5c130ac36996d6a0519369df">setXmpArrayType</a> (<a class="el" href="classExiv2_1_1XmpValue.html#dcef489707e5b72735cccb7bee57cf5c">XmpArrayType</a> xmpArrayType)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the XMP array type to indicate that an XMP value is an array. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="c3b98fc15a65051d546ff5d1f73487ed"></a><!-- doxytag: member="Exiv2::XmpValue::setXmpStruct" ref="c3b98fc15a65051d546ff5d1f73487ed" args="(XmpStruct xmpStruct=xsStruct)" -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classExiv2_1_1XmpValue.html#c3b98fc15a65051d546ff5d1f73487ed">setXmpStruct</a> (<a class="el" href="classExiv2_1_1XmpValue.html#417c4392d9251b143df126fa9e9d1025">XmpStruct</a> xmpStruct=xsStruct)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the XMP struct type to indicate that an XMP value is a structure. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual int </td><td class="memItemRight" valign="bottom"><a class="el" href="classExiv2_1_1XmpValue.html#adaa78392376573ef52effdbd5a8ffe6">read</a> (const <a class="el" href="namespaceExiv2.html#16f60a5bd4207fe155f6cf93a15efa72">byte</a> *buf, long len, <a class="el" href="namespaceExiv2.html#94c225faf6d6c611a3828fae1c28efa6">ByteOrder</a> byteOrder=invalidByteOrder)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Read the value from a character buffer. <a href="#adaa78392376573ef52effdbd5a8ffe6"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual int </td><td class="memItemRight" valign="bottom"><a class="el" href="classExiv2_1_1XmpValue.html#7c357e0bee86bd3c6eee197711472821">read</a> (const std::string &buf)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the value from a string buffer. The format of the string corresponds to that of the <a class="el" href="classExiv2_1_1Value.html#2518f5ba09fc8c00785c57a119892c4c" title="Write the value to an output stream. You do not usually have to use this function;...">write()</a> method, i.e., a string obtained through the <a class="el" href="classExiv2_1_1Value.html#2518f5ba09fc8c00785c57a119892c4c" title="Write the value to an output stream. You do not usually have to use this function;...">write()</a> method can be read by this function. <a href="#7c357e0bee86bd3c6eee197711472821"></a><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"><a class="anchor" name="1d47827b7a215239c530833aa006697b"></a><!-- doxytag: member="Exiv2::XmpValue::xmpArrayType" ref="1d47827b7a215239c530833aa006697b" args="(TypeId typeId)" -->
static <a class="el" href="classExiv2_1_1XmpValue.html#dcef489707e5b72735cccb7bee57cf5c">XmpArrayType</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classExiv2_1_1XmpValue.html#1d47827b7a215239c530833aa006697b">xmpArrayType</a> (<a class="el" href="namespaceExiv2.html#5153319711f35fe81cbc13f4b852450c">TypeId</a> typeId)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return XMP array type for an array <a class="el" href="classExiv2_1_1Value.html" title="Common interface for all types of values used with metadata.">Value</a> TypeId, xaNone if <em>typeId</em> is not an XMP array value type. <br></td></tr>
<tr><td colspan="2"><br><h2>Protected Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="18f2c4ef7ded7d42c26792ebec68c91b"></a><!-- doxytag: member="Exiv2::XmpValue::operator=" ref="18f2c4ef7ded7d42c26792ebec68c91b" args="(const XmpValue &rhs)" -->
<a class="el" href="classExiv2_1_1XmpValue.html">XmpValue</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classExiv2_1_1XmpValue.html#18f2c4ef7ded7d42c26792ebec68c91b">operator=</a> (const <a class="el" href="classExiv2_1_1XmpValue.html">XmpValue</a> &rhs)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Assignment operator. Protected so that it can only be used by subclasses but not directly. <br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
Base class for all <a class="el" href="namespaceExiv2.html" title="Provides classes and functions to encode and decode Exif and Iptc data. The libexiv2...">Exiv2</a> values used to store XMP property values. <hr><h2>Member Function Documentation</h2>
<a class="anchor" name="9f1d71f7f5c51a8eb2932935980587b8"></a><!-- doxytag: member="Exiv2::XmpValue::copy" ref="9f1d71f7f5c51a8eb2932935980587b8" args="(byte *buf, ByteOrder byteOrder=invalidByteOrder) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual long Exiv2::XmpValue::copy </td>
<td>(</td>
<td class="paramtype"><a class="el" href="namespaceExiv2.html#16f60a5bd4207fe155f6cf93a15efa72">byte</a> * </td>
<td class="paramname"> <em>buf</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="namespaceExiv2.html#94c225faf6d6c611a3828fae1c28efa6">ByteOrder</a> </td>
<td class="paramname"> <em>byteOrder</em> = <code>invalidByteOrder</code></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td> const<code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Write value to a character data buffer.
<p>
The user must ensure that the buffer has enough memory. Otherwise the call results in undefined behaviour.<p>
<dl class="note" compact><dt><b>Note:</b></dt><dd>The byte order is required by the interface but not used by this method, so just use the default.</dd></dl>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>buf</em> </td><td>Data buffer to write to. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>byteOrder</em> </td><td>Byte order. Not used. </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>Number of characters written. </dd></dl>
<p>Implements <a class="el" href="classExiv2_1_1Value.html#3bf4f9c2eda4f7850a390de98668ce15">Exiv2::Value</a>.</p>
</div>
</div><p>
<a class="anchor" name="7c357e0bee86bd3c6eee197711472821"></a><!-- doxytag: member="Exiv2::XmpValue::read" ref="7c357e0bee86bd3c6eee197711472821" args="(const std::string &buf)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual int Exiv2::XmpValue::read </td>
<td>(</td>
<td class="paramtype">const std::string & </td>
<td class="paramname"> <em>buf</em> </td>
<td> ) </td>
<td><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Set the value from a string buffer. The format of the string corresponds to that of the <a class="el" href="classExiv2_1_1Value.html#2518f5ba09fc8c00785c57a119892c4c" title="Write the value to an output stream. You do not usually have to use this function;...">write()</a> method, i.e., a string obtained through the <a class="el" href="classExiv2_1_1Value.html#2518f5ba09fc8c00785c57a119892c4c" title="Write the value to an output stream. You do not usually have to use this function;...">write()</a> method can be read by this function.
<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>buf</em> </td><td>The string to read from.</td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>0 if successful. </dd></dl>
<p>Implements <a class="el" href="classExiv2_1_1Value.html#2864378d7572310aa5f4cf4127365862">Exiv2::Value</a>.</p>
<p>Implemented in <a class="el" href="classExiv2_1_1XmpTextValue.html#03ba8322cd618df04eda0e2c6f7b6246">Exiv2::XmpTextValue</a>, <a class="el" href="classExiv2_1_1XmpArrayValue.html#a49ab2fa5159f9369501ab3fa8c6b63e">Exiv2::XmpArrayValue</a>, and <a class="el" href="classExiv2_1_1LangAltValue.html#aab6ae9d75120ba24a4ddec341e77c1e">Exiv2::LangAltValue</a>.</p>
</div>
</div><p>
<a class="anchor" name="adaa78392376573ef52effdbd5a8ffe6"></a><!-- doxytag: member="Exiv2::XmpValue::read" ref="adaa78392376573ef52effdbd5a8ffe6" args="(const byte *buf, long len, ByteOrder byteOrder=invalidByteOrder)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual int Exiv2::XmpValue::read </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="namespaceExiv2.html#16f60a5bd4207fe155f6cf93a15efa72">byte</a> * </td>
<td class="paramname"> <em>buf</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">long </td>
<td class="paramname"> <em>len</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="namespaceExiv2.html#94c225faf6d6c611a3828fae1c28efa6">ByteOrder</a> </td>
<td class="paramname"> <em>byteOrder</em> = <code>invalidByteOrder</code></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Read the value from a character buffer.
<p>
Uses <a class="el" href="classExiv2_1_1XmpValue.html#7c357e0bee86bd3c6eee197711472821" title="Set the value from a string buffer. The format of the string corresponds to that...">read(const std::string& buf)</a><p>
<dl class="note" compact><dt><b>Note:</b></dt><dd>The byte order is required by the interface but not used by this method, so just use the default.</dd></dl>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>buf</em> </td><td>Pointer to the data buffer to read from </td></tr>
<tr><td valign="top"></td><td valign="top"><em>len</em> </td><td>Number of bytes in the data buffer </td></tr>
<tr><td valign="top"></td><td valign="top"><em>byteOrder</em> </td><td>Byte order. Not needed.</td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>0 if successful. </dd></dl>
<p>Implements <a class="el" href="classExiv2_1_1Value.html#cc8870f802ebcdf9d4e081816ad8956e">Exiv2::Value</a>.</p>
</div>
</div><p>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="value_8hpp.html">value.hpp</a></ul>
</div>
<hr size="1"><address style="text-align: right;"><small>Generated on Thu Jun 25 15:18:09 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>
