<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> <html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8"> <title>Exiv2: Exiv2::TiffHeaderBase 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.5.4 --> <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 class="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> <li> <form action="search.php" method="get"> <table cellspacing="0" cellpadding="0" border="0"> <tr> <td><label> <u>S</u>earch for </label></td> <td><input type="text" name="query" value="" size="20" accesskey="s"/></td> </tr> </table> </form> </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_1TiffHeaderBase.html">TiffHeaderBase</a></div> <h1>Exiv2::TiffHeaderBase Class Reference</h1><!-- doxytag: class="Exiv2::TiffHeaderBase" -->Abstract base class defining the interface of an image header. Used internally by classes for TIFF-based images. Default implementation is for the regular TIFF header. <a href="#_details">More...</a> <p> <code>#include <tiffimage.hpp></code> <p> <div class="dynheader"> Inheritance diagram for Exiv2::TiffHeaderBase:</div> <div class="dynsection"> <p><center><img src="classExiv2_1_1TiffHeaderBase__inherit__graph.png" border="0" usemap="#Exiv2_1_1TiffHeaderBase__inherit__map" alt="Inheritance graph"></center> <map name="Exiv2_1_1TiffHeaderBase__inherit__map"> <area shape="rect" href="classExiv2_1_1Cr2Header.html" title="Canon CR2 header structure." alt="" coords="5,81,187,105"><area shape="rect" href="classExiv2_1_1OrfHeader.html" title="Olympus ORF header structure." alt="" coords="211,81,392,105"><area shape="rect" href="classExiv2_1_1TiffHeade2.html" title="Standard TIFF header structure." alt="" coords="416,81,608,105"></map> <center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div> <p> <a href="classExiv2_1_1TiffHeaderBase-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">Constructors</div></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="aaafc306cfb85263006a0b98aeb4478f"></a><!-- doxytag: member="Exiv2::TiffHeaderBase::TiffHeaderBase" ref="aaafc306cfb85263006a0b98aeb4478f" args="(uint16_t tag, uint32_t size, ByteOrder byteOrder, uint32_t offset)" --> </td><td class="memItemRight" valign="bottom"><a class="el" href="classExiv2_1_1TiffHeaderBase.html#aaafc306cfb85263006a0b98aeb4478f">TiffHeaderBase</a> (uint16_t tag, uint32_t size, <a class="el" href="namespaceExiv2.html#94c225faf6d6c611a3828fae1c28efa6">ByteOrder</a> byteOrder, uint32_t offset)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Constructor taking <em>tag</em>, <em>size</em> and default <em>byteOrder</em> and <em>offset</em>. <br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a077e73b502b8d0da95856fcb0073b82"></a><!-- doxytag: member="Exiv2::TiffHeaderBase::~TiffHeaderBase" ref="a077e73b502b8d0da95856fcb0073b82" args="()=0" --> virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classExiv2_1_1TiffHeaderBase.html#a077e73b502b8d0da95856fcb0073b82">~TiffHeaderBase</a> ()=0</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">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classExiv2_1_1TiffHeaderBase.html#079d64e27adfe8af0262bbb8b2ec0d66">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 image header from a data buffer. Return false if the data buffer does not contain an image header of the expected format, else true. <a href="#079d64e27adfe8af0262bbb8b2ec0d66"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="6f066cb8546499beeff37dfb3b50db32"></a><!-- doxytag: member="Exiv2::TiffHeaderBase::setByteOrder" ref="6f066cb8546499beeff37dfb3b50db32" args="(ByteOrder byteOrder)" --> virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classExiv2_1_1TiffHeaderBase.html#6f066cb8546499beeff37dfb3b50db32">setByteOrder</a> (<a class="el" href="namespaceExiv2.html#94c225faf6d6c611a3828fae1c28efa6">ByteOrder</a> byteOrder)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Set the byte order. <br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="c8d7f07def291d1679b0129a622f99e1"></a><!-- doxytag: member="Exiv2::TiffHeaderBase::setOffset" ref="c8d7f07def291d1679b0129a622f99e1" args="(uint32_t offset)" --> virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classExiv2_1_1TiffHeaderBase.html#c8d7f07def291d1679b0129a622f99e1">setOffset</a> (uint32_t offset)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Set the offset to the start of the root directory. <br></td></tr> <tr><td colspan="2"><div class="groupHeader">Accessors</div></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classExiv2_1_1TiffHeaderBase.html#c5379d2c4150760ab0424804a659c034">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 image header to the binary image <em>blob</em>. This method appends to the blob. <a href="#c5379d2c4150760ab0424804a659c034"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classExiv2_1_1TiffHeaderBase.html#6fb9cae3e8d8c9b8c2a02d757c189846">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 image header to <em>os</em>. <a href="#6fb9cae3e8d8c9b8c2a02d757c189846"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="9ceb9b21536daa3961150b8377fb35d9"></a><!-- doxytag: member="Exiv2::TiffHeaderBase::byteOrder" ref="9ceb9b21536daa3961150b8377fb35d9" args="() const " --> virtual <a class="el" href="namespaceExiv2.html#94c225faf6d6c611a3828fae1c28efa6">ByteOrder</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classExiv2_1_1TiffHeaderBase.html#9ceb9b21536daa3961150b8377fb35d9">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="cc6cb95452cc74e6e8e4ef5c8704ca75"></a><!-- doxytag: member="Exiv2::TiffHeaderBase::offset" ref="cc6cb95452cc74e6e8e4ef5c8704ca75" args="() const " --> virtual uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classExiv2_1_1TiffHeaderBase.html#cc6cb95452cc74e6e8e4ef5c8704ca75">offset</a> () const </td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Return the offset to the start of the root directory. <br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="68b3965504f78c8b8ee68711e74bd432"></a><!-- doxytag: member="Exiv2::TiffHeaderBase::size" ref="68b3965504f78c8b8ee68711e74bd432" args="() const " --> virtual uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classExiv2_1_1TiffHeaderBase.html#68b3965504f78c8b8ee68711e74bd432">size</a> () const </td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Return the size (in bytes) of the image header. <br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="69268d4107f733a26885a335a5cff9e6"></a><!-- doxytag: member="Exiv2::TiffHeaderBase::tag" ref="69268d4107f733a26885a335a5cff9e6" args="() const " --> virtual uint16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classExiv2_1_1TiffHeaderBase.html#69268d4107f733a26885a335a5cff9e6">tag</a> () const </td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Return the tag value (magic number) which identifies the buffer as TIFF data. <br></td></tr> </table> <hr><a name="_details"></a><h2>Detailed Description</h2> Abstract base class defining the interface of an image header. Used internally by classes for TIFF-based images. Default implementation is for the regular TIFF header. <hr><h2>Member Function Documentation</h2> <a class="anchor" name="079d64e27adfe8af0262bbb8b2ec0d66"></a><!-- doxytag: member="Exiv2::TiffHeaderBase::read" ref="079d64e27adfe8af0262bbb8b2ec0d66" args="(const byte *pData, uint32_t size)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">virtual bool Exiv2::TiffHeaderBase::read </td> <td>(</td> <td class="paramtype">const <a class="el" href="namespaceExiv2.html#16f60a5bd4207fe155f6cf93a15efa72">byte</a> * </td> <td class="paramname"> <em>pData</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">uint32_t </td> <td class="paramname"> <em>size</em></td><td> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td><td width="100%"><code> [virtual]</code></td> </tr> </table> </div> <div class="memdoc"> <p> Read the image header from a data buffer. Return false if the data buffer does not contain an image header of the expected format, else true. <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> <p>Reimplemented in <a class="el" href="classExiv2_1_1Cr2Header.html#42264154efe7ae61a47276a5eb2e366d">Exiv2::Cr2Header</a>, and <a class="el" href="classExiv2_1_1OrfHeader.html#37cbc9902d1ecffc953833d201a0222e">Exiv2::OrfHeader</a>.</p> </div> </div><p> <a class="anchor" name="c5379d2c4150760ab0424804a659c034"></a><!-- doxytag: member="Exiv2::TiffHeaderBase::write" ref="c5379d2c4150760ab0424804a659c034" args="(Blob &blob) const " --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">virtual void Exiv2::TiffHeaderBase::write </td> <td>(</td> <td class="paramtype"><a class="el" href="namespaceExiv2.html#6e7b9a2ef47caec919b15f1ae6ff4872">Blob</a> & </td> <td class="paramname"> <em>blob</em> </td> <td> ) </td> <td width="100%"> const<code> [virtual]</code></td> </tr> </table> </div> <div class="memdoc"> <p> Write the image header to the binary image <em>blob</em>. 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" title="Simple error class used for exceptions. An output operator is provided to print errors...">Error</a></em> </td><td>If the header cannot be written. </td></tr> </table> </dl> <p>Reimplemented in <a class="el" href="classExiv2_1_1Cr2Header.html#9b2dfde37f3917a9d4a93b672337f617">Exiv2::Cr2Header</a>, and <a class="el" href="classExiv2_1_1OrfHeader.html#08e82e2bfbb39ba210fde7241cea6b91">Exiv2::OrfHeader</a>.</p> </div> </div><p> <a class="anchor" name="6fb9cae3e8d8c9b8c2a02d757c189846"></a><!-- doxytag: member="Exiv2::TiffHeaderBase::print" ref="6fb9cae3e8d8c9b8c2a02d757c189846" args="(std::ostream &os, const std::string &prefix="") const " --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">virtual void Exiv2::TiffHeaderBase::print </td> <td>(</td> <td class="paramtype">std::ostream & </td> <td class="paramname"> <em>os</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">const std::string & </td> <td class="paramname"> <em>prefix</em> = <code>""</code></td><td> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td><td width="100%"> const<code> [virtual]</code></td> </tr> </table> </div> <div class="memdoc"> <p> Print debug info for the image header 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> </div> </div><p> <hr>The documentation for this class was generated from the following file:<ul> <li><a class="el" href="tiffimage_8hpp.html">tiffimage.hpp</a></ul> <hr size="1"><address style="text-align: right;"><small>Generated on Tue Feb 5 11:51:12 2008 for Exiv2 by <a href="http://www.doxygen.org/index.html"> <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.4 </small></address> </body> </html>