<!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::Iptcdatum 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_1Iptcdatum.html">Iptcdatum</a>
</div>
</div>
<div class="contents">
<h1>Exiv2::Iptcdatum Class Reference</h1><!-- doxytag: class="Exiv2::Iptcdatum" --><!-- doxytag: inherits="Exiv2::Metadatum" -->An IPTC metadatum ("dataset"), consisting of an <a class="el" href="classExiv2_1_1IptcKey.html" title="Concrete keys for IPTC metadata.">IptcKey</a> and a <a class="el" href="classExiv2_1_1Value.html" title="Common interface for all types of values used with metadata.">Value</a> and methods to manipulate these.
<a href="#_details">More...</a>
<p>
<code>#include <iptc.hpp></code>
<p>
<div class="dynheader">
Inheritance diagram for Exiv2::Iptcdatum:</div>
<div class="dynsection">
<p><center><img src="classExiv2_1_1Iptcdatum__inherit__graph.png" border="0" usemap="#Exiv2_1_1Iptcdatum__inherit__map" alt="Inheritance graph"></center>
<map name="Exiv2_1_1Iptcdatum__inherit__map">
<area shape="rect" id="node2" href="classExiv2_1_1Metadatum.html" title="Abstract base class defining the interface to access information related to one metadata..." alt="" coords="5,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::Iptcdatum:</div>
<div class="dynsection">
<p><center><img src="classExiv2_1_1Iptcdatum__coll__graph.png" border="0" usemap="#Exiv2_1_1Iptcdatum__coll__map" alt="Collaboration graph"></center>
<map name="Exiv2_1_1Iptcdatum__coll__map">
<area shape="rect" id="node2" href="classExiv2_1_1Metadatum.html" title="Abstract base class defining the interface to access information related to one metadata..." alt="" coords="5,264,187,291"><area shape="rect" id="node6" href="classExiv2_1_1IptcKey.html" title="Concrete keys for IPTC metadata." alt="" coords="199,173,359,200"><area shape="rect" id="node8" href="classExiv2_1_1Key.html" title="Abstract base class defining the Key of a metadatum. Keys are used to identify and..." alt="" coords="269,83,389,109"><area shape="rect" id="node10" title="STL class." alt="" coords="115,83,245,109"><area shape="rect" id="node12" title="STL class." alt="" coords="55,5,305,32"><area shape="rect" id="node14" title="STL class." alt="" coords="383,173,583,200"><area shape="rect" id="node20" href="classExiv2_1_1Value.html" title="Common interface for all types of values used with metadata." alt="" coords="607,173,748,200"></map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div>
<p>
<a href="classExiv2_1_1Iptcdatum-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 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"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classExiv2_1_1Iptcdatum.html#e6f0b4aaeffdb3f4666f23fdbb4b4f8d">Iptcdatum</a> (const <a class="el" href="classExiv2_1_1IptcKey.html">IptcKey</a> &key, const <a class="el" href="classExiv2_1_1Value.html">Value</a> *pValue=0)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Constructor for new tags created by an application. The Iptcdatum is created from a key / value pair. Iptcdatum copies (clones) the value if one is provided. Alternatively, a program can create an 'empty' Iptcdatum with only a key and set the value using <a class="el" href="classExiv2_1_1Iptcdatum.html#d8f2accfb610841d6cbea0ab7c27ef7c" title="Set the value. This method copies (clones) the value pointed to by pValue.">setValue()</a>. <a href="#e6f0b4aaeffdb3f4666f23fdbb4b4f8d"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="9b4348e0e20b4c32e6eac8462596c2f7"></a><!-- doxytag: member="Exiv2::Iptcdatum::Iptcdatum" ref="9b4348e0e20b4c32e6eac8462596c2f7" args="(const Iptcdatum &rhs)" -->
</td><td class="memItemRight" valign="bottom"><a class="el" href="classExiv2_1_1Iptcdatum.html#9b4348e0e20b4c32e6eac8462596c2f7">Iptcdatum</a> (const <a class="el" href="classExiv2_1_1Iptcdatum.html">Iptcdatum</a> &rhs)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Copy constructor. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="37b56fdf8d3b27d9d6e3462c299a34f8"></a><!-- doxytag: member="Exiv2::Iptcdatum::~Iptcdatum" ref="37b56fdf8d3b27d9d6e3462c299a34f8" args="()" -->
virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classExiv2_1_1Iptcdatum.html#37b56fdf8d3b27d9d6e3462c299a34f8">~Iptcdatum</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Destructor. <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="884f0bbe277f0211ef2acd06bd397466"></a><!-- doxytag: member="Exiv2::Iptcdatum::operator=" ref="884f0bbe277f0211ef2acd06bd397466" args="(const Iptcdatum &rhs)" -->
<a class="el" href="classExiv2_1_1Iptcdatum.html">Iptcdatum</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classExiv2_1_1Iptcdatum.html#884f0bbe277f0211ef2acd06bd397466">operator=</a> (const <a class="el" href="classExiv2_1_1Iptcdatum.html">Iptcdatum</a> &rhs)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Assignment operator. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="548fd455cc034cc0a65c0a9eaa41011e"></a><!-- doxytag: member="Exiv2::Iptcdatum::operator=" ref="548fd455cc034cc0a65c0a9eaa41011e" args="(const uint16_t &value)" -->
<a class="el" href="classExiv2_1_1Iptcdatum.html">Iptcdatum</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classExiv2_1_1Iptcdatum.html#548fd455cc034cc0a65c0a9eaa41011e">operator=</a> (const uint16_t &value)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Assign <em>value</em> to the Iptcdatum. The type of the new <a class="el" href="classExiv2_1_1Value.html" title="Common interface for all types of values used with metadata.">Value</a> is set to UShortValue. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ab56a297ea27b7dd31be8cc282e4772f"></a><!-- doxytag: member="Exiv2::Iptcdatum::operator=" ref="ab56a297ea27b7dd31be8cc282e4772f" args="(const std::string &value)" -->
<a class="el" href="classExiv2_1_1Iptcdatum.html">Iptcdatum</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classExiv2_1_1Iptcdatum.html#ab56a297ea27b7dd31be8cc282e4772f">operator=</a> (const std::string &value)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Assign <em>value</em> to the Iptcdatum. Calls <a class="el" href="classExiv2_1_1Iptcdatum.html#e588d1dbbd038445e69015f66e277a66" title="Set the value to the string value, using Value::read(const std::string&). If...">setValue(const std::string&)</a>. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="2d5cd4a80e6379d78010f8b18e6811c8"></a><!-- doxytag: member="Exiv2::Iptcdatum::operator=" ref="2d5cd4a80e6379d78010f8b18e6811c8" args="(const Value &value)" -->
<a class="el" href="classExiv2_1_1Iptcdatum.html">Iptcdatum</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classExiv2_1_1Iptcdatum.html#2d5cd4a80e6379d78010f8b18e6811c8">operator=</a> (const <a class="el" href="classExiv2_1_1Value.html">Value</a> &value)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Assign <em>value</em> to the Iptcdatum. Calls <a class="el" href="classExiv2_1_1Iptcdatum.html#d8f2accfb610841d6cbea0ab7c27ef7c" title="Set the value. This method copies (clones) the value pointed to by pValue.">setValue(const Value*)</a>. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="d8f2accfb610841d6cbea0ab7c27ef7c"></a><!-- doxytag: member="Exiv2::Iptcdatum::setValue" ref="d8f2accfb610841d6cbea0ab7c27ef7c" args="(const Value *pValue)" -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classExiv2_1_1Iptcdatum.html#d8f2accfb610841d6cbea0ab7c27ef7c">setValue</a> (const <a class="el" href="classExiv2_1_1Value.html">Value</a> *pValue)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the value. This method copies (clones) the value pointed to by pValue. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="e588d1dbbd038445e69015f66e277a66"></a><!-- doxytag: member="Exiv2::Iptcdatum::setValue" ref="e588d1dbbd038445e69015f66e277a66" args="(const std::string &value)" -->
int </td><td class="memItemRight" valign="bottom"><a class="el" href="classExiv2_1_1Iptcdatum.html#e588d1dbbd038445e69015f66e277a66">setValue</a> (const std::string &value)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the value to the string <em>value</em>, using <a class="el" href="classExiv2_1_1Value.html#2864378d7572310aa5f4cf4127365862" title="Set the value from a string buffer. The format of the string corresponds to that...">Value::read(const std::string&)</a>. If the Iptcdatum does not have a <a class="el" href="classExiv2_1_1Value.html" title="Common interface for all types of values used with metadata.">Value</a> yet, then a Value of the correct type for this Iptcdatum is created. If that fails (because of an unknown dataset), a <a class="el" href="classExiv2_1_1StringValue.html" title="Value for string type.">StringValue</a> is created. Return 0 if the value was read successfully. <br></td></tr>
<tr><td colspan="2"><div class="groupHeader">Accessors</div></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">long </td><td class="memItemRight" valign="bottom"><a class="el" href="classExiv2_1_1Iptcdatum.html#fef33191871750f8b1c760d46f553c51">copy</a> (<a class="el" href="namespaceExiv2.html#16f60a5bd4207fe155f6cf93a15efa72">byte</a> *buf, <a class="el" href="namespaceExiv2.html#94c225faf6d6c611a3828fae1c28efa6">ByteOrder</a> byteOrder) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Write value to a data buffer and return the number of bytes written. <a href="#fef33191871750f8b1c760d46f553c51"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">std::ostream & </td><td class="memItemRight" valign="bottom"><a class="el" href="classExiv2_1_1Iptcdatum.html#200b7d5d6f0e49e3c29d631f561c879f">write</a> (std::ostream &os, const <a class="el" href="classExiv2_1_1ExifData.html">ExifData</a> *pMetadata=0) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Write the interpreted value to an output stream, return the stream. <a href="#200b7d5d6f0e49e3c29d631f561c879f"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="db8183876183516239f842d405980b43"></a><!-- doxytag: member="Exiv2::Iptcdatum::key" ref="db8183876183516239f842d405980b43" args="() const " -->
std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classExiv2_1_1Iptcdatum.html#db8183876183516239f842d405980b43">key</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return the key of the <a class="el" href="classExiv2_1_1Iptcdatum.html" title="An IPTC metadatum ("dataset"), consisting of an IptcKey and a Value and...">Iptcdatum</a>. The key is of the form '<b>Iptc</b>.recordName.datasetName'. Note however that the key is not necessarily unique, i.e., an <a class="el" href="classExiv2_1_1IptcData.html" title="A container for IPTC data. This is a top-level class of the Exiv2 library.">IptcData</a> object may contain multiple metadata with the same key. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classExiv2_1_1Iptcdatum.html#596ec3daf2df643d2a625a525ebaedbe">recordName</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return the name of the record (deprecated). <a href="#596ec3daf2df643d2a625a525ebaedbe"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">uint16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classExiv2_1_1Iptcdatum.html#e0c9a888c38f17689e14b38baef0fe9b">record</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return the record id. <a href="#e0c9a888c38f17689e14b38baef0fe9b"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="3438e8f126412fda41f5d413f149a9de"></a><!-- doxytag: member="Exiv2::Iptcdatum::familyName" ref="3438e8f126412fda41f5d413f149a9de" args="() const " -->
const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="classExiv2_1_1Iptcdatum.html#3438e8f126412fda41f5d413f149a9de">familyName</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return the name of the metadata family (which is also the first part of the key). <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="8b19ed1dc21284af2dca91497c515c72"></a><!-- doxytag: member="Exiv2::Iptcdatum::groupName" ref="8b19ed1dc21284af2dca91497c515c72" args="() const " -->
std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classExiv2_1_1Iptcdatum.html#8b19ed1dc21284af2dca91497c515c72">groupName</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return the name of the metadata group (which is also the second part of the key). <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classExiv2_1_1Iptcdatum.html#7e630890c95ee311a0774f5ba77da0cb">tagName</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return the name of the tag (aka dataset). <a href="#7e630890c95ee311a0774f5ba77da0cb"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="66ec20a5834c6d2eb5fade695badd316"></a><!-- doxytag: member="Exiv2::Iptcdatum::tagLabel" ref="66ec20a5834c6d2eb5fade695badd316" args="() const " -->
std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classExiv2_1_1Iptcdatum.html#66ec20a5834c6d2eb5fade695badd316">tagLabel</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return a label for the tag. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="2b3bc419980b4a9375a1c225e3851b89"></a><!-- doxytag: member="Exiv2::Iptcdatum::tag" ref="2b3bc419980b4a9375a1c225e3851b89" args="() const " -->
uint16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classExiv2_1_1Iptcdatum.html#2b3bc419980b4a9375a1c225e3851b89">tag</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return the tag (aka dataset) number. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="72b0cc6aef6cc888f26f503558cd9420"></a><!-- doxytag: member="Exiv2::Iptcdatum::typeId" ref="72b0cc6aef6cc888f26f503558cd9420" args="() const " -->
<a class="el" href="namespaceExiv2.html#5153319711f35fe81cbc13f4b852450c">TypeId</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classExiv2_1_1Iptcdatum.html#72b0cc6aef6cc888f26f503558cd9420">typeId</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return the type id of the value. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="0f51e260344a370e5c045db9341f2223"></a><!-- doxytag: member="Exiv2::Iptcdatum::typeName" ref="0f51e260344a370e5c045db9341f2223" args="() const " -->
const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="classExiv2_1_1Iptcdatum.html#0f51e260344a370e5c045db9341f2223">typeName</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return the name of the type. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="3c6dec212e90dc540bf9de1ae7d7c591"></a><!-- doxytag: member="Exiv2::Iptcdatum::typeSize" ref="3c6dec212e90dc540bf9de1ae7d7c591" args="() const " -->
long </td><td class="memItemRight" valign="bottom"><a class="el" href="classExiv2_1_1Iptcdatum.html#3c6dec212e90dc540bf9de1ae7d7c591">typeSize</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return the size in bytes of one component of this type. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="9cfa3dec36e338ce8e33165549d2fa46"></a><!-- doxytag: member="Exiv2::Iptcdatum::count" ref="9cfa3dec36e338ce8e33165549d2fa46" args="() const " -->
long </td><td class="memItemRight" valign="bottom"><a class="el" href="classExiv2_1_1Iptcdatum.html#9cfa3dec36e338ce8e33165549d2fa46">count</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return the number of components in the value. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="99c790bb20a41c4cac8ac033c4b7914f"></a><!-- doxytag: member="Exiv2::Iptcdatum::size" ref="99c790bb20a41c4cac8ac033c4b7914f" args="() const " -->
long </td><td class="memItemRight" valign="bottom"><a class="el" href="classExiv2_1_1Iptcdatum.html#99c790bb20a41c4cac8ac033c4b7914f">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"><a class="anchor" name="7a5aceca1fe5f2898bdf802ed32e07af"></a><!-- doxytag: member="Exiv2::Iptcdatum::toString" ref="7a5aceca1fe5f2898bdf802ed32e07af" args="() const " -->
std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classExiv2_1_1Iptcdatum.html#7a5aceca1fe5f2898bdf802ed32e07af">toString</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return the value as a string. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="4f8525c6fbd53c2746178970e9806bd0"></a><!-- doxytag: member="Exiv2::Iptcdatum::toString" ref="4f8525c6fbd53c2746178970e9806bd0" args="(long n) const " -->
std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classExiv2_1_1Iptcdatum.html#4f8525c6fbd53c2746178970e9806bd0">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 converted to a string. The behaviour of the method is undefined if there is no <em>n</em>-th component. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="51d4cb0a76fd01df683f3e7131ff8330"></a><!-- doxytag: member="Exiv2::Iptcdatum::toLong" ref="51d4cb0a76fd01df683f3e7131ff8330" args="(long n=0) const " -->
long </td><td class="memItemRight" valign="bottom"><a class="el" href="classExiv2_1_1Iptcdatum.html#51d4cb0a76fd01df683f3e7131ff8330">toLong</a> (long n=0) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return the <em>n</em>-th component of the value converted to long. The return value is -1 if the value is not set and the behaviour of the method is undefined if there is no <em>n</em>-th component. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="94dad5f2dec67835f259c6438620a7dc"></a><!-- doxytag: member="Exiv2::Iptcdatum::toFloat" ref="94dad5f2dec67835f259c6438620a7dc" args="(long n=0) const " -->
float </td><td class="memItemRight" valign="bottom"><a class="el" href="classExiv2_1_1Iptcdatum.html#94dad5f2dec67835f259c6438620a7dc">toFloat</a> (long n=0) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return the <em>n</em>-th component of the value converted to float. The return value is -1 if the value is not set and the behaviour of the method is undefined if there is no <em>n</em>-th component. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="176df79dece844e2d71980693b937af3"></a><!-- doxytag: member="Exiv2::Iptcdatum::toRational" ref="176df79dece844e2d71980693b937af3" args="(long n=0) const " -->
<a class="el" href="namespaceExiv2.html#95756f3f7fa19103f83addf5fa088a30">Rational</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classExiv2_1_1Iptcdatum.html#176df79dece844e2d71980693b937af3">toRational</a> (long n=0) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return the <em>n</em>-th component of the value converted to Rational. The return value is -1/1 if the value is not set and the behaviour of the method is undefined if there is no <em>n</em>-th component. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classExiv2_1_1Value.html#0f62e585b82c97738858b743e60dff21">Value::AutoPtr</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classExiv2_1_1Iptcdatum.html#dde9e41e4fda8d1cd9e5947e44cbf40a">getValue</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return an auto-pointer to a copy (clone) of the value. The caller owns this copy and the auto-poiner ensures that it will be deleted. <a href="#dde9e41e4fda8d1cd9e5947e44cbf40a"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">const <a class="el" href="classExiv2_1_1Value.html">Value</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classExiv2_1_1Iptcdatum.html#799184a3a000bda2432a0b7366c2dfb2">value</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return a constant reference to the value. <a href="#799184a3a000bda2432a0b7366c2dfb2"></a><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
An IPTC metadatum ("dataset"), consisting of an <a class="el" href="classExiv2_1_1IptcKey.html" title="Concrete keys for IPTC metadata.">IptcKey</a> and a <a class="el" href="classExiv2_1_1Value.html" title="Common interface for all types of values used with metadata.">Value</a> and methods to manipulate these. <hr><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" name="e6f0b4aaeffdb3f4666f23fdbb4b4f8d"></a><!-- doxytag: member="Exiv2::Iptcdatum::Iptcdatum" ref="e6f0b4aaeffdb3f4666f23fdbb4b4f8d" args="(const IptcKey &key, const Value *pValue=0)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Exiv2::Iptcdatum::Iptcdatum </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classExiv2_1_1IptcKey.html">IptcKey</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>pValue</em> = <code>0</code></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [explicit]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Constructor for new tags created by an application. The Iptcdatum is created from a key / value pair. Iptcdatum copies (clones) the value if one is provided. Alternatively, a program can create an 'empty' Iptcdatum with only a key and set the value using <a class="el" href="classExiv2_1_1Iptcdatum.html#d8f2accfb610841d6cbea0ab7c27ef7c" title="Set the value. This method copies (clones) the value pointed to by pValue.">setValue()</a>.
<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>key</em> </td><td>The key of the Iptcdatum. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>pValue</em> </td><td>Pointer to a Iptcdatum value. </td></tr>
</table>
</dl>
<dl compact><dt><b>Exceptions:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em><a class="el" href="classExiv2_1_1Error.html" title="Simple error class used for exceptions. An output operator is provided to print errors...">Error</a></em> </td><td>if the key cannot be parsed and converted to a tag number and record id. </td></tr>
</table>
</dl>
<p>References <a class="el" href="value_8hpp_source.html#l00121">Exiv2::Value::clone()</a>.</p>
</div>
</div><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="fef33191871750f8b1c760d46f553c51"></a><!-- doxytag: member="Exiv2::Iptcdatum::copy" ref="fef33191871750f8b1c760d46f553c51" args="(byte *buf, ByteOrder byteOrder) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">long Exiv2::Iptcdatum::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></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td> const<code> [inline, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Write value to a data buffer and return the number of bytes written.
<p>
The user must ensure that the buffer has enough memory. Otherwise the call results in undefined behaviour.<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>Data buffer to write to. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>byteOrder</em> </td><td>Applicable byte order (little or big endian). </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_1Metadatum.html#24bda0168b0655ccbbc8b870b583f1da">Exiv2::Metadatum</a>.</p>
</div>
</div><p>
<a class="anchor" name="dde9e41e4fda8d1cd9e5947e44cbf40a"></a><!-- doxytag: member="Exiv2::Iptcdatum::getValue" ref="dde9e41e4fda8d1cd9e5947e44cbf40a" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classExiv2_1_1Value.html#0f62e585b82c97738858b743e60dff21">Value::AutoPtr</a> Exiv2::Iptcdatum::getValue </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td> const<code> [inline, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Return an auto-pointer to a copy (clone) of the value. The caller owns this copy and the auto-poiner ensures that it will be deleted.
<p>
This method is provided for users who need full control over the value. A caller may, e.g., downcast the pointer to the appropriate subclass of <a class="el" href="classExiv2_1_1Value.html" title="Common interface for all types of values used with metadata.">Value</a> to make use of the interface of the subclass to set or modify its contents.<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>An auto-pointer containing a pointer to a copy (clone) of the value, 0 if the value is not set. </dd></dl>
<p>Implements <a class="el" href="classExiv2_1_1Metadatum.html#1f3f53ab9df8c213ade42012a7e89ab3">Exiv2::Metadatum</a>.</p>
</div>
</div><p>
<a class="anchor" name="e0c9a888c38f17689e14b38baef0fe9b"></a><!-- doxytag: member="Exiv2::Iptcdatum::record" ref="e0c9a888c38f17689e14b38baef0fe9b" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint16_t Exiv2::Iptcdatum::record </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Return the record id.
<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>record id </dd></dl>
<p>Referenced by <a class="el" href="iptc_8cpp_source.html#l00181">Exiv2::IptcData::add()</a>, <a class="el" href="iptc_8hpp_source.html#l00194">Exiv2::FindMetadatumById::operator()()</a>, and <a class="el" href="iptc_8cpp_source.html#l00138">setValue()</a>.</p>
</div>
</div><p>
<a class="anchor" name="596ec3daf2df643d2a625a525ebaedbe"></a><!-- doxytag: member="Exiv2::Iptcdatum::recordName" ref="596ec3daf2df643d2a625a525ebaedbe" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::string Exiv2::Iptcdatum::recordName </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Return the name of the record (deprecated).
<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>record name </dd></dl>
</div>
</div><p>
<a class="anchor" name="7e630890c95ee311a0774f5ba77da0cb"></a><!-- doxytag: member="Exiv2::Iptcdatum::tagName" ref="7e630890c95ee311a0774f5ba77da0cb" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::string Exiv2::Iptcdatum::tagName </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td> const<code> [inline, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Return the name of the tag (aka dataset).
<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>tag name </dd></dl>
<p>Implements <a class="el" href="classExiv2_1_1Metadatum.html#828306096c0575ffc5d02c73c3b6ff53">Exiv2::Metadatum</a>.</p>
</div>
</div><p>
<a class="anchor" name="799184a3a000bda2432a0b7366c2dfb2"></a><!-- doxytag: member="Exiv2::Iptcdatum::value" ref="799184a3a000bda2432a0b7366c2dfb2" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="classExiv2_1_1Value.html">Value</a> & Exiv2::Iptcdatum::value </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td> const<code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Return a constant reference to the value.
<p>
This method is provided mostly for convenient and versatile output of the value which can (to some extent) be formatted through standard stream manipulators. Do not attempt to write to the value through this reference.<p>
<b>Example:</b> <br>
<div class="fragment"><pre class="fragment"> <a class="code" href="classExiv2_1_1ExifData.html#2b8ac7a474d6527c0f3f6a0a9cebef77" title="ExifMetadata const iterator type.">ExifData::const_iterator</a> i = exifData.findKey(<a class="code" href="classExiv2_1_1Iptcdatum.html#db8183876183516239f842d405980b43" title="Return the key of the Iptcdatum. The key is of the form &#39;Iptc.recordName.datasetName&#39;...">key</a>);
<span class="keywordflow">if</span> (i != exifData.end()) {
std::cout << i->key() << <span class="stringliteral">" "</span> << std::hex << i->value() << <span class="stringliteral">"\n"</span>;
}
</pre></div><p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>A constant reference to the value. </dd></dl>
<dl compact><dt><b>Exceptions:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em><a class="el" href="classExiv2_1_1Error.html" title="Simple error class used for exceptions. An output operator is provided to print errors...">Error</a></em> </td><td>if the value is not set. </td></tr>
</table>
</dl>
<p>Implements <a class="el" href="classExiv2_1_1Metadatum.html#67ab8d2752f951b70a8188341df9c7e6">Exiv2::Metadatum</a>.</p>
<p>Referenced by <a class="el" href="iptc_8cpp_source.html#l00087">write()</a>.</p>
</div>
</div><p>
<a class="anchor" name="200b7d5d6f0e49e3c29d631f561c879f"></a><!-- doxytag: member="Exiv2::Iptcdatum::write" ref="200b7d5d6f0e49e3c29d631f561c879f" args="(std::ostream &os, const ExifData *pMetadata=0) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::ostream & Exiv2::Iptcdatum::write </td>
<td>(</td>
<td class="paramtype">std::ostream & </td>
<td class="paramname"> <em>os</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classExiv2_1_1ExifData.html">ExifData</a> * </td>
<td class="paramname"> <em>pMetadata</em> = <code>0</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 the interpreted value to an output stream, return the stream.
<p>
The method takes an optional pointer to a metadata container. Pretty-print functions may use that to refer to other metadata as it is sometimes not sufficient to know only the value of the metadatum that should be interpreted. Thus, it is advisable to always call this method with a pointer to the metadata container if possible.<p>
This functionality is currently only implemented for Exif tags. The pointer is ignored when used to write IPTC datasets or XMP properties.<p>
Without the optional metadata pointer, you do not usually have to use this function; it is used for the implementation of the output operator for Metadatum, <a class="el" href="namespaceExiv2.html#8525be11fc92fcb2bd88e886daa1959a" title="Output operator for Metadatum types, writing the interpreted tag value.">operator<<(std::ostream &os, const Metadatum &md)</a>.<p>
See also <a class="el" href="classExiv2_1_1Metadatum.html#554fbe4c9641f72939fdfc3802220090" title="Write the interpreted value to a string.">print()</a>, which prints the interpreted value to a string.
<p>Implements <a class="el" href="classExiv2_1_1Metadatum.html#63c2b87249ba96679c29e01218169124">Exiv2::Metadatum</a>.</p>
<p>References <a class="el" href="iptc_8cpp_source.html#l00092">value()</a>.</p>
</div>
</div><p>
<hr>The documentation for this class was generated from the following files:<ul>
<li><a class="el" href="iptc_8hpp.html">iptc.hpp</a><li>iptc.cpp</ul>
</div>
<hr size="1"><address style="text-align: right;"><small>Generated on Thu Jun 25 15:17:58 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>
