File: classExiv2_1_1TiffHeader.html

package info (click to toggle)
exiv2 0.10-1.4
  • links: PTS
  • area: main
  • in suites: etch-m68k
  • size: 13,124 kB
  • ctags: 5,665
  • sloc: cpp: 20,697; xml: 15,118; sh: 10,526; ansic: 1,887; makefile: 367; awk: 64; python: 36
file content (111 lines) | stat: -rw-r--r-- 8,182 bytes parent folder | download | duplicates (2)
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
<!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::TiffHeader 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&nbsp;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&nbsp;List</span></a></li>
    <li><a href="annotated.html"><span>Class&nbsp;List</span></a></li>
    <li><a href="hierarchy.html"><span>Class&nbsp;Hierarchy</span></a></li>
    <li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
  </ul></div>
<div class="nav">
<a class="el" href="namespaceExiv2.html">Exiv2</a>::<a class="el" href="classExiv2_1_1TiffHeader.html">TiffHeader</a></div>
<h1>Exiv2::TiffHeader Class Reference</h1><!-- doxytag: class="Exiv2::TiffHeader" -->Helper class modelling the TIFF header structure.  
<a href="#_details">More...</a>
<p>
<code>#include &lt;image.hpp&gt;</code>
<p>
<a href="classExiv2_1_1TiffHeader-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="4e418d0084dc7e581712698c941fbe1a"></a><!-- doxytag: member="Exiv2::TiffHeader::TiffHeader" ref="4e418d0084dc7e581712698c941fbe1a" args="(ByteOrder byteOrder=littleEndian)" -->
&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classExiv2_1_1TiffHeader.html#4e418d0084dc7e581712698c941fbe1a">TiffHeader</a> (<a class="el" href="namespaceExiv2.html#94c225faf6d6c611a3828fae1c28efa6">ByteOrder</a> byteOrder=littleEndian)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Default constructor. Optionally sets the byte order (default: little endian). <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="585fd7e6a5a1bdc5b090fff5a64f563d"></a><!-- doxytag: member="Exiv2::TiffHeader::read" ref="585fd7e6a5a1bdc5b090fff5a64f563d" args="(const byte *buf)" -->
int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classExiv2_1_1TiffHeader.html#585fd7e6a5a1bdc5b090fff5a64f563d">read</a> (const <a class="el" href="namespaceExiv2.html#16f60a5bd4207fe155f6cf93a15efa72">byte</a> *buf)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Read the TIFF header from a data buffer. Returns 0 if successful. <br></td></tr>
<tr><td colspan="2"><div class="groupHeader">Accessors</div></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">long&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classExiv2_1_1TiffHeader.html#f7c9376cff555c581717b92719a81a4e">copy</a> (<a class="el" href="namespaceExiv2.html#16f60a5bd4207fe155f6cf93a15efa72">byte</a> *buf) const </td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Write a standard TIFF header into buf as a data string, return number of bytes copied.  <a href="#f7c9376cff555c581717b92719a81a4e"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="78d52c6cd35d8130b85a8eea0be7bfeb"></a><!-- doxytag: member="Exiv2::TiffHeader::size" ref="78d52c6cd35d8130b85a8eea0be7bfeb" args="() const " -->
long&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classExiv2_1_1TiffHeader.html#78d52c6cd35d8130b85a8eea0be7bfeb">size</a> () const </td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Return the size of the TIFF header in bytes. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="0f28bd56514cc53140966fadbe3c6446"></a><!-- doxytag: member="Exiv2::TiffHeader::byteOrder" ref="0f28bd56514cc53140966fadbe3c6446" args="() const " -->
<a class="el" href="namespaceExiv2.html#94c225faf6d6c611a3828fae1c28efa6">ByteOrder</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classExiv2_1_1TiffHeader.html#0f28bd56514cc53140966fadbe3c6446">byteOrder</a> () const </td></tr>

<tr><td class="mdescLeft">&nbsp;</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="991e3525541ed71a1b7c36449b03332f"></a><!-- doxytag: member="Exiv2::TiffHeader::tag" ref="991e3525541ed71a1b7c36449b03332f" args="() const " -->
uint16_t&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classExiv2_1_1TiffHeader.html#991e3525541ed71a1b7c36449b03332f">tag</a> () const </td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Return the tag value. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a332dd522b2c7ff21948ff079f0855a4"></a><!-- doxytag: member="Exiv2::TiffHeader::offset" ref="a332dd522b2c7ff21948ff079f0855a4" args="() const " -->
uint32_t&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classExiv2_1_1TiffHeader.html#a332dd522b2c7ff21948ff079f0855a4">offset</a> () const </td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Return the offset to IFD0 from the start of the TIFF header. The offset is 0x00000008 if IFD0 begins immediately after the TIFF header. <br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
Helper class modelling the TIFF header structure. 
<p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="f7c9376cff555c581717b92719a81a4e"></a><!-- doxytag: member="Exiv2::TiffHeader::copy" ref="f7c9376cff555c581717b92719a81a4e" args="(byte *buf) 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">long Exiv2::TiffHeader::copy           </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top"><a class="el" href="namespaceExiv2.html#16f60a5bd4207fe155f6cf93a15efa72">byte</a> *&nbsp;</td>
          <td class="mdname1" valign="top" nowrap> <em>buf</em>          </td>
          <td class="md" valign="top">&nbsp;)&nbsp;</td>
          <td class="md" nowrap> const</td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Write a standard TIFF header into buf as a data string, return number of bytes copied. 
<p>
Only the byte order of the TIFF header varies, the values written for offset and tag are constant, i.e., independent of the values possibly read before a call to this function. The value 0x00000008 is written for the offset, tag is set to 0x002a.<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>buf</em>&nbsp;</td><td>The data buffer to write to. </td></tr>
  </table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>The number of bytes written. </dd></dl>
    </td>
  </tr>
</table>
<hr>The documentation for this class was generated from the following files:<ul>
<li><a class="el" href="image_8hpp.html">image.hpp</a><li>image.cpp</ul>
<hr size="1"><address style="align: right;"><small>Generated on Fri Jun 2 23:54:59 2006 for Exiv2 by&nbsp;
<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>