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
|
<!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::ExifKey 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_1ExifKey.html">ExifKey</a></div>
<h1>Exiv2::ExifKey Class Reference</h1><!-- doxytag: class="Exiv2::ExifKey" --><!-- doxytag: inherits="Exiv2::Key" -->Concrete keys for Exif metadata.
<a href="#_details">More...</a>
<p>
<code>#include <tags.hpp></code>
<p>
Inheritance diagram for Exiv2::ExifKey:<p><center><img src="classExiv2_1_1ExifKey__inherit__graph.png" border="0" usemap="#Exiv2_1_1ExifKey__inherit__map" alt="Inheritance graph"></center>
<map name="Exiv2_1_1ExifKey__inherit__map">
<area href="classExiv2_1_1Key.html" shape="rect" coords="16,7,101,31" alt="">
</map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center>Collaboration diagram for Exiv2::ExifKey:<p><center><img src="classExiv2_1_1ExifKey__coll__graph.png" border="0" usemap="#Exiv2_1_1ExifKey__coll__map" alt="Collaboration graph"></center>
<map name="Exiv2_1_1ExifKey__coll__map">
<area href="classExiv2_1_1Key.html" shape="rect" coords="5,175,91,199" alt="">
</map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center><a href="classExiv2_1_1ExifKey-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Public Types</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="88f3c3ee83cc5c342ab72c777d5e12ce"></a><!-- doxytag: member="Exiv2::ExifKey::AutoPtr" ref="88f3c3ee83cc5c342ab72c777d5e12ce" args="" -->
typedef std::auto_ptr< <a class="el" href="classExiv2_1_1ExifKey.html">ExifKey</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classExiv2_1_1ExifKey.html#88f3c3ee83cc5c342ab72c777d5e12ce">AutoPtr</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Shortcut for an ExifKey auto pointer. <br></td></tr>
<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
<tr><td colspan="2"><div class="groupHeader">Creators</div></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classExiv2_1_1ExifKey.html#0874f4846012c3c0b67690ebb3fe9f9a">ExifKey</a> (const std::string &key)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Constructor to create an Exif key from a key string. <a href="#0874f4846012c3c0b67690ebb3fe9f9a"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classExiv2_1_1ExifKey.html#ee189320881e1fb26d0125978214d6ec">ExifKey</a> (uint16_t tag, const std::string &ifdItem)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Constructor to create an Exif key from a tag and IFD item string. <a href="#ee189320881e1fb26d0125978214d6ec"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ed2343725793982f89845a1b9d7d30d0"></a><!-- doxytag: member="Exiv2::ExifKey::ExifKey" ref="ed2343725793982f89845a1b9d7d30d0" args="(const Entry &e)" -->
</td><td class="memItemRight" valign="bottom"><a class="el" href="classExiv2_1_1ExifKey.html#ed2343725793982f89845a1b9d7d30d0">ExifKey</a> (const <a class="el" href="classExiv2_1_1Entry.html">Entry</a> &e)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Constructor to build an <a class="el" href="classExiv2_1_1ExifKey.html">ExifKey</a> from an IFD entry. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="60c87fdaf37922883f415a7ba244a968"></a><!-- doxytag: member="Exiv2::ExifKey::ExifKey" ref="60c87fdaf37922883f415a7ba244a968" args="(const ExifKey &rhs)" -->
</td><td class="memItemRight" valign="bottom"><a class="el" href="classExiv2_1_1ExifKey.html#60c87fdaf37922883f415a7ba244a968">ExifKey</a> (const <a class="el" href="classExiv2_1_1ExifKey.html">ExifKey</a> &rhs)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Copy constructor. <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="3827a71a5647f0163660bdf6d3733fbb"></a><!-- doxytag: member="Exiv2::ExifKey::operator=" ref="3827a71a5647f0163660bdf6d3733fbb" args="(const ExifKey &rhs)" -->
<a class="el" href="classExiv2_1_1ExifKey.html">ExifKey</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classExiv2_1_1ExifKey.html#3827a71a5647f0163660bdf6d3733fbb">operator=</a> (const <a class="el" href="classExiv2_1_1ExifKey.html">ExifKey</a> &rhs)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Assignment operator. <br></td></tr>
<tr><td colspan="2"><div class="groupHeader">Accessors</div></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="3b59e0750199f96324f5ef44719834c6"></a><!-- doxytag: member="Exiv2::ExifKey::key" ref="3b59e0750199f96324f5ef44719834c6" args="() const " -->
virtual std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classExiv2_1_1ExifKey.html#3b59e0750199f96324f5ef44719834c6">key</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return the key of the metadatum as a string. The key is of the form 'familyName.groupName.tagName'. Note however that the key is not necessarily unique, e.g., an <a class="el" href="classExiv2_1_1ExifData.html">ExifData</a> may contain multiple metadata with the same key. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="352f1370ce42657386071fcca25555aa"></a><!-- doxytag: member="Exiv2::ExifKey::familyName" ref="352f1370ce42657386071fcca25555aa" args="() const " -->
virtual const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="classExiv2_1_1ExifKey.html#352f1370ce42657386071fcca25555aa">familyName</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return an identifier for the type of metadata (the first part of the key). <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="03e334874d5a14d2221cfa9b58672c6f"></a><!-- doxytag: member="Exiv2::ExifKey::groupName" ref="03e334874d5a14d2221cfa9b58672c6f" args="() const " -->
virtual std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classExiv2_1_1ExifKey.html#03e334874d5a14d2221cfa9b58672c6f">groupName</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return the name of the group (the second part of the key). For Exif keys, the group name is the IFD item. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="c07b3698bb118ee22fa6989b5807c562"></a><!-- doxytag: member="Exiv2::ExifKey::tagName" ref="c07b3698bb118ee22fa6989b5807c562" args="() const " -->
virtual std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classExiv2_1_1ExifKey.html#c07b3698bb118ee22fa6989b5807c562">tagName</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return the name of the tag (which is also the third part of the key). <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="0db5806c2e85bf63609573f80f418a71"></a><!-- doxytag: member="Exiv2::ExifKey::tagLabel" ref="0db5806c2e85bf63609573f80f418a71" args="() const " -->
virtual std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classExiv2_1_1ExifKey.html#0db5806c2e85bf63609573f80f418a71">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="68e925f382052cc3ac88a6ef7397236d"></a><!-- doxytag: member="Exiv2::ExifKey::tag" ref="68e925f382052cc3ac88a6ef7397236d" args="() const " -->
virtual uint16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classExiv2_1_1ExifKey.html#68e925f382052cc3ac88a6ef7397236d">tag</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return the tag number. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="1260f76764a691afbaff18534c7985cc"></a><!-- doxytag: member="Exiv2::ExifKey::clone" ref="1260f76764a691afbaff18534c7985cc" args="() const " -->
<a class="el" href="classExiv2_1_1ExifKey.html#88f3c3ee83cc5c342ab72c777d5e12ce">AutoPtr</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classExiv2_1_1ExifKey.html#1260f76764a691afbaff18534c7985cc">clone</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return an auto-pointer to a copy of itself (deep copy). The caller owns this copy and the auto-pointer ensures that it will be deleted. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ed7f3e5223971db79857d1b65ffaa246"></a><!-- doxytag: member="Exiv2::ExifKey::ifdId" ref="ed7f3e5223971db79857d1b65ffaa246" args="() const " -->
<a class="el" href="namespaceExiv2.html#1615152767a506a955c9d13443b56b62">IfdId</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classExiv2_1_1ExifKey.html#ed7f3e5223971db79857d1b65ffaa246">ifdId</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return the IFD id. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="8ab50336317da0559ab9a69a5aedce7d"></a><!-- doxytag: member="Exiv2::ExifKey::ifdName" ref="8ab50336317da0559ab9a69a5aedce7d" args="() const " -->
const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="classExiv2_1_1ExifKey.html#8ab50336317da0559ab9a69a5aedce7d">ifdName</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return the name of the IFD. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="b261d0d99befc544926e32cb66d6ff89"></a><!-- doxytag: member="Exiv2::ExifKey::ifdItem" ref="b261d0d99befc544926e32cb66d6ff89" args="() const " -->
std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classExiv2_1_1ExifKey.html#b261d0d99befc544926e32cb66d6ff89">ifdItem</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return the related image item. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="141e928c87da2ec1a8d52c0238b7eea3"></a><!-- doxytag: member="Exiv2::ExifKey::sectionName" ref="141e928c87da2ec1a8d52c0238b7eea3" args="() const " -->
std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classExiv2_1_1ExifKey.html#141e928c87da2ec1a8d52c0238b7eea3">sectionName</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return the name of the Exif section (deprecated). <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="d7c5de10de9b6734b060e3433118926b"></a><!-- doxytag: member="Exiv2::ExifKey::idx" ref="d7c5de10de9b6734b060e3433118926b" args="() const " -->
int </td><td class="memItemRight" valign="bottom"><a class="el" href="classExiv2_1_1ExifKey.html#d7c5de10de9b6734b060e3433118926b">idx</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return the index (unique id of this key within the original IFD). <br></td></tr>
<tr><td colspan="2"><br><h2>Protected Member Functions</h2></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="846712abec6df0ebc811626c8278c51d"></a><!-- doxytag: member="Exiv2::ExifKey::makeKey" ref="846712abec6df0ebc811626c8278c51d" args="()" -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classExiv2_1_1ExifKey.html#846712abec6df0ebc811626c8278c51d">makeKey</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the key corresponding to the tag and IFD id. The key is of the form '<b>Exif</b>.ifdItem.tagName'. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classExiv2_1_1ExifKey.html#a326e0ffab35813b6c34513073893b3c">decomposeKey</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Parse and convert the key string into tag and IFD Id. Updates data members if the string can be decomposed, or throws <em><a class="el" href="classExiv2_1_1Error.html">Error</a></em> . <a href="#a326e0ffab35813b6c34513073893b3c"></a><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
Concrete keys for Exif metadata. <dl compact><dt><b>Examples: </b></dt><dd>
<p>
<a class="el" href="addmoddel_8cpp-example.html#_a3">addmoddel.cpp</a>.</dl>
<p>
<hr><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" name="0874f4846012c3c0b67690ebb3fe9f9a"></a><!-- doxytag: member="Exiv2::ExifKey::ExifKey" ref="0874f4846012c3c0b67690ebb3fe9f9a" args="(const std::string &key)" --><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::ExifKey::ExifKey </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">const std::string & </td>
<td class="mdname1" valign="top" nowrap> <em>key</em> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap><code> [explicit]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Constructor to create an Exif key from a key string.
<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 string. </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 first part of the key is not '<b>Exif</b>' or the remainin parts of the key cannot be parsed and converted to an ifd-item and tag name. </td></tr>
</table>
</dl>
</td>
</tr>
</table>
<a class="anchor" name="ee189320881e1fb26d0125978214d6ec"></a><!-- doxytag: member="Exiv2::ExifKey::ExifKey" ref="ee189320881e1fb26d0125978214d6ec" args="(uint16_t tag, const std::string &ifdItem)" --><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::ExifKey::ExifKey </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">uint16_t </td>
<td class="mdname" nowrap> <em>tag</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap>const std::string & </td>
<td class="mdname" nowrap> <em>ifdItem</em></td>
</tr>
<tr>
<td class="md"></td>
<td class="md">) </td>
<td class="md" colspan="2"></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Constructor to create an Exif key from a tag and IFD item string.
<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>tag</em> </td><td>The tag value </td></tr>
<tr><td valign="top"></td><td valign="top"><em>ifdItem</em> </td><td>The IFD string. For <a class="el" href="classExiv2_1_1MakerNote.html">MakerNote</a> tags, this must be the IFD item of the specific <a class="el" href="classExiv2_1_1MakerNote.html">MakerNote</a>. "MakerNote" is not allowed. </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 constructed from the tag and IFD item parameters. </td></tr>
</table>
</dl>
</td>
</tr>
</table>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="a326e0ffab35813b6c34513073893b3c"></a><!-- doxytag: member="Exiv2::ExifKey::decomposeKey" ref="a326e0ffab35813b6c34513073893b3c" args="()" --><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">void Exiv2::ExifKey::decomposeKey </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap><code> [protected]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Parse and convert the key string into tag and IFD Id. Updates data members if the string can be decomposed, or throws <em><a class="el" href="classExiv2_1_1Error.html">Error</a></em> .
<p>
<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 decomposed. </td></tr>
</table>
</dl>
</td>
</tr>
</table>
<hr>The documentation for this class was generated from the following files:<ul>
<li><a class="el" href="tags_8hpp.html">tags.hpp</a><li>tags.cpp</ul>
<hr size="1"><address style="align: right;"><small>Generated on Fri Jun 2 23:55:23 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>
|
