<!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::XmpArrayValue 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_1XmpArrayValue.html">XmpArrayValue</a> </div> </div> <div class="contents"> <h1>Exiv2::XmpArrayValue Class Reference</h1><!-- doxytag: class="Exiv2::XmpArrayValue" --><!-- doxytag: inherits="Exiv2::XmpValue" -->Value type for simple arrays. Each item in the array is a simple value, without qualifiers. The array may be an ordered (<em>seq</em>), unordered (<em>bag</em>) or alternative array (<em>alt</em>). The array items must not contain qualifiers. For language alternatives use <a class="el" href="classExiv2_1_1LangAltValue.html" title="Value type for XMP language alternative properties.">LangAltValue</a>. <a href="#_details">More...</a> <p> <code>#include <value.hpp></code> <p> <div class="dynheader"> Inheritance diagram for Exiv2::XmpArrayValue:</div> <div class="dynsection"> <p><center><img src="classExiv2_1_1XmpArrayValue__inherit__graph.png" border="0" usemap="#Exiv2_1_1XmpArrayValue__inherit__map" alt="Inheritance graph"></center> <map name="Exiv2_1_1XmpArrayValue__inherit__map"> <area shape="rect" id="node2" href="classExiv2_1_1XmpValue.html" title="Base class for all Exiv2 values used to store XMP property values." alt="" coords="31,80,201,107"><area shape="rect" id="node4" href="classExiv2_1_1Value.html" title="Common interface for all types of values used with metadata." alt="" coords="45,5,187,32"></map> <center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div> <div class="dynheader"> Collaboration diagram for Exiv2::XmpArrayValue:</div> <div class="dynsection"> <p><center><img src="classExiv2_1_1XmpArrayValue__coll__graph.png" border="0" usemap="#Exiv2_1_1XmpArrayValue__coll__map" alt="Collaboration graph"></center> <map name="Exiv2_1_1XmpArrayValue__coll__map"> <area shape="rect" id="node2" href="classExiv2_1_1XmpValue.html" title="Base class for all Exiv2 values used to store XMP property values." alt="" coords="5,187,176,213"><area shape="rect" id="node4" href="classExiv2_1_1Value.html" title="Common interface for all types of values used with metadata." alt="" coords="20,96,161,123"><area shape="rect" id="node8" title="STL class." alt="" coords="229,96,360,123"><area shape="rect" id="node10" title="STL class." alt="" coords="169,5,420,32"><area shape="rect" id="node12" title="STL class." alt="" coords="384,96,565,123"></map> <center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div> <p> <a href="classExiv2_1_1XmpArrayValue-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="0780ad0c5878c196bc0a626f8c82b60f"></a><!-- doxytag: member="Exiv2::XmpArrayValue::AutoPtr" ref="0780ad0c5878c196bc0a626f8c82b60f" args="" --> typedef std::auto_ptr<br class="typebreak"> < <a class="el" href="classExiv2_1_1XmpArrayValue.html">XmpArrayValue</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classExiv2_1_1XmpArrayValue.html#0780ad0c5878c196bc0a626f8c82b60f">AutoPtr</a></td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Shortcut for a XmpArrayValue auto pointer. <br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="041168d33176d58939620810a6c0334c"></a><!-- doxytag: member="Exiv2::XmpArrayValue::ValueType" ref="041168d33176d58939620810a6c0334c" args="" --> typedef std::vector< std::string > </td><td class="memItemRight" valign="bottom"><a class="el" href="classExiv2_1_1XmpArrayValue.html#041168d33176d58939620810a6c0334c">ValueType</a></td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Type used to store XMP array elements. <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="0cf60defd39cf0801569c8351e02f4a7"></a><!-- doxytag: member="Exiv2::XmpArrayValue::XmpArrayValue" ref="0cf60defd39cf0801569c8351e02f4a7" args="(TypeId typeId=xmpBag)" --> </td><td class="memItemRight" valign="bottom"><a class="el" href="classExiv2_1_1XmpArrayValue.html#0cf60defd39cf0801569c8351e02f4a7">XmpArrayValue</a> (<a class="el" href="namespaceExiv2.html#5153319711f35fe81cbc13f4b852450c">TypeId</a> typeId=xmpBag)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Constructor. <em>typeId</em> can be one of xmpBag, xmpSeq or xmpAlt. <br></td></tr> <tr><td colspan="2"><div class="groupHeader">Manipulators</div></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_1XmpArrayValue.html#a49ab2fa5159f9369501ab3fa8c6b63e">read</a> (const std::string &buf)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Read a simple property value from <em>buf</em> and append it to the value. <a href="#a49ab2fa5159f9369501ab3fa8c6b63e"></a><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="f1236558979d1c2402552d66998d16de"></a><!-- doxytag: member="Exiv2::XmpArrayValue::clone" ref="f1236558979d1c2402552d66998d16de" args="() const " --> <a class="el" href="classExiv2_1_1Value.html#0f62e585b82c97738858b743e60dff21">AutoPtr</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classExiv2_1_1XmpArrayValue.html#f1236558979d1c2402552d66998d16de">clone</a> () const </td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Return an auto-pointer to a copy of itself (deep copy). The caller owns this copy and the auto-pointer ensures that it will be deleted. <br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="08df99ba3de2566240aa3b4b89024e1b"></a><!-- doxytag: member="Exiv2::XmpArrayValue::count" ref="08df99ba3de2566240aa3b4b89024e1b" args="() const " --> virtual long </td><td class="memItemRight" valign="bottom"><a class="el" href="classExiv2_1_1XmpArrayValue.html#08df99ba3de2566240aa3b4b89024e1b">count</a> () const </td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Return the number of components of the value. <br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a6e19d2b09e164a33df8b9ef3c29c979"></a><!-- doxytag: member="Exiv2::XmpArrayValue::toString" ref="a6e19d2b09e164a33df8b9ef3c29c979" args="(long n) const " --> virtual std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classExiv2_1_1XmpArrayValue.html#a6e19d2b09e164a33df8b9ef3c29c979">toString</a> (long n) const </td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Return the <em>n</em>-th component of the value as a string. The behaviour of this method may be undefined if there is no <em>n</em>-th component. <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_1XmpArrayValue.html#8a6c728f1c386038216e5da6178d08fe">toLong</a> (long n=0) const </td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Convert the <em>n</em>-th component of the value to a long. The behaviour of this method may be undefined if there is no <em>n</em>-th component. <a href="#8a6c728f1c386038216e5da6178d08fe"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual float </td><td class="memItemRight" valign="bottom"><a class="el" href="classExiv2_1_1XmpArrayValue.html#302e89278438c3d7def6e853daeb358a">toFloat</a> (long n=0) const </td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Convert the <em>n</em>-th component of the value to a float. The behaviour of this method may be undefined if there is no <em>n</em>-th component. <a href="#302e89278438c3d7def6e853daeb358a"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="namespaceExiv2.html#95756f3f7fa19103f83addf5fa088a30">Rational</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classExiv2_1_1XmpArrayValue.html#f85e11d17f007496adc062bb47382fae">toRational</a> (long n=0) const </td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Convert the <em>n</em>-th component of the value to a Rational. The behaviour of this method may be undefined if there is no <em>n</em>-th component. <a href="#f85e11d17f007496adc062bb47382fae"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual std::ostream & </td><td class="memItemRight" valign="bottom"><a class="el" href="classExiv2_1_1XmpArrayValue.html#c597ac51130329c848510004d53ba7b9">write</a> (std::ostream &os) const </td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Write all elements of the value to <em>os</em>, separated by commas. <a href="#c597ac51130329c848510004d53ba7b9"></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="620cf5acd40bea72c7b3cdb3894fea6a"></a><!-- doxytag: member="Exiv2::XmpArrayValue::value_" ref="620cf5acd40bea72c7b3cdb3894fea6a" args="" --> std::vector< std::string > </td><td class="memItemRight" valign="bottom"><a class="el" href="classExiv2_1_1XmpArrayValue.html#620cf5acd40bea72c7b3cdb3894fea6a">value_</a></td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Stores the string values. <br></td></tr> </table> <hr><a name="_details"></a><h2>Detailed Description</h2> Value type for simple arrays. Each item in the array is a simple value, without qualifiers. The array may be an ordered (<em>seq</em>), unordered (<em>bag</em>) or alternative array (<em>alt</em>). The array items must not contain qualifiers. For language alternatives use <a class="el" href="classExiv2_1_1LangAltValue.html" title="Value type for XMP language alternative properties.">LangAltValue</a>. <p> Uses a vector of std::string to store the value(s). <hr><h2>Member Function Documentation</h2> <a class="anchor" name="a49ab2fa5159f9369501ab3fa8c6b63e"></a><!-- doxytag: member="Exiv2::XmpArrayValue::read" ref="a49ab2fa5159f9369501ab3fa8c6b63e" args="(const std::string &buf)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">virtual int Exiv2::XmpArrayValue::read </td> <td>(</td> <td class="paramtype">const std::string & </td> <td class="paramname"> <em>buf</em> </td> <td> ) </td> <td><code> [virtual]</code></td> </tr> </table> </div> <div class="memdoc"> <p> Read a simple property value from <em>buf</em> and append it to the value. <p> Appends <em>buf</em> to the value after the last existing array element. Subsequent calls will therefore populate multiple array elements in the order they are read.<p> <dl class="return" compact><dt><b>Returns:</b></dt><dd>0 if successful. </dd></dl> <p>Implements <a class="el" href="classExiv2_1_1XmpValue.html#7c357e0bee86bd3c6eee197711472821">Exiv2::XmpValue</a>.</p> </div> </div><p> <a class="anchor" name="302e89278438c3d7def6e853daeb358a"></a><!-- doxytag: member="Exiv2::XmpArrayValue::toFloat" ref="302e89278438c3d7def6e853daeb358a" args="(long n=0) const " --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">virtual float Exiv2::XmpArrayValue::toFloat </td> <td>(</td> <td class="paramtype">long </td> <td class="paramname"> <em>n</em> = <code>0</code> </td> <td> ) </td> <td> const<code> [virtual]</code></td> </tr> </table> </div> <div class="memdoc"> <p> Convert the <em>n</em>-th component of the value to a float. The behaviour of this method may be undefined if there is no <em>n</em>-th component. <p> <dl class="return" compact><dt><b>Returns:</b></dt><dd>The converted value. </dd></dl> <p>Implements <a class="el" href="classExiv2_1_1Value.html#22d257caa6c1ffe6416ce02de7bd8c1c">Exiv2::Value</a>.</p> </div> </div><p> <a class="anchor" name="8a6c728f1c386038216e5da6178d08fe"></a><!-- doxytag: member="Exiv2::XmpArrayValue::toLong" ref="8a6c728f1c386038216e5da6178d08fe" args="(long n=0) const " --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">virtual long Exiv2::XmpArrayValue::toLong </td> <td>(</td> <td class="paramtype">long </td> <td class="paramname"> <em>n</em> = <code>0</code> </td> <td> ) </td> <td> const<code> [virtual]</code></td> </tr> </table> </div> <div class="memdoc"> <p> Convert the <em>n</em>-th component of the value to a long. The behaviour of this method may be undefined if there is no <em>n</em>-th component. <p> <dl class="return" compact><dt><b>Returns:</b></dt><dd>The converted value. </dd></dl> <p>Implements <a class="el" href="classExiv2_1_1Value.html#4530a3fc3e2305cf994de5476f46f953">Exiv2::Value</a>.</p> </div> </div><p> <a class="anchor" name="f85e11d17f007496adc062bb47382fae"></a><!-- doxytag: member="Exiv2::XmpArrayValue::toRational" ref="f85e11d17f007496adc062bb47382fae" args="(long n=0) const " --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">virtual <a class="el" href="namespaceExiv2.html#95756f3f7fa19103f83addf5fa088a30">Rational</a> Exiv2::XmpArrayValue::toRational </td> <td>(</td> <td class="paramtype">long </td> <td class="paramname"> <em>n</em> = <code>0</code> </td> <td> ) </td> <td> const<code> [virtual]</code></td> </tr> </table> </div> <div class="memdoc"> <p> Convert the <em>n</em>-th component of the value to a Rational. The behaviour of this method may be undefined if there is no <em>n</em>-th component. <p> <dl class="return" compact><dt><b>Returns:</b></dt><dd>The converted value. </dd></dl> <p>Implements <a class="el" href="classExiv2_1_1Value.html#595a4cb549bec8c19d290ca3e95a2678">Exiv2::Value</a>.</p> </div> </div><p> <a class="anchor" name="c597ac51130329c848510004d53ba7b9"></a><!-- doxytag: member="Exiv2::XmpArrayValue::write" ref="c597ac51130329c848510004d53ba7b9" args="(std::ostream &os) const " --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">virtual std::ostream& Exiv2::XmpArrayValue::write </td> <td>(</td> <td class="paramtype">std::ostream & </td> <td class="paramname"> <em>os</em> </td> <td> ) </td> <td> const<code> [virtual]</code></td> </tr> </table> </div> <div class="memdoc"> <p> Write all elements of the value to <em>os</em>, separated by commas. <p> <dl class="note" compact><dt><b>Note:</b></dt><dd>The output of this method cannot directly be used as the parameter for <a class="el" href="classExiv2_1_1XmpArrayValue.html#a49ab2fa5159f9369501ab3fa8c6b63e" title="Read a simple property value from buf and append it to the value.">read()</a>. </dd></dl> <p>Implements <a class="el" href="classExiv2_1_1Value.html#2518f5ba09fc8c00785c57a119892c4c">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>