File: classExiv2_1_1DataBuf.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 (101 lines) | stat: -rw-r--r-- 11,087 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
 
<!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::DataBuf 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_1DataBuf.html">DataBuf</a></div>
<h1>Exiv2::DataBuf Class Reference</h1><!-- doxytag: class="Exiv2::DataBuf" -->Utility class containing a character array. All it does is to take care of memory allocation and deletion. Its primary use is meant to be as a stack variable in functions that need a temporary data buffer. Todo: this should be some sort of smart pointer, essentially an std::auto_ptr for a character array. But it isn't...  
<a href="#_details">More...</a>
<p>
<code>#include &lt;types.hpp&gt;</code>
<p>
<a href="classExiv2_1_1DataBuf-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="7acbb6dd1dc8ba1cfded52cafffe1da9"></a><!-- doxytag: member="Exiv2::DataBuf::DataBuf" ref="7acbb6dd1dc8ba1cfded52cafffe1da9" args="()" -->
&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classExiv2_1_1DataBuf.html#7acbb6dd1dc8ba1cfded52cafffe1da9">DataBuf</a> ()</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Default constructor. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a7f5e919eddab5d8623cebbc6af91328"></a><!-- doxytag: member="Exiv2::DataBuf::DataBuf" ref="a7f5e919eddab5d8623cebbc6af91328" args="(long size)" -->
&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classExiv2_1_1DataBuf.html#a7f5e919eddab5d8623cebbc6af91328">DataBuf</a> (long size)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Constructor with an initial buffer size. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a0a63b749954741d5516dd58265b2e5c"></a><!-- doxytag: member="Exiv2::DataBuf::DataBuf" ref="a0a63b749954741d5516dd58265b2e5c" args="(const byte *pData, long size)" -->
&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classExiv2_1_1DataBuf.html#a0a63b749954741d5516dd58265b2e5c">DataBuf</a> (const <a class="el" href="namespaceExiv2.html#16f60a5bd4207fe155f6cf93a15efa72">byte</a> *pData, long size)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Constructor, copies an existing buffer. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="f94cfd1ae0f844d5facfb93a0d0a061e"></a><!-- doxytag: member="Exiv2::DataBuf::DataBuf" ref="f94cfd1ae0f844d5facfb93a0d0a061e" args="(DataBuf &amp;rhs)" -->
&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classExiv2_1_1DataBuf.html#f94cfd1ae0f844d5facfb93a0d0a061e">DataBuf</a> (<a class="el" href="classExiv2_1_1DataBuf.html">DataBuf</a> &amp;rhs)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Copy constructor. Transfers the buffer to the newly created object similar to std::auto_ptr, i.e., the original object is modified. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="b5ee5eefc2521158847edeb0ff12ac6c"></a><!-- doxytag: member="Exiv2::DataBuf::~DataBuf" ref="b5ee5eefc2521158847edeb0ff12ac6c" args="()" -->
&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classExiv2_1_1DataBuf.html#b5ee5eefc2521158847edeb0ff12ac6c">~DataBuf</a> ()</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Destructor, deletes the allocated buffer. <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="064e231bd57cea71fdee957a1dac3ab5"></a><!-- doxytag: member="Exiv2::DataBuf::operator=" ref="064e231bd57cea71fdee957a1dac3ab5" args="(DataBuf &amp;rhs)" -->
<a class="el" href="classExiv2_1_1DataBuf.html">DataBuf</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classExiv2_1_1DataBuf.html#064e231bd57cea71fdee957a1dac3ab5">operator=</a> (<a class="el" href="classExiv2_1_1DataBuf.html">DataBuf</a> &amp;rhs)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Assignment operator. Transfers the buffer and releases the buffer at the original object similar to std::auto_ptr, i.e., the original object is modified. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="be06b478dee2d020c4bde3f974bdeb90"></a><!-- doxytag: member="Exiv2::DataBuf::alloc" ref="be06b478dee2d020c4bde3f974bdeb90" args="(long size)" -->
void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classExiv2_1_1DataBuf.html#be06b478dee2d020c4bde3f974bdeb90">alloc</a> (long size)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Allocate a data buffer of the given size. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="2fb958d6820e3790d14ab143159f50b2"></a><!-- doxytag: member="Exiv2::DataBuf::release" ref="2fb958d6820e3790d14ab143159f50b2" args="()" -->
std::pair&lt; <a class="el" href="namespaceExiv2.html#16f60a5bd4207fe155f6cf93a15efa72">byte</a> *, long &gt;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classExiv2_1_1DataBuf.html#2fb958d6820e3790d14ab143159f50b2">release</a> ()</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Release ownership of the buffer to the caller. Returns the buffer as a data pointer and size pair, resets the internal buffer. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="c553cc3082d217d4b139dfca83602076"></a><!-- doxytag: member="Exiv2::DataBuf::reset" ref="c553cc3082d217d4b139dfca83602076" args="(std::pair&lt; byte *, long &gt;=std::make_pair((byte *)(0), long(0)))" -->
void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classExiv2_1_1DataBuf.html#c553cc3082d217d4b139dfca83602076">reset</a> (std::pair&lt; <a class="el" href="namespaceExiv2.html#16f60a5bd4207fe155f6cf93a15efa72">byte</a> *, long &gt;=std::make_pair((<a class="el" href="namespaceExiv2.html#16f60a5bd4207fe155f6cf93a15efa72">byte</a> *)(0), long(0)))</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Reset value. <br></td></tr>
<tr><td colspan="2"><div class="groupHeader">Conversions</div></td></tr>
<tr><td colspan="2"><div class="groupText">Special conversions with auxiliary type to enable copies and assignments, similar to those used for std::auto_ptr. See <a href="http://www.josuttis.com/libbook/auto_ptr.html">http://www.josuttis.com/libbook/auto_ptr.html</a> for a discussion. <br><br></div></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="49057ada097161d6863bdfdcce8f06d5"></a><!-- doxytag: member="Exiv2::DataBuf::DataBuf" ref="49057ada097161d6863bdfdcce8f06d5" args="(DataBufRef rhs)" -->
&nbsp;</td><td class="memItemRight" valign="bottom"><b>DataBuf</b> (<a class="el" href="structExiv2_1_1DataBufRef.html">DataBufRef</a> rhs)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="eef26ca96f18232a773b4b52e919c5cd"></a><!-- doxytag: member="Exiv2::DataBuf::operator=" ref="eef26ca96f18232a773b4b52e919c5cd" args="(DataBufRef rhs)" -->
<a class="el" href="classExiv2_1_1DataBuf.html">DataBuf</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><b>operator=</b> (<a class="el" href="structExiv2_1_1DataBufRef.html">DataBufRef</a> rhs)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="018caf9c4407860f8dbc27b40b2af426"></a><!-- doxytag: member="Exiv2::DataBuf::operator DataBufRef" ref="018caf9c4407860f8dbc27b40b2af426" args="()" -->
&nbsp;</td><td class="memItemRight" valign="bottom"><b>operator DataBufRef</b> ()</td></tr>

<tr><td colspan="2"><br><h2>Public Attributes</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="9a00173081c913d3add58854d9ad2c39"></a><!-- doxytag: member="Exiv2::DataBuf::pData_" ref="9a00173081c913d3add58854d9ad2c39" args="" -->
<a class="el" href="namespaceExiv2.html#16f60a5bd4207fe155f6cf93a15efa72">byte</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classExiv2_1_1DataBuf.html#9a00173081c913d3add58854d9ad2c39">pData_</a></td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Pointer to the buffer, 0 if none has been allocated. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="5e6028d5cdae2e149749667cf66c3e91"></a><!-- doxytag: member="Exiv2::DataBuf::size_" ref="5e6028d5cdae2e149749667cf66c3e91" args="" -->
long&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classExiv2_1_1DataBuf.html#5e6028d5cdae2e149749667cf66c3e91">size_</a></td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The current size of the buffer. <br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
Utility class containing a character array. All it does is to take care of memory allocation and deletion. Its primary use is meant to be as a stack variable in functions that need a temporary data buffer. Todo: this should be some sort of smart pointer, essentially an std::auto_ptr for a character array. But it isn't... 
<p>
<hr>The documentation for this class was generated from the following files:<ul>
<li><a class="el" href="types_8hpp.html">types.hpp</a><li>types.cpp</ul>
<hr size="1"><address style="align: right;"><small>Generated on Fri Jun 2 23:55:37 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>