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
|
<!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::CiffHeader 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_1CiffHeader.html">CiffHeader</a></div>
<h1>Exiv2::CiffHeader Class Reference</h1><!-- doxytag: class="Exiv2::CiffHeader" -->This class models the header of a Crw (Canon Raw data) image. It is the head of a CIFF parse tree, consisting of <a class="el" href="classExiv2_1_1CiffDirectory.html">CiffDirectory</a> and <a class="el" href="classExiv2_1_1CiffEntry.html">CiffEntry</a> objects. Most of its methods will walk the parse tree to perform the requested action.
<a href="#_details">More...</a>
<p>
<code>#include <crwimage.hpp></code>
<p>
Collaboration diagram for Exiv2::CiffHeader:<p><center><img src="classExiv2_1_1CiffHeader__coll__graph.png" border="0" usemap="#Exiv2_1_1CiffHeader__coll__map" alt="Collaboration graph"></center>
<map name="Exiv2_1_1CiffHeader__coll__map">
<area href="classExiv2_1_1CiffDirectory.html" shape="rect" coords="14,84,150,108" alt="">
<area href="classExiv2_1_1CiffComponent.html" shape="rect" coords="6,7,158,31" alt="">
</map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center><a href="classExiv2_1_1CiffHeader-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="e38af44f405d657e98378d54aaa4b8bb"></a><!-- doxytag: member="Exiv2::CiffHeader::AutoPtr" ref="e38af44f405d657e98378d54aaa4b8bb" args="" -->
typedef std::auto_ptr< <a class="el" href="classExiv2_1_1CiffHeader.html">CiffHeader</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classExiv2_1_1CiffHeader.html#e38af44f405d657e98378d54aaa4b8bb">AutoPtr</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight"><a class="el" href="classExiv2_1_1CiffHeader.html">CiffHeader</a> auto_ptr type. <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"><a class="anchor" name="d43a1c584f81093e95dfb827500c9caf"></a><!-- doxytag: member="Exiv2::CiffHeader::CiffHeader" ref="d43a1c584f81093e95dfb827500c9caf" args="()" -->
</td><td class="memItemRight" valign="bottom"><a class="el" href="classExiv2_1_1CiffHeader.html#d43a1c584f81093e95dfb827500c9caf">CiffHeader</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Default constructor. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="bb5f50c789d57b47dace237febeb8b64"></a><!-- doxytag: member="Exiv2::CiffHeader::~CiffHeader" ref="bb5f50c789d57b47dace237febeb8b64" args="()" -->
virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classExiv2_1_1CiffHeader.html#bb5f50c789d57b47dace237febeb8b64">~CiffHeader</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Virtual destructor. <br></td></tr>
<tr><td colspan="2"><div class="groupHeader">Manipulators</div></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classExiv2_1_1CiffHeader.html#d5601fd0024c3d91d25486a3877d8fa2">read</a> (const <a class="el" href="namespaceExiv2.html#16f60a5bd4207fe155f6cf93a15efa72">byte</a> *pData, uint32_t size)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Read the Crw image from a data buffer, starting with the Ciff header. <a href="#d5601fd0024c3d91d25486a3877d8fa2"></a><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_1CiffHeader.html#37a3faad6fb11f5e851e243fcdcce35b">add</a> (uint16_t crwTagId, uint16_t crwDir, <a class="el" href="classExiv2_1_1DataBuf.html">DataBuf</a> buf)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the value of entry <em>crwTagId</em> in directory <em>crwDir</em> to <em>buf</em>. If this tag doesn't exist, it is added along with all directories needed. <a href="#37a3faad6fb11f5e851e243fcdcce35b"></a><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_1CiffHeader.html#df8b6992c401ceaec304176289e95af7">remove</a> (uint16_t crwTagId, uint16_t crwDir)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Remove entry <em>crwTagId</em> in directory <em>crwDir</em> from the parse tree. If it's the last entry in the directory, the directory is removed as well, etc. <a href="#df8b6992c401ceaec304176289e95af7"></a><br></td></tr>
<tr><td colspan="2"><div class="groupHeader">Accessors</div></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classExiv2_1_1CiffHeader.html#0708d4c36aac75709054afd1cb8cad5a">write</a> (<a class="el" href="namespaceExiv2.html#6e7b9a2ef47caec919b15f1ae6ff4872">Blob</a> &blob) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Write the Crw image to the binary image <em>blob</em>, starting with the Ciff header. This method appends to the blob. <a href="#0708d4c36aac75709054afd1cb8cad5a"></a><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_1CiffHeader.html#98764fd1b90132375144cba10a7d7d75">decode</a> (<a class="el" href="classExiv2_1_1Image.html">Image</a> &image) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Decode the Crw image and add it to <em>image</em>. <a href="#98764fd1b90132375144cba10a7d7d75"></a><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_1CiffHeader.html#9729b73a3420cd7754cc58d7ad184f76">print</a> (std::ostream &os, const std::string &prefix="") const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Print debug info for the Crw image to <em>os</em>. <a href="#9729b73a3420cd7754cc58d7ad184f76"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="f1134888f9bf0f1d1360011ab57b6d6f"></a><!-- doxytag: member="Exiv2::CiffHeader::byteOrder" ref="f1134888f9bf0f1d1360011ab57b6d6f" args="() const " -->
<a class="el" href="namespaceExiv2.html#94c225faf6d6c611a3828fae1c28efa6">ByteOrder</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classExiv2_1_1CiffHeader.html#f1134888f9bf0f1d1360011ab57b6d6f">byteOrder</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return the byte order (little or big endian). <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="208d02df3ba5af2a381d8b7df2dd04d3"></a><!-- doxytag: member="Exiv2::CiffHeader::findComponent" ref="208d02df3ba5af2a381d8b7df2dd04d3" args="(uint16_t crwTagId, uint16_t crwDir) const " -->
<a class="el" href="classExiv2_1_1CiffComponent.html">CiffComponent</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classExiv2_1_1CiffHeader.html#208d02df3ba5af2a381d8b7df2dd04d3">findComponent</a> (uint16_t crwTagId, uint16_t crwDir) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Finds <em>crwTagId</em> in directory <em>crwDir</em>, returning a pointer to the component or 0 if not found. <br></td></tr>
<tr><td colspan="2"><br><h2>Static Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="95b2101194d717f303304c86f9baa195"></a><!-- doxytag: member="Exiv2::CiffHeader::signature" ref="95b2101194d717f303304c86f9baa195" args="()" -->
static const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="classExiv2_1_1CiffHeader.html#95b2101194d717f303304c86f9baa195">signature</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return a pointer to the Canon Crw signature. <br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
This class models the header of a Crw (Canon Raw data) image. It is the head of a CIFF parse tree, consisting of <a class="el" href="classExiv2_1_1CiffDirectory.html">CiffDirectory</a> and <a class="el" href="classExiv2_1_1CiffEntry.html">CiffEntry</a> objects. Most of its methods will walk the parse tree to perform the requested action.
<p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="37a3faad6fb11f5e851e243fcdcce35b"></a><!-- doxytag: member="Exiv2::CiffHeader::add" ref="37a3faad6fb11f5e851e243fcdcce35b" args="(uint16_t crwTagId, uint16_t crwDir, DataBuf buf)" --><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::CiffHeader::add </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">uint16_t </td>
<td class="mdname" nowrap> <em>crwTagId</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap>uint16_t </td>
<td class="mdname" nowrap> <em>crwDir</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap><a class="el" href="classExiv2_1_1DataBuf.html">DataBuf</a> </td>
<td class="mdname" nowrap> <em>buf</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>
Set the value of entry <em>crwTagId</em> in directory <em>crwDir</em> to <em>buf</em>. If this tag doesn't exist, it is added along with all directories needed.
<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>crwTagId</em> </td><td><a class="el" href="namespaceExiv2_1_1Tag.html">Tag</a> to be added. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>crwDir</em> </td><td>Parent directory of the tag. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>buf</em> </td><td><a class="el" href="classExiv2_1_1Value.html">Value</a> to be set. </td></tr>
</table>
</dl>
</td>
</tr>
</table>
<a class="anchor" name="98764fd1b90132375144cba10a7d7d75"></a><!-- doxytag: member="Exiv2::CiffHeader::decode" ref="98764fd1b90132375144cba10a7d7d75" args="(Image &image) 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">void Exiv2::CiffHeader::decode </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="classExiv2_1_1Image.html">Image</a> & </td>
<td class="mdname1" valign="top" nowrap> <em>image</em> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap> const</td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Decode the Crw image and add it to <em>image</em>.
<p>
Walk the parse tree and convert CIFF entries to metadata entries which are added to <em>image</em>.<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>image</em> </td><td><a class="el" href="classExiv2_1_1Image.html">Image</a> to add metadata to </td></tr>
</table>
</dl>
</td>
</tr>
</table>
<a class="anchor" name="9729b73a3420cd7754cc58d7ad184f76"></a><!-- doxytag: member="Exiv2::CiffHeader::print" ref="9729b73a3420cd7754cc58d7ad184f76" args="(std::ostream &os, const std::string &prefix="") 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">void Exiv2::CiffHeader::print </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">std::ostream & </td>
<td class="mdname" nowrap> <em>os</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>prefix</em> = <code>""</code></td>
</tr>
<tr>
<td class="md"></td>
<td class="md">) </td>
<td class="md" colspan="2"> const</td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Print debug info for the Crw image to <em>os</em>.
<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>os</em> </td><td>Output stream to write to. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>prefix</em> </td><td>Prefix to be written before each line of output. </td></tr>
</table>
</dl>
</td>
</tr>
</table>
<a class="anchor" name="d5601fd0024c3d91d25486a3877d8fa2"></a><!-- doxytag: member="Exiv2::CiffHeader::read" ref="d5601fd0024c3d91d25486a3877d8fa2" args="(const byte *pData, uint32_t size)" --><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::CiffHeader::read </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">const <a class="el" href="namespaceExiv2.html#16f60a5bd4207fe155f6cf93a15efa72">byte</a> * </td>
<td class="mdname" nowrap> <em>pData</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap>uint32_t </td>
<td class="mdname" nowrap> <em>size</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>
Read the Crw image from a data buffer, starting with the Ciff header.
<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>pData</em> </td><td>Pointer to the data buffer. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>size</em> </td><td>Number of bytes in the data buffer.</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 image cannot be parsed. </td></tr>
</table>
</dl>
</td>
</tr>
</table>
<a class="anchor" name="df8b6992c401ceaec304176289e95af7"></a><!-- doxytag: member="Exiv2::CiffHeader::remove" ref="df8b6992c401ceaec304176289e95af7" args="(uint16_t crwTagId, uint16_t crwDir)" --><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::CiffHeader::remove </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">uint16_t </td>
<td class="mdname" nowrap> <em>crwTagId</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap>uint16_t </td>
<td class="mdname" nowrap> <em>crwDir</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>
Remove entry <em>crwTagId</em> in directory <em>crwDir</em> from the parse tree. If it's the last entry in the directory, the directory is removed as well, etc.
<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>crwTagId</em> </td><td><a class="el" href="namespaceExiv2_1_1Tag.html">Tag</a> id to be removed. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>crwDir</em> </td><td>Parent directory of the tag. </td></tr>
</table>
</dl>
</td>
</tr>
</table>
<a class="anchor" name="0708d4c36aac75709054afd1cb8cad5a"></a><!-- doxytag: member="Exiv2::CiffHeader::write" ref="0708d4c36aac75709054afd1cb8cad5a" args="(Blob &blob) 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">void Exiv2::CiffHeader::write </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="namespaceExiv2.html#6e7b9a2ef47caec919b15f1ae6ff4872">Blob</a> & </td>
<td class="mdname1" valign="top" nowrap> <em>blob</em> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap> const</td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Write the Crw image to the binary image <em>blob</em>, starting with the Ciff header. This method appends to the blob.
<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>blob</em> </td><td>Binary image to add to.</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 image cannot be written. </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="crwimage_8hpp.html">crwimage.hpp</a><li>crwimage.cpp</ul>
<hr size="1"><address style="align: right;"><small>Generated on Fri Jun 2 23:54:51 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>
|