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
|
<!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::ExvImage 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_1ExvImage.html">ExvImage</a></div>
<h1>Exiv2::ExvImage Class Reference</h1><!-- doxytag: class="Exiv2::ExvImage" --><!-- doxytag: inherits="Exiv2::JpegBase" -->Helper class to access Exiv2 files.
<a href="#_details">More...</a>
<p>
<code>#include <jpgimage.hpp></code>
<p>
Inheritance diagram for Exiv2::ExvImage:<p><center><img src="classExiv2_1_1ExvImage__inherit__graph.png" border="0" usemap="#Exiv2_1_1ExvImage__inherit__map" alt="Inheritance graph"></center>
<map name="Exiv2_1_1ExvImage__inherit__map">
<area href="classExiv2_1_1JpegBase.html" shape="rect" coords="7,82,127,106" alt="">
<area href="classExiv2_1_1Image.html" shape="rect" coords="17,7,116,31" alt="">
</map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center>Collaboration diagram for Exiv2::ExvImage:<p><center><img src="classExiv2_1_1ExvImage__coll__graph.png" border="0" usemap="#Exiv2_1_1ExvImage__coll__map" alt="Collaboration graph"></center>
<map name="Exiv2_1_1ExvImage__coll__map">
<area href="classExiv2_1_1JpegBase.html" shape="rect" coords="353,439,473,463" alt="">
<area href="classExiv2_1_1Image.html" shape="rect" coords="129,348,228,372" alt="">
<area href="classExiv2_1_1ExifData.html" shape="rect" coords="357,348,469,372" alt="">
<area href="classExiv2_1_1MakerNote.html" shape="rect" coords="91,199,219,223" alt="">
<area href="classExiv2_1_1Ifd.html" shape="rect" coords="523,199,600,223" alt="">
<area href="classExiv2_1_1IptcData.html" shape="rect" coords="5,274,117,298" alt="">
<area href="classExiv2_1_1TiffHeader.html" shape="rect" coords="243,199,365,223" alt="">
</map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center><a href="classExiv2_1_1ExvImage-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_1ExvImage.html#d5491d94dada45a88e26df873bd4ad4b">ExvImage</a> (<a class="el" href="classExiv2_1_1BasicIo.html#f8f989522925b884d8c9d3a257265fa1">BasicIo::AutoPtr</a> io, bool create)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Constructor that can either open an existing Exv image or create a new image from scratch. If a new image is to be created, any existing data is overwritten. Since the constructor can not return a result, callers should check the <a class="el" href="classExiv2_1_1JpegBase.html#0c44e78e8fd0fdbc403c3a91b4034728">good()</a> method after object construction to determine success or failure. <a href="#d5491d94dada45a88e26df873bd4ad4b"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="024ad6cda0aa80cfdb47fde56a31b8cd"></a><!-- doxytag: member="Exiv2::ExvImage::~ExvImage" ref="024ad6cda0aa80cfdb47fde56a31b8cd" args="()" -->
</td><td class="memItemRight" valign="bottom"><a class="el" href="classExiv2_1_1ExvImage.html#024ad6cda0aa80cfdb47fde56a31b8cd">~ExvImage</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Destructor. <br></td></tr>
<tr><td colspan="2"><br><h2>Protected Member Functions</h2></td></tr>
<tr><td colspan="2"><div class="groupHeader">Accessors</div></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classExiv2_1_1ExvImage.html#480b16cd980735218d8fb8c4e7ad19c6">isThisType</a> (<a class="el" href="classExiv2_1_1BasicIo.html">BasicIo</a> &iIo, bool advance) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Determine if the content of the <a class="el" href="classExiv2_1_1BasicIo.html">BasicIo</a> instance is of the type supported by this class. <a href="#480b16cd980735218d8fb8c4e7ad19c6"></a><br></td></tr>
<tr><td colspan="2"><div class="groupHeader">Manipulators</div></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classExiv2_1_1ExvImage.html#c8d38bdde6a43d90e9c5d8ec1eacc7b0">writeHeader</a> (<a class="el" href="classExiv2_1_1BasicIo.html">BasicIo</a> &oIo) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Writes the image header (aka signature) to the <a class="el" href="classExiv2_1_1BasicIo.html">BasicIo</a> instance. <a href="#c8d38bdde6a43d90e9c5d8ec1eacc7b0"></a><br></td></tr>
<tr><td colspan="2"><br><h2>Friends</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="3582c32702a12ab43f70d78e961f0f19"></a><!-- doxytag: member="Exiv2::ExvImage::isExvType" ref="3582c32702a12ab43f70d78e961f0f19" args="(BasicIo &iIo, bool advance)" -->
bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classExiv2_1_1ExvImage.html#3582c32702a12ab43f70d78e961f0f19">isExvType</a> (<a class="el" href="classExiv2_1_1BasicIo.html">BasicIo</a> &iIo, bool advance)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Check if the file iIo is an EXV file. <br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
Helper class to access Exiv2 files.
<p>
<hr><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" name="d5491d94dada45a88e26df873bd4ad4b"></a><!-- doxytag: member="Exiv2::ExvImage::ExvImage" ref="d5491d94dada45a88e26df873bd4ad4b" args="(BasicIo::AutoPtr io, bool create)" --><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::ExvImage::ExvImage </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="classExiv2_1_1BasicIo.html#f8f989522925b884d8c9d3a257265fa1">BasicIo::AutoPtr</a> </td>
<td class="mdname" nowrap> <em>io</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap>bool </td>
<td class="mdname" nowrap> <em>create</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 that can either open an existing Exv image or create a new image from scratch. If a new image is to be created, any existing data is overwritten. Since the constructor can not return a result, callers should check the <a class="el" href="classExiv2_1_1JpegBase.html#0c44e78e8fd0fdbc403c3a91b4034728">good()</a> method after object construction to determine success or failure.
<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>io</em> </td><td>An auto-pointer that owns a <a class="el" href="classExiv2_1_1BasicIo.html">BasicIo</a> instance used for reading and writing image metadata. <b>Important:</b> The constructor takes ownership of the passed in <a class="el" href="classExiv2_1_1BasicIo.html">BasicIo</a> instance through the auto-pointer. Callers should not continue to use the <a class="el" href="classExiv2_1_1BasicIo.html">BasicIo</a> instance after it is passed to this method. Use the <a class="el" href="classExiv2_1_1Image.html#bf0ec3095733c0dfb73ba1bb4a19591e">Image::io()</a> method to get a temporary reference. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>create</em> </td><td>Specifies if an existing image should be read (false) or if a new file should be created (true). </td></tr>
</table>
</dl>
</td>
</tr>
</table>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="480b16cd980735218d8fb8c4e7ad19c6"></a><!-- doxytag: member="Exiv2::ExvImage::isThisType" ref="480b16cd980735218d8fb8c4e7ad19c6" args="(BasicIo &iIo, bool advance) 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">bool Exiv2::ExvImage::isThisType </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="classExiv2_1_1BasicIo.html">BasicIo</a> & </td>
<td class="mdname" nowrap> <em>iIo</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap>bool </td>
<td class="mdname" nowrap> <em>advance</em></td>
</tr>
<tr>
<td class="md"></td>
<td class="md">) </td>
<td class="md" colspan="2"> const<code> [protected, virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Determine if the content of the <a class="el" href="classExiv2_1_1BasicIo.html">BasicIo</a> instance is of the type supported by this class.
<p>
The advance flag determines if the read position in the stream is moved (see below). This applies only if the type matches and the function returns true. If the type does not match, the stream position is not changed. However, if reading from the stream fails, the stream position is undefined. Consult the stream state to obtain more information in this case.<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>iIo</em> </td><td><a class="el" href="classExiv2_1_1BasicIo.html">BasicIo</a> instance to read from. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>advance</em> </td><td>Flag indicating whether the position of the io should be advanced by the number of characters read to analyse the data (true) or left at its original position (false). This applies only if the type matches. </td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>true if the data matches the type of this class;<br>
false if the data does not match </dd></dl>
<p>
Implements <a class="el" href="classExiv2_1_1JpegBase.html#ad464a055fd28f2f0e9f99af3967f208">Exiv2::JpegBase</a>. </td>
</tr>
</table>
<a class="anchor" name="c8d38bdde6a43d90e9c5d8ec1eacc7b0"></a><!-- doxytag: member="Exiv2::ExvImage::writeHeader" ref="c8d38bdde6a43d90e9c5d8ec1eacc7b0" args="(BasicIo &oIo) 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">int Exiv2::ExvImage::writeHeader </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="classExiv2_1_1BasicIo.html">BasicIo</a> & </td>
<td class="mdname1" valign="top" nowrap> <em>oIo</em> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap> const<code> [protected, virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Writes the image header (aka signature) to the <a class="el" href="classExiv2_1_1BasicIo.html">BasicIo</a> instance.
<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>oIo</em> </td><td><a class="el" href="classExiv2_1_1BasicIo.html">BasicIo</a> instance that the header is written to. </td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>0 if successful;<br>
4 if the output file can not be written to </dd></dl>
<p>
Implements <a class="el" href="classExiv2_1_1JpegBase.html#17bc2fe8a8e2562ae18d220e695cf2bf">Exiv2::JpegBase</a>. </td>
</tr>
</table>
<hr>The documentation for this class was generated from the following files:<ul>
<li><a class="el" href="jpgimage_8hpp.html">jpgimage.hpp</a><li>jpgimage.cpp</ul>
<hr size="1"><address style="align: right;"><small>Generated on Fri Jun 2 23:55:03 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>
|
