24
34
<a class="el" href="namespaceExiv2.html">Exiv2</a>::<a class="el" href="classExiv2_1_1IptcDataSets.html">IptcDataSets</a></div>
25
<h1>Exiv2::IptcDataSets Class Reference</h1><!-- doxytag: class="Exiv2::IptcDataSets" -->Container for Iptc dataset information. Implemented as a static class.
35
<h1>Exiv2::IptcDataSets Class Reference</h1><!-- doxytag: class="Exiv2::IptcDataSets" -->Container for IPTC dataset information. Implemented as a static class.
26
36
<a href="#_details">More...</a>
28
38
<code>#include <datasets.hpp></code>
30
40
Collaboration diagram for Exiv2::IptcDataSets:<p><center><img src="classExiv2_1_1IptcDataSets__coll__graph.png" border="0" usemap="#Exiv2_1_1IptcDataSets__coll__map" alt="Collaboration graph"></center>
31
41
<map name="Exiv2_1_1IptcDataSets__coll__map">
32
<area href="structExiv2_1_1RecordInfo.html" shape="rect" coords="5,7,133,31" alt="">
33
<area href="structExiv2_1_1DataSet.html" shape="rect" coords="157,7,267,31" alt="">
42
<area href="structExiv2_1_1RecordInfo.html" shape="rect" coords="5,7,144,31" alt="">
43
<area href="structExiv2_1_1DataSet.html" shape="rect" coords="168,7,291,31" alt="">
35
45
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center><a href="classExiv2_1_1IptcDataSets-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
37
47
<tr><td colspan="2"><br><h2>Static Public Member Functions</h2></td></tr>
38
<tr><td class="memItemLeft" nowrap align="right" valign="top">static std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classExiv2_1_1IptcDataSets.html#cf9da9675f32e0aa7ed1ba7477b5fa0f">dataSetName</a> (uint16_t number, uint16_t recordId)</td></tr>
40
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return the name of the dataset. <a href="#cf9da9675f32e0aa7ed1ba7477b5fa0f"></a><br></td></tr>
41
<tr><td class="memItemLeft" nowrap align="right" valign="top">static const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="classExiv2_1_1IptcDataSets.html#db1e57213642811fbe364e622a39430b">dataSetTitle</a> (uint16_t number, uint16_t recordId)</td></tr>
43
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return the title (label) of the dataset. <a href="#db1e57213642811fbe364e622a39430b"></a><br></td></tr>
44
<tr><td class="memItemLeft" nowrap align="right" valign="top">static const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="classExiv2_1_1IptcDataSets.html#bb3e47ab12bde848111a228fcd4b8dc2">dataSetDesc</a> (uint16_t number, uint16_t recordId)</td></tr>
46
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return the description of the dataset. <a href="#bb3e47ab12bde848111a228fcd4b8dc2"></a><br></td></tr>
47
<tr><td class="memItemLeft" nowrap align="right" valign="top">static const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="classExiv2_1_1IptcDataSets.html#7775528ce0f2b50c062c90bc41bd5899">dataSetPsName</a> (uint16_t number, uint16_t recordId)</td></tr>
49
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return the photohsop name of a given dataset. <a href="#7775528ce0f2b50c062c90bc41bd5899"></a><br></td></tr>
50
<tr><td class="memItemLeft" nowrap align="right" valign="top">static bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classExiv2_1_1IptcDataSets.html#ec65e226142ca1cc42d500d2975339f7">dataSetRepeatable</a> (uint16_t number, uint16_t recordId)</td></tr>
52
<tr><td class="mdescLeft"> </td><td class="mdescRight">Check if a given dataset is repeatable. <a href="#ec65e226142ca1cc42d500d2975339f7"></a><br></td></tr>
53
<tr><td class="memItemLeft" nowrap align="right" valign="top">static uint16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classExiv2_1_1IptcDataSets.html#e870d879dd1480ea7df3deb00d046b96">dataSet</a> (const std::string &dataSetName, uint16_t recordId)</td></tr>
55
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return the dataSet number for dataset name and record id. <a href="#e870d879dd1480ea7df3deb00d046b96"></a><br></td></tr>
56
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="b2cecf57fcd655b8c497a68ce39bfa38"></a><!-- doxytag: member="Exiv2::IptcDataSets::dataSetType" ref="b2cecf57fcd655b8c497a68ce39bfa38" args="(uint16_t number, uint16_t recordId)" -->
57
static <a class="el" href="namespaceExiv2.html#5153319711f35fe81cbc13f4b852450c">TypeId</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classExiv2_1_1IptcDataSets.html#b2cecf57fcd655b8c497a68ce39bfa38">dataSetType</a> (uint16_t number, uint16_t recordId)</td></tr>
48
<tr><td class="memItemLeft" nowrap align="right" valign="top">static std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classExiv2_1_1IptcDataSets.html#9b9ea82890e37029b5b9f5f6b99ebb06">dataSetName</a> (uint16_t number, uint16_t recordId)</td></tr>
50
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return the name of the dataset. <a href="#9b9ea82890e37029b5b9f5f6b99ebb06"></a><br></td></tr>
51
<tr><td class="memItemLeft" nowrap align="right" valign="top">static const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="classExiv2_1_1IptcDataSets.html#7df88d4f1b0ade27a7137d100ec67398">dataSetTitle</a> (uint16_t number, uint16_t recordId)</td></tr>
53
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return the title (label) of the dataset. <a href="#7df88d4f1b0ade27a7137d100ec67398"></a><br></td></tr>
54
<tr><td class="memItemLeft" nowrap align="right" valign="top">static const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="classExiv2_1_1IptcDataSets.html#01e90a141579ac47e7a5f3227cc3fb3d">dataSetDesc</a> (uint16_t number, uint16_t recordId)</td></tr>
56
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return the description of the dataset. <a href="#01e90a141579ac47e7a5f3227cc3fb3d"></a><br></td></tr>
57
<tr><td class="memItemLeft" nowrap align="right" valign="top">static const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="classExiv2_1_1IptcDataSets.html#a7d4013033ff5224155bfe040120378d">dataSetPsName</a> (uint16_t number, uint16_t recordId)</td></tr>
59
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return the photohsop name of a given dataset. <a href="#a7d4013033ff5224155bfe040120378d"></a><br></td></tr>
60
<tr><td class="memItemLeft" nowrap align="right" valign="top">static bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classExiv2_1_1IptcDataSets.html#c8d30717ec39431b83da4c34ff79a8e3">dataSetRepeatable</a> (uint16_t number, uint16_t recordId)</td></tr>
62
<tr><td class="mdescLeft"> </td><td class="mdescRight">Check if a given dataset is repeatable. <a href="#c8d30717ec39431b83da4c34ff79a8e3"></a><br></td></tr>
63
<tr><td class="memItemLeft" nowrap align="right" valign="top">static uint16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classExiv2_1_1IptcDataSets.html#d9313b3dd05b95f0a2daa64e87571f82">dataSet</a> (const std::string &dataSetName, uint16_t recordId)</td></tr>
65
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return the dataSet number for dataset name and record id. <a href="#d9313b3dd05b95f0a2daa64e87571f82"></a><br></td></tr>
66
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="54e0cb3dce9110395b9ee74ad05bd03c"></a><!-- doxytag: member="Exiv2::IptcDataSets::dataSetType" ref="54e0cb3dce9110395b9ee74ad05bd03c" args="(uint16_t number, uint16_t recordId)" -->
67
static <a class="el" href="namespaceExiv2.html#5153319711f35fe81cbc13f4b852450c">TypeId</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classExiv2_1_1IptcDataSets.html#54e0cb3dce9110395b9ee74ad05bd03c">dataSetType</a> (uint16_t number, uint16_t recordId)</td></tr>
59
69
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return the type for dataSet number and Record id. <br></td></tr>
60
<tr><td class="memItemLeft" nowrap align="right" valign="top">static std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classExiv2_1_1IptcDataSets.html#3b8106845031d532466282d26f1dd9fb">recordName</a> (uint16_t recordId)</td></tr>
62
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return the name of the Record. <a href="#3b8106845031d532466282d26f1dd9fb"></a><br></td></tr>
63
<tr><td class="memItemLeft" nowrap align="right" valign="top">static const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="classExiv2_1_1IptcDataSets.html#451b18150c3628d3761fc08950cf1975">recordDesc</a> (uint16_t recordId)</td></tr>
65
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return the description of a record. <a href="#451b18150c3628d3761fc08950cf1975"></a><br></td></tr>
66
<tr><td class="memItemLeft" nowrap align="right" valign="top">static uint16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classExiv2_1_1IptcDataSets.html#36ca205824a1b8f8c251e4150de1a9a9">recordId</a> (const std::string &recordName)</td></tr>
68
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return the Id number of a record. <a href="#36ca205824a1b8f8c251e4150de1a9a9"></a><br></td></tr>
69
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="234bd6223e95d18aa67fbc357b7a0e9b"></a><!-- doxytag: member="Exiv2::IptcDataSets::dataSetList" ref="234bd6223e95d18aa67fbc357b7a0e9b" args="(std::ostream &os)" -->
70
static void </td><td class="memItemRight" valign="bottom"><a class="el" href="classExiv2_1_1IptcDataSets.html#234bd6223e95d18aa67fbc357b7a0e9b">dataSetList</a> (std::ostream &os)</td></tr>
70
<tr><td class="memItemLeft" nowrap align="right" valign="top">static std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classExiv2_1_1IptcDataSets.html#d2eea4b9e00efa2fc4d3929451f4ea5c">recordName</a> (uint16_t recordId)</td></tr>
72
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return the name of the Record. <a href="#d2eea4b9e00efa2fc4d3929451f4ea5c"></a><br></td></tr>
73
<tr><td class="memItemLeft" nowrap align="right" valign="top">static const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="classExiv2_1_1IptcDataSets.html#0e9ea74d6d5ec013b1453e2d29341e46">recordDesc</a> (uint16_t recordId)</td></tr>
75
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return the description of a record. <a href="#0e9ea74d6d5ec013b1453e2d29341e46"></a><br></td></tr>
76
<tr><td class="memItemLeft" nowrap align="right" valign="top">static uint16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classExiv2_1_1IptcDataSets.html#8d7890f69135ad178de4c9dada1615f5">recordId</a> (const std::string &recordName)</td></tr>
78
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return the Id number of a record. <a href="#8d7890f69135ad178de4c9dada1615f5"></a><br></td></tr>
79
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="dbeb29e5bc97b17f3df9306fb17cfbf0"></a><!-- doxytag: member="Exiv2::IptcDataSets::envelopeRecordList" ref="dbeb29e5bc97b17f3df9306fb17cfbf0" args="()" -->
80
static const <a class="el" href="structExiv2_1_1DataSet.html">DataSet</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classExiv2_1_1IptcDataSets.html#dbeb29e5bc97b17f3df9306fb17cfbf0">envelopeRecordList</a> ()</td></tr>
82
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return read-only list of built-in Envelope Record datasets. <br></td></tr>
83
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="4d1ba044ef5ed680355e7fe11cab8bd7"></a><!-- doxytag: member="Exiv2::IptcDataSets::application2RecordList" ref="4d1ba044ef5ed680355e7fe11cab8bd7" args="()" -->
84
static const <a class="el" href="structExiv2_1_1DataSet.html">DataSet</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classExiv2_1_1IptcDataSets.html#4d1ba044ef5ed680355e7fe11cab8bd7">application2RecordList</a> ()</td></tr>
86
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return read-only list of built-in Application2 Record datasets. <br></td></tr>
87
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="11f48ad9e3e475515f81fe87ad33c802"></a><!-- doxytag: member="Exiv2::IptcDataSets::dataSetList" ref="11f48ad9e3e475515f81fe87ad33c802" args="(std::ostream &os)" -->
88
static void </td><td class="memItemRight" valign="bottom"><a class="el" href="classExiv2_1_1IptcDataSets.html#11f48ad9e3e475515f81fe87ad33c802">dataSetList</a> (std::ostream &os)</td></tr>
72
90
<tr><td class="mdescLeft"> </td><td class="mdescRight">Print a list of all dataSets to output stream. <br></td></tr>
73
91
<tr><td colspan="2"><br><h2>Static Public Attributes</h2></td></tr>
74
92
<tr><td colspan="2"><div class="groupHeader">Record identifiers</div></td></tr>
75
<tr><td colspan="2"><div class="groupText">Record identifiers to logically group dataSets. There are other possible record types, but they are not standardized by the Iptc IIM4 standard (and not commonly used in images). <br><br></div></td></tr>
93
<tr><td colspan="2"><div class="groupText">Record identifiers to logically group dataSets. There are other possible record types, but they are not standardized by the IPTC IIM4 standard (and not commonly used in images). <br><br></div></td></tr>
76
94
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="2145fa394443b3ac156185937ced00b8"></a><!-- doxytag: member="Exiv2::IptcDataSets::invalidRecord" ref="2145fa394443b3ac156185937ced00b8" args="" -->
77
95
static const uint16_t </td><td class="memItemRight" valign="bottom"><b>invalidRecord</b> = 0</td></tr>
300
318
<hr><a name="_details"></a><h2>Detailed Description</h2>
301
Container for Iptc dataset information. Implemented as a static class.
319
Container for IPTC dataset information. Implemented as a static class.
303
321
<hr><h2>Member Function Documentation</h2>
304
<a class="anchor" name="e870d879dd1480ea7df3deb00d046b96"></a><!-- doxytag: member="Exiv2::IptcDataSets::dataSet" ref="e870d879dd1480ea7df3deb00d046b96" args="(const std::string &dataSetName, uint16_t recordId)" --><p>
305
<table class="mdTable" cellpadding="2" cellspacing="0">
308
<table cellpadding="0" cellspacing="0" border="0">
310
<td class="md" nowrap valign="top">uint16_t Exiv2::IptcDataSets::dataSet </td>
311
<td class="md" valign="top">( </td>
312
<td class="md" nowrap valign="top">const std::string & </td>
313
<td class="mdname" nowrap> <em>dataSetName</em>, </td>
316
<td class="md" nowrap align="right"></td>
318
<td class="md" nowrap>uint16_t </td>
319
<td class="mdname" nowrap> <em>recordId</em></td>
323
<td class="md">) </td>
324
<td class="md" colspan="2"><code> [static]</code></td>
330
<table cellspacing="5" cellpadding="0" border="0">
322
<a class="anchor" name="9b9ea82890e37029b5b9f5f6b99ebb06"></a><!-- doxytag: member="Exiv2::IptcDataSets::dataSetName" ref="9b9ea82890e37029b5b9f5f6b99ebb06" args="(uint16_t number, uint16_t recordId)" -->
323
<div class="memitem">
324
<div class="memproto">
325
<table class="memname">
327
<td class="memname">static std::string Exiv2::IptcDataSets::dataSetName </td>
329
<td class="paramtype">uint16_t </td>
330
<td class="paramname"> <em>number</em>, </td>
333
<td class="paramkey"></td>
335
<td class="paramtype">uint16_t </td>
336
<td class="paramname"> <em>recordId</em></td><td> </td>
341
<td></td><td></td><td width="100%"><code> [static]</code></td>
348
Return the name of the dataset.
350
<dl compact><dt><b>Parameters:</b></dt><dd>
351
<table border="0" cellspacing="2" cellpadding="0">
352
<tr><td valign="top"></td><td valign="top"><em>number</em> </td><td>The dataset number </td></tr>
353
<tr><td valign="top"></td><td valign="top"><em>recordId</em> </td><td>The IPTC record Id </td></tr>
356
<dl class="return" compact><dt><b>Returns:</b></dt><dd>The name of the dataset or a string containing the hexadecimal value of the dataset in the form "0x01ff", if this is an unknown dataset. </dd></dl>
360
<a class="anchor" name="7df88d4f1b0ade27a7137d100ec67398"></a><!-- doxytag: member="Exiv2::IptcDataSets::dataSetTitle" ref="7df88d4f1b0ade27a7137d100ec67398" args="(uint16_t number, uint16_t recordId)" -->
361
<div class="memitem">
362
<div class="memproto">
363
<table class="memname">
365
<td class="memname">static const char* Exiv2::IptcDataSets::dataSetTitle </td>
367
<td class="paramtype">uint16_t </td>
368
<td class="paramname"> <em>number</em>, </td>
371
<td class="paramkey"></td>
373
<td class="paramtype">uint16_t </td>
374
<td class="paramname"> <em>recordId</em></td><td> </td>
379
<td></td><td></td><td width="100%"><code> [static]</code></td>
386
Return the title (label) of the dataset.
388
<dl compact><dt><b>Parameters:</b></dt><dd>
389
<table border="0" cellspacing="2" cellpadding="0">
390
<tr><td valign="top"></td><td valign="top"><em>number</em> </td><td>The dataset number </td></tr>
391
<tr><td valign="top"></td><td valign="top"><em>recordId</em> </td><td>The IPTC record Id </td></tr>
394
<dl class="return" compact><dt><b>Returns:</b></dt><dd>The title (label) of the dataset </dd></dl>
398
<a class="anchor" name="01e90a141579ac47e7a5f3227cc3fb3d"></a><!-- doxytag: member="Exiv2::IptcDataSets::dataSetDesc" ref="01e90a141579ac47e7a5f3227cc3fb3d" args="(uint16_t number, uint16_t recordId)" -->
399
<div class="memitem">
400
<div class="memproto">
401
<table class="memname">
403
<td class="memname">static const char* Exiv2::IptcDataSets::dataSetDesc </td>
405
<td class="paramtype">uint16_t </td>
406
<td class="paramname"> <em>number</em>, </td>
409
<td class="paramkey"></td>
411
<td class="paramtype">uint16_t </td>
412
<td class="paramname"> <em>recordId</em></td><td> </td>
417
<td></td><td></td><td width="100%"><code> [static]</code></td>
424
Return the description of the dataset.
426
<dl compact><dt><b>Parameters:</b></dt><dd>
427
<table border="0" cellspacing="2" cellpadding="0">
428
<tr><td valign="top"></td><td valign="top"><em>number</em> </td><td>The dataset number </td></tr>
429
<tr><td valign="top"></td><td valign="top"><em>recordId</em> </td><td>The IPTC record Id </td></tr>
432
<dl class="return" compact><dt><b>Returns:</b></dt><dd>The description of the dataset </dd></dl>
436
<a class="anchor" name="a7d4013033ff5224155bfe040120378d"></a><!-- doxytag: member="Exiv2::IptcDataSets::dataSetPsName" ref="a7d4013033ff5224155bfe040120378d" args="(uint16_t number, uint16_t recordId)" -->
437
<div class="memitem">
438
<div class="memproto">
439
<table class="memname">
441
<td class="memname">static const char* Exiv2::IptcDataSets::dataSetPsName </td>
443
<td class="paramtype">uint16_t </td>
444
<td class="paramname"> <em>number</em>, </td>
447
<td class="paramkey"></td>
449
<td class="paramtype">uint16_t </td>
450
<td class="paramname"> <em>recordId</em></td><td> </td>
455
<td></td><td></td><td width="100%"><code> [static]</code></td>
462
Return the photohsop name of a given dataset.
464
<dl compact><dt><b>Parameters:</b></dt><dd>
465
<table border="0" cellspacing="2" cellpadding="0">
466
<tr><td valign="top"></td><td valign="top"><em>number</em> </td><td>The dataset number </td></tr>
467
<tr><td valign="top"></td><td valign="top"><em>recordId</em> </td><td>The IPTC record Id </td></tr>
470
<dl class="return" compact><dt><b>Returns:</b></dt><dd>The name used by photoshop for a dataset or an empty string if photoshop does not use the dataset. </dd></dl>
474
<a class="anchor" name="c8d30717ec39431b83da4c34ff79a8e3"></a><!-- doxytag: member="Exiv2::IptcDataSets::dataSetRepeatable" ref="c8d30717ec39431b83da4c34ff79a8e3" args="(uint16_t number, uint16_t recordId)" -->
475
<div class="memitem">
476
<div class="memproto">
477
<table class="memname">
479
<td class="memname">static bool Exiv2::IptcDataSets::dataSetRepeatable </td>
481
<td class="paramtype">uint16_t </td>
482
<td class="paramname"> <em>number</em>, </td>
485
<td class="paramkey"></td>
487
<td class="paramtype">uint16_t </td>
488
<td class="paramname"> <em>recordId</em></td><td> </td>
493
<td></td><td></td><td width="100%"><code> [static]</code></td>
500
Check if a given dataset is repeatable.
502
<dl compact><dt><b>Parameters:</b></dt><dd>
503
<table border="0" cellspacing="2" cellpadding="0">
504
<tr><td valign="top"></td><td valign="top"><em>number</em> </td><td>The dataset number </td></tr>
505
<tr><td valign="top"></td><td valign="top"><em>recordId</em> </td><td>The IPTC record Id </td></tr>
508
<dl class="return" compact><dt><b>Returns:</b></dt><dd>true if the given dataset is repeatable otherwise false </dd></dl>
512
<a class="anchor" name="d9313b3dd05b95f0a2daa64e87571f82"></a><!-- doxytag: member="Exiv2::IptcDataSets::dataSet" ref="d9313b3dd05b95f0a2daa64e87571f82" args="(const std::string &dataSetName, uint16_t recordId)" -->
513
<div class="memitem">
514
<div class="memproto">
515
<table class="memname">
517
<td class="memname">static uint16_t Exiv2::IptcDataSets::dataSet </td>
519
<td class="paramtype">const std::string & </td>
520
<td class="paramname"> <em>dataSetName</em>, </td>
523
<td class="paramkey"></td>
525
<td class="paramtype">uint16_t </td>
526
<td class="paramname"> <em>recordId</em></td><td> </td>
531
<td></td><td></td><td width="100%"><code> [static]</code></td>
338
538
Return the dataSet number for dataset name and record id.
343
543
<tr><td valign="top"></td><td valign="top"><em>recordId</em> </td><td>recordId</td></tr>
346
<dl compact><dt><b>Returns:</b></dt><dd>dataSet number</dd></dl>
546
<dl class="return" compact><dt><b>Returns:</b></dt><dd>dataSet number</dd></dl>
347
547
<dl compact><dt><b>Exceptions:</b></dt><dd>
348
548
<table border="0" cellspacing="2" cellpadding="0">
349
549
<tr><td valign="top"></td><td valign="top"><em><a class="el" href="classExiv2_1_1Error.html">Error</a></em> </td><td>if the <em>dataSetName</em> or <em>recordId</em> are invalid </td></tr>
355
<a class="anchor" name="bb3e47ab12bde848111a228fcd4b8dc2"></a><!-- doxytag: member="Exiv2::IptcDataSets::dataSetDesc" ref="bb3e47ab12bde848111a228fcd4b8dc2" args="(uint16_t number, uint16_t recordId)" --><p>
356
<table class="mdTable" cellpadding="2" cellspacing="0">
359
<table cellpadding="0" cellspacing="0" border="0">
361
<td class="md" nowrap valign="top">const char * Exiv2::IptcDataSets::dataSetDesc </td>
362
<td class="md" valign="top">( </td>
363
<td class="md" nowrap valign="top">uint16_t </td>
364
<td class="mdname" nowrap> <em>number</em>, </td>
367
<td class="md" nowrap align="right"></td>
369
<td class="md" nowrap>uint16_t </td>
370
<td class="mdname" nowrap> <em>recordId</em></td>
374
<td class="md">) </td>
375
<td class="md" colspan="2"><code> [static]</code></td>
381
<table cellspacing="5" cellpadding="0" border="0">
389
Return the description of the dataset.
391
<dl compact><dt><b>Parameters:</b></dt><dd>
392
<table border="0" cellspacing="2" cellpadding="0">
393
<tr><td valign="top"></td><td valign="top"><em>number</em> </td><td>The dataset number </td></tr>
394
<tr><td valign="top"></td><td valign="top"><em>recordId</em> </td><td>The Iptc record Id </td></tr>
397
<dl compact><dt><b>Returns:</b></dt><dd>The description of the dataset </dd></dl>
401
<a class="anchor" name="cf9da9675f32e0aa7ed1ba7477b5fa0f"></a><!-- doxytag: member="Exiv2::IptcDataSets::dataSetName" ref="cf9da9675f32e0aa7ed1ba7477b5fa0f" args="(uint16_t number, uint16_t recordId)" --><p>
402
<table class="mdTable" cellpadding="2" cellspacing="0">
405
<table cellpadding="0" cellspacing="0" border="0">
407
<td class="md" nowrap valign="top">std::string Exiv2::IptcDataSets::dataSetName </td>
408
<td class="md" valign="top">( </td>
409
<td class="md" nowrap valign="top">uint16_t </td>
410
<td class="mdname" nowrap> <em>number</em>, </td>
413
<td class="md" nowrap align="right"></td>
415
<td class="md" nowrap>uint16_t </td>
416
<td class="mdname" nowrap> <em>recordId</em></td>
420
<td class="md">) </td>
421
<td class="md" colspan="2"><code> [static]</code></td>
427
<table cellspacing="5" cellpadding="0" border="0">
435
Return the name of the dataset.
437
<dl compact><dt><b>Parameters:</b></dt><dd>
438
<table border="0" cellspacing="2" cellpadding="0">
439
<tr><td valign="top"></td><td valign="top"><em>number</em> </td><td>The dataset number </td></tr>
440
<tr><td valign="top"></td><td valign="top"><em>recordId</em> </td><td>The Iptc record Id </td></tr>
443
<dl compact><dt><b>Returns:</b></dt><dd>The name of the dataset or a string containing the hexadecimal value of the dataset in the form "0x01ff", if this is an unknown dataset. </dd></dl>
447
<a class="anchor" name="7775528ce0f2b50c062c90bc41bd5899"></a><!-- doxytag: member="Exiv2::IptcDataSets::dataSetPsName" ref="7775528ce0f2b50c062c90bc41bd5899" args="(uint16_t number, uint16_t recordId)" --><p>
448
<table class="mdTable" cellpadding="2" cellspacing="0">
451
<table cellpadding="0" cellspacing="0" border="0">
453
<td class="md" nowrap valign="top">const char * Exiv2::IptcDataSets::dataSetPsName </td>
454
<td class="md" valign="top">( </td>
455
<td class="md" nowrap valign="top">uint16_t </td>
456
<td class="mdname" nowrap> <em>number</em>, </td>
459
<td class="md" nowrap align="right"></td>
461
<td class="md" nowrap>uint16_t </td>
462
<td class="mdname" nowrap> <em>recordId</em></td>
466
<td class="md">) </td>
467
<td class="md" colspan="2"><code> [static]</code></td>
473
<table cellspacing="5" cellpadding="0" border="0">
481
Return the photohsop name of a given dataset.
483
<dl compact><dt><b>Parameters:</b></dt><dd>
484
<table border="0" cellspacing="2" cellpadding="0">
485
<tr><td valign="top"></td><td valign="top"><em>number</em> </td><td>The dataset number </td></tr>
486
<tr><td valign="top"></td><td valign="top"><em>recordId</em> </td><td>The Iptc record Id </td></tr>
489
<dl compact><dt><b>Returns:</b></dt><dd>The name used by photoshop for a dataset or an empty string if photoshop does not use the dataset. </dd></dl>
493
<a class="anchor" name="ec65e226142ca1cc42d500d2975339f7"></a><!-- doxytag: member="Exiv2::IptcDataSets::dataSetRepeatable" ref="ec65e226142ca1cc42d500d2975339f7" args="(uint16_t number, uint16_t recordId)" --><p>
494
<table class="mdTable" cellpadding="2" cellspacing="0">
497
<table cellpadding="0" cellspacing="0" border="0">
499
<td class="md" nowrap valign="top">bool Exiv2::IptcDataSets::dataSetRepeatable </td>
500
<td class="md" valign="top">( </td>
501
<td class="md" nowrap valign="top">uint16_t </td>
502
<td class="mdname" nowrap> <em>number</em>, </td>
505
<td class="md" nowrap align="right"></td>
507
<td class="md" nowrap>uint16_t </td>
508
<td class="mdname" nowrap> <em>recordId</em></td>
512
<td class="md">) </td>
513
<td class="md" colspan="2"><code> [static]</code></td>
519
<table cellspacing="5" cellpadding="0" border="0">
527
Check if a given dataset is repeatable.
529
<dl compact><dt><b>Parameters:</b></dt><dd>
530
<table border="0" cellspacing="2" cellpadding="0">
531
<tr><td valign="top"></td><td valign="top"><em>number</em> </td><td>The dataset number </td></tr>
532
<tr><td valign="top"></td><td valign="top"><em>recordId</em> </td><td>The Iptc record Id </td></tr>
535
<dl compact><dt><b>Returns:</b></dt><dd>true if the given dataset is repeatable otherwise false </dd></dl>
539
<a class="anchor" name="db1e57213642811fbe364e622a39430b"></a><!-- doxytag: member="Exiv2::IptcDataSets::dataSetTitle" ref="db1e57213642811fbe364e622a39430b" args="(uint16_t number, uint16_t recordId)" --><p>
540
<table class="mdTable" cellpadding="2" cellspacing="0">
543
<table cellpadding="0" cellspacing="0" border="0">
545
<td class="md" nowrap valign="top">const char * Exiv2::IptcDataSets::dataSetTitle </td>
546
<td class="md" valign="top">( </td>
547
<td class="md" nowrap valign="top">uint16_t </td>
548
<td class="mdname" nowrap> <em>number</em>, </td>
551
<td class="md" nowrap align="right"></td>
553
<td class="md" nowrap>uint16_t </td>
554
<td class="mdname" nowrap> <em>recordId</em></td>
558
<td class="md">) </td>
559
<td class="md" colspan="2"><code> [static]</code></td>
565
<table cellspacing="5" cellpadding="0" border="0">
573
Return the title (label) of the dataset.
575
<dl compact><dt><b>Parameters:</b></dt><dd>
576
<table border="0" cellspacing="2" cellpadding="0">
577
<tr><td valign="top"></td><td valign="top"><em>number</em> </td><td>The dataset number </td></tr>
578
<tr><td valign="top"></td><td valign="top"><em>recordId</em> </td><td>The Iptc record Id </td></tr>
581
<dl compact><dt><b>Returns:</b></dt><dd>The title (label) of the dataset </dd></dl>
585
<a class="anchor" name="451b18150c3628d3761fc08950cf1975"></a><!-- doxytag: member="Exiv2::IptcDataSets::recordDesc" ref="451b18150c3628d3761fc08950cf1975" args="(uint16_t recordId)" --><p>
586
<table class="mdTable" cellpadding="2" cellspacing="0">
589
<table cellpadding="0" cellspacing="0" border="0">
591
<td class="md" nowrap valign="top">const char * Exiv2::IptcDataSets::recordDesc </td>
592
<td class="md" valign="top">( </td>
593
<td class="md" nowrap valign="top">uint16_t </td>
594
<td class="mdname1" valign="top" nowrap> <em>recordId</em> </td>
595
<td class="md" valign="top"> ) </td>
596
<td class="md" nowrap><code> [static]</code></td>
602
<table cellspacing="5" cellpadding="0" border="0">
555
<a class="anchor" name="d2eea4b9e00efa2fc4d3929451f4ea5c"></a><!-- doxytag: member="Exiv2::IptcDataSets::recordName" ref="d2eea4b9e00efa2fc4d3929451f4ea5c" args="(uint16_t recordId)" -->
556
<div class="memitem">
557
<div class="memproto">
558
<table class="memname">
560
<td class="memname">static std::string Exiv2::IptcDataSets::recordName </td>
562
<td class="paramtype">uint16_t </td>
563
<td class="paramname"> <em>recordId</em> </td>
564
<td> ) </td>
565
<td width="100%"><code> [static]</code></td>
572
Return the name of the Record.
574
<dl compact><dt><b>Parameters:</b></dt><dd>
575
<table border="0" cellspacing="2" cellpadding="0">
576
<tr><td valign="top"></td><td valign="top"><em>recordId</em> </td><td>The record id </td></tr>
579
<dl class="return" compact><dt><b>Returns:</b></dt><dd>The name of the record or a string containing the hexadecimal value of the record in the form "0x01ff", if this is an unknown record. </dd></dl>
583
<a class="anchor" name="0e9ea74d6d5ec013b1453e2d29341e46"></a><!-- doxytag: member="Exiv2::IptcDataSets::recordDesc" ref="0e9ea74d6d5ec013b1453e2d29341e46" args="(uint16_t recordId)" -->
584
<div class="memitem">
585
<div class="memproto">
586
<table class="memname">
588
<td class="memname">static const char* Exiv2::IptcDataSets::recordDesc </td>
590
<td class="paramtype">uint16_t </td>
591
<td class="paramname"> <em>recordId</em> </td>
592
<td> ) </td>
593
<td width="100%"><code> [static]</code></td>
610
600
Return the description of a record.
650
632
<tr><td valign="top"></td><td valign="top"><em>recordName</em> </td><td>Name of a record type </td></tr>
653
<dl compact><dt><b>Returns:</b></dt><dd>the Id number of a Record </dd></dl>
635
<dl class="return" compact><dt><b>Returns:</b></dt><dd>the Id number of a Record </dd></dl>
654
636
<dl compact><dt><b>Exceptions:</b></dt><dd>
655
637
<table border="0" cellspacing="2" cellpadding="0">
656
638
<tr><td valign="top"></td><td valign="top"><em><a class="el" href="classExiv2_1_1Error.html">Error</a></em> </td><td>if the record is not known; </td></tr>
662
<a class="anchor" name="3b8106845031d532466282d26f1dd9fb"></a><!-- doxytag: member="Exiv2::IptcDataSets::recordName" ref="3b8106845031d532466282d26f1dd9fb" args="(uint16_t recordId)" --><p>
663
<table class="mdTable" cellpadding="2" cellspacing="0">
666
<table cellpadding="0" cellspacing="0" border="0">
668
<td class="md" nowrap valign="top">std::string Exiv2::IptcDataSets::recordName </td>
669
<td class="md" valign="top">( </td>
670
<td class="md" nowrap valign="top">uint16_t </td>
671
<td class="mdname1" valign="top" nowrap> <em>recordId</em> </td>
672
<td class="md" valign="top"> ) </td>
673
<td class="md" nowrap><code> [static]</code></td>
679
<table cellspacing="5" cellpadding="0" border="0">
687
Return the name of the Record.
689
<dl compact><dt><b>Parameters:</b></dt><dd>
690
<table border="0" cellspacing="2" cellpadding="0">
691
<tr><td valign="top"></td><td valign="top"><em>recordId</em> </td><td>The record id </td></tr>
694
<dl compact><dt><b>Returns:</b></dt><dd>The name of the record or a string containing the hexadecimal value of the record in the form "0x01ff", if this is an unknown record. </dd></dl>
698
<hr>The documentation for this class was generated from the following files:<ul>
699
<li><a class="el" href="datasets_8hpp.html">datasets.hpp</a><li>datasets.cpp</ul>
700
<hr size="1"><address style="align: right;"><small>Generated on Fri Jun 2 23:54:52 2006 for Exiv2 by
644
<hr>The documentation for this class was generated from the following file:<ul>
645
<li><a class="el" href="datasets_8hpp.html">datasets.hpp</a></ul>
646
<hr size="1"><address style="align: right;"><small>Generated on Mon Nov 27 20:16:26 2006 for Exiv2 by
701
647
<a href="http://www.doxygen.org/index.html">
702
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.6 </small></address>
648
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.1 </small></address>