1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>Exiv2: Exiv2::Iptcdatum Class Reference</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
<link href="tabs.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.4.6 -->
<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 id="current"><a href="classes.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>
</ul></div>
<div class="tabs">
<ul>
<li><a href="classes.html"><span>Alphabetical List</span></a></li>
<li><a href="annotated.html"><span>Class List</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="nav">
<a class="el" href="namespaceExiv2.html">Exiv2</a>::<a class="el" href="classExiv2_1_1Iptcdatum.html">Iptcdatum</a></div>
<h1>Exiv2::Iptcdatum Class Reference</h1><!-- doxytag: class="Exiv2::Iptcdatum" --><!-- doxytag: inherits="Exiv2::Metadatum" -->Information related to one Iptc dataset. An Iptc metadatum consists of an <a class="el" href="classExiv2_1_1IptcKey.html">IptcKey</a> and a <a class="el" href="classExiv2_1_1Value.html">Value</a> and provides methods to manipulate these.
<a href="#_details">More...</a>
<p>
<code>#include <iptc.hpp></code>
<p>
Inheritance diagram for Exiv2::Iptcdatum:<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 href="classExiv2_1_1Metadatum.html" shape="rect" coords="6,7,134,31" alt="">
</map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center>Collaboration diagram for Exiv2::Iptcdatum:<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 href="classExiv2_1_1Metadatum.html" shape="rect" coords="6,97,134,121" alt="">
</map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center><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">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">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#939880e6f136c770e7d9fc68743875f0">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">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 <a class="el" href="classExiv2_1_1Value.html">Value</a>. This method copies (clones) the Value pointed to by <em>pValue</em>. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="939880e6f136c770e7d9fc68743875f0"></a><!-- doxytag: member="Exiv2::Iptcdatum::setValue" ref="939880e6f136c770e7d9fc68743875f0" args="(const std::string &value)" -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classExiv2_1_1Iptcdatum.html#939880e6f136c770e7d9fc68743875f0">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">Value::read(const std::string&)</a>. If the Iptcdatum does not have a <a class="el" href="classExiv2_1_1Value.html">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">StringValue</a> is created. <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"><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">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">IptcData</a> 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. <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">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="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 n-th component of the value converted to long. The return value is -1 if the value of the <a class="el" href="classExiv2_1_1Iptcdatum.html">Iptcdatum</a> is not set and the behaviour of the method is undefined if there is no n-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 n-th component of the value converted to float. The return value is -1 if the value of the <a class="el" href="classExiv2_1_1Iptcdatum.html">Iptcdatum</a> is not set and the behaviour of the method is undefined if there is no n-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 n-th component of the value converted to Rational. The return value is -1/1 if the value of the <a class="el" href="classExiv2_1_1Iptcdatum.html">Iptcdatum</a> is not set and the behaviour of the method is undefined if there is no n-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-pointer 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>
Information related to one Iptc dataset. An Iptc metadatum consists of an <a class="el" href="classExiv2_1_1IptcKey.html">IptcKey</a> and a <a class="el" href="classExiv2_1_1Value.html">Value</a> and provides methods to manipulate these.
<p>
<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)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">Exiv2::Iptcdatum::Iptcdatum </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">const <a class="el" href="classExiv2_1_1IptcKey.html">IptcKey</a> & </td>
<td class="mdname" nowrap> <em>key</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap>const <a class="el" href="classExiv2_1_1Value.html">Value</a> * </td>
<td class="mdname" nowrap> <em>pValue</em> = <code>0</code></td>
</tr>
<tr>
<td class="md"></td>
<td class="md">) </td>
<td class="md" colspan="2"><code> [explicit]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<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">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">Error</a></em> </td><td>if the key cannot be parsed and converted to a tag number and record id. </td></tr>
</table>
</dl>
</td>
</tr>
</table>
<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 " --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">long Exiv2::Iptcdatum::copy </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="namespaceExiv2.html#16f60a5bd4207fe155f6cf93a15efa72">byte</a> * </td>
<td class="mdname" nowrap> <em>buf</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap><a class="el" href="namespaceExiv2.html#94c225faf6d6c611a3828fae1c28efa6">ByteOrder</a> </td>
<td class="mdname" nowrap> <em>byteOrder</em></td>
</tr>
<tr>
<td class="md"></td>
<td class="md">) </td>
<td class="md" colspan="2"> const<code> [inline, virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<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 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>. </td>
</tr>
</table>
<a class="anchor" name="dde9e41e4fda8d1cd9e5947e44cbf40a"></a><!-- doxytag: member="Exiv2::Iptcdatum::getValue" ref="dde9e41e4fda8d1cd9e5947e44cbf40a" args="() const " --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"><a class="el" href="classExiv2_1_1Value.html#0f62e585b82c97738858b743e60dff21">Value::AutoPtr</a> Exiv2::Iptcdatum::getValue </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap> const<code> [inline, virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Return an auto-pointer to a copy (clone) of the value. The caller owns this copy and the auto-pointer 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">Value</a> to make use of the interface of the subclass to set or modify its contents.<p>
<dl compact><dt><b>Returns:</b></dt><dd>An auto-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>. </td>
</tr>
</table>
<a class="anchor" name="e0c9a888c38f17689e14b38baef0fe9b"></a><!-- doxytag: member="Exiv2::Iptcdatum::record" ref="e0c9a888c38f17689e14b38baef0fe9b" args="() const " --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">uint16_t Exiv2::Iptcdatum::record </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap> const<code> [inline]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Return the record id.
<p>
<dl compact><dt><b>Returns:</b></dt><dd>record id </dd></dl>
</td>
</tr>
</table>
<a class="anchor" name="596ec3daf2df643d2a625a525ebaedbe"></a><!-- doxytag: member="Exiv2::Iptcdatum::recordName" ref="596ec3daf2df643d2a625a525ebaedbe" args="() const " --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">std::string Exiv2::Iptcdatum::recordName </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap> const<code> [inline]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Return the name of the record.
<p>
<dl compact><dt><b>Returns:</b></dt><dd>record name </dd></dl>
</td>
</tr>
</table>
<a class="anchor" name="7e630890c95ee311a0774f5ba77da0cb"></a><!-- doxytag: member="Exiv2::Iptcdatum::tagName" ref="7e630890c95ee311a0774f5ba77da0cb" args="() const " --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">std::string Exiv2::Iptcdatum::tagName </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap> const<code> [inline, virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Return the name of the tag (aka dataset).
<p>
<dl 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>. </td>
</tr>
</table>
<a class="anchor" name="799184a3a000bda2432a0b7366c2dfb2"></a><!-- doxytag: member="Exiv2::Iptcdatum::value" ref="799184a3a000bda2432a0b7366c2dfb2" args="() const " --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">const <a class="el" href="classExiv2_1_1Value.html">Value</a> & Exiv2::Iptcdatum::value </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap> const<code> [virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<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_1IptcData.html#683257be46a446865ca5f4e81b8e88d9">IptcData::const_iterator</a> i = iptcData.findKey(<a class="code" href="classExiv2_1_1Iptcdatum.html#db8183876183516239f842d405980b43">key</a>);
<span class="keywordflow">if</span> (i != iptcData.end()) {
std::cout << i->key() << <span class="stringliteral">" "</span> << std::hex << i->value() << <span class="stringliteral">"\n"</span>;
}
</pre></div><p>
<dl 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">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>. </td>
</tr>
</table>
<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>
<hr size="1"><address style="align: right;"><small>Generated on Fri Jun 2 23:55:00 2006 for Exiv2 by
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.6 </small></address>
</body>
</html>
|
