<!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::Internal::TiffHeaderBase Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css">
<link href="doxygen.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.5.9 -->
<div class="navigation" id="top">
<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="annotated.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="annotated.html"><span>Class List</span></a></li>
<li><a href="classes.html"><span>Class Index</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="navpath"><a class="el" href="namespaceExiv2.html">Exiv2</a>::<a class="el" href="namespaceExiv2_1_1Internal.html">Internal</a>::<a class="el" href="classExiv2_1_1Internal_1_1TiffHeaderBase.html">TiffHeaderBase</a>
</div>
</div>
<div class="contents">
<h1>Exiv2::Internal::TiffHeaderBase Class Reference</h1><!-- doxytag: class="Exiv2::Internal::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_int.hpp></code>
<p>
<div class="dynheader">
Inheritance diagram for Exiv2::Internal::TiffHeaderBase:</div>
<div class="dynsection">
<p><center><img src="classExiv2_1_1Internal_1_1TiffHeaderBase__inherit__graph.png" border="0" usemap="#Exiv2_1_1Internal_1_1TiffHeaderBase__inherit__map" alt="Inheritance graph"></center>
<map name="Exiv2_1_1Internal_1_1TiffHeaderBase__inherit__map">
<area shape="rect" id="node3" href="classExiv2_1_1Internal_1_1Cr2Header.html" title="Canon CR2 header structure." alt="" coords="393,5,673,32"><area shape="rect" id="node5" href="classExiv2_1_1Internal_1_1OrfHeader.html" title="Olympus ORF header structure." alt="" coords="393,56,673,83"><area shape="rect" id="node7" href="classExiv2_1_1Internal_1_1Rw2Header.html" title="Panasonic RW2 header structure." alt="" coords="393,107,673,133"><area shape="rect" id="node9" href="classExiv2_1_1Internal_1_1TiffHeader.html" title="Standard TIFF header structure." alt="" coords="388,157,679,184"></map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div>
<p>
<a href="classExiv2_1_1Internal_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">Creators</div></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="7f0305c7aec03206ea8963be88d71f87"></a><!-- doxytag: member="Exiv2::Internal::TiffHeaderBase::TiffHeaderBase" ref="7f0305c7aec03206ea8963be88d71f87" args="(uint16_t tag, uint32_t size, ByteOrder byteOrder, uint32_t offset)" -->
</td><td class="memItemRight" valign="bottom"><a class="el" href="classExiv2_1_1Internal_1_1TiffHeaderBase.html#7f0305c7aec03206ea8963be88d71f87">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="9fefeddfac1b264ef8025bfdb0f75da4"></a><!-- doxytag: member="Exiv2::Internal::TiffHeaderBase::~TiffHeaderBase" ref="9fefeddfac1b264ef8025bfdb0f75da4" args="()=0" -->
virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classExiv2_1_1Internal_1_1TiffHeaderBase.html#9fefeddfac1b264ef8025bfdb0f75da4">~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_1Internal_1_1TiffHeaderBase.html#c6c2b995f17db153877d7a49ad80eaf6">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="#c6c2b995f17db153877d7a49ad80eaf6"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="398480391f75407ba95f80634e244f48"></a><!-- doxytag: member="Exiv2::Internal::TiffHeaderBase::setByteOrder" ref="398480391f75407ba95f80634e244f48" args="(ByteOrder byteOrder)" -->
virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classExiv2_1_1Internal_1_1TiffHeaderBase.html#398480391f75407ba95f80634e244f48">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="e166b455995299494c6015700752c181"></a><!-- doxytag: member="Exiv2::Internal::TiffHeaderBase::setOffset" ref="e166b455995299494c6015700752c181" args="(uint32_t offset)" -->
virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classExiv2_1_1Internal_1_1TiffHeaderBase.html#e166b455995299494c6015700752c181">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 uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classExiv2_1_1Internal_1_1TiffHeaderBase.html#c9b29d3bb6172d8ec7f07d334d943e6e">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="#c9b29d3bb6172d8ec7f07d334d943e6e"></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_1Internal_1_1TiffHeaderBase.html#2a0242356ba661e5700b2e3d9f731a0c">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="#2a0242356ba661e5700b2e3d9f731a0c"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="c1c1215acd731ee3820e01dd682f3a16"></a><!-- doxytag: member="Exiv2::Internal::TiffHeaderBase::byteOrder" ref="c1c1215acd731ee3820e01dd682f3a16" args="() const " -->
virtual <a class="el" href="namespaceExiv2.html#94c225faf6d6c611a3828fae1c28efa6">ByteOrder</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classExiv2_1_1Internal_1_1TiffHeaderBase.html#c1c1215acd731ee3820e01dd682f3a16">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="658a38818e3fc6a4cf4f8457546de7ee"></a><!-- doxytag: member="Exiv2::Internal::TiffHeaderBase::offset" ref="658a38818e3fc6a4cf4f8457546de7ee" args="() const " -->
virtual uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classExiv2_1_1Internal_1_1TiffHeaderBase.html#658a38818e3fc6a4cf4f8457546de7ee">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="cacbfc3677b1e1b5536e58a057699783"></a><!-- doxytag: member="Exiv2::Internal::TiffHeaderBase::size" ref="cacbfc3677b1e1b5536e58a057699783" args="() const " -->
virtual uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classExiv2_1_1Internal_1_1TiffHeaderBase.html#cacbfc3677b1e1b5536e58a057699783">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="678caad2e48b63ca9052eafc0d459515"></a><!-- doxytag: member="Exiv2::Internal::TiffHeaderBase::tag" ref="678caad2e48b63ca9052eafc0d459515" args="() const " -->
virtual uint16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classExiv2_1_1Internal_1_1TiffHeaderBase.html#678caad2e48b63ca9052eafc0d459515">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="2a0242356ba661e5700b2e3d9f731a0c"></a><!-- doxytag: member="Exiv2::Internal::TiffHeaderBase::print" ref="2a0242356ba661e5700b2e3d9f731a0c" args="(std::ostream &os, const std::string &prefix="") const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Exiv2::Internal::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> 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>
<a class="anchor" name="c6c2b995f17db153877d7a49ad80eaf6"></a><!-- doxytag: member="Exiv2::Internal::TiffHeaderBase::read" ref="c6c2b995f17db153877d7a49ad80eaf6" args="(const byte *pData, uint32_t size)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool Exiv2::Internal::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><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>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>True if the TIFF header was read successfully. False if the data buffer does not contain a valid TIFF header. </dd></dl>
<p>Reimplemented in <a class="el" href="classExiv2_1_1Internal_1_1Cr2Header.html#ae1f8edc05a5fab9ef139db87cea36a2">Exiv2::Internal::Cr2Header</a>, and <a class="el" href="classExiv2_1_1Internal_1_1OrfHeader.html#2933bb0b87bbf1038a9aeb8f70d49ddb">Exiv2::Internal::OrfHeader</a>.</p>
<p>References <a class="el" href="types_8cpp_source.html#l00191">Exiv2::getULong()</a>, and <a class="el" href="types_8cpp_source.html#l00181">Exiv2::getUShort()</a>.</p>
</div>
</div><p>
<a class="anchor" name="c9b29d3bb6172d8ec7f07d334d943e6e"></a><!-- doxytag: member="Exiv2::Internal::TiffHeaderBase::write" ref="c9b29d3bb6172d8ec7f07d334d943e6e" args="(Blob &blob) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint32_t Exiv2::Internal::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> 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 class="return" compact><dt><b>Returns:</b></dt><dd>Number of bytes written. </dd></dl>
<p>Reimplemented in <a class="el" href="classExiv2_1_1Internal_1_1Cr2Header.html#02ebc1abe81929a1df1b2a4daec61daf">Exiv2::Internal::Cr2Header</a>, <a class="el" href="classExiv2_1_1Internal_1_1OrfHeader.html#4534166e7560cc92123e8a02bb35fcb9">Exiv2::Internal::OrfHeader</a>, and <a class="el" href="classExiv2_1_1Internal_1_1Rw2Header.html#65822bf09a42292644252e041f4e256a">Exiv2::Internal::Rw2Header</a>.</p>
<p>References <a class="el" href="image_8cpp_source.html#l00372">Exiv2::append()</a>, <a class="el" href="types_8cpp_source.html#l00252">Exiv2::ul2Data()</a>, and <a class="el" href="types_8cpp_source.html#l00239">Exiv2::us2Data()</a>.</p>
<p>Referenced by <a class="el" href="tiffimage_8cpp_source.html#l00742">Exiv2::Internal::TiffParserWorker::encode()</a>.</p>
</div>
</div><p>
<hr>The documentation for this class was generated from the following files:<ul>
<li><a class="el" href="tiffimage__int_8hpp.html">tiffimage_int.hpp</a><li>tiffimage.cpp</ul>
</div>
<hr size="1"><address style="text-align: right;"><small>Generated on Thu Jun 25 15:18:16 2009 for Exiv2 by
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.9 </small></address>
</body>
</html>
