~ubuntu-branches/ubuntu/precise/exiv2/precise

« back to all changes in this revision

Viewing changes to doc/html/classExiv2_1_1DataBuf.html

  • Committer: Bazaar Package Importer
  • Author(s): Anthony Mercatante
  • Date: 2006-12-07 18:40:10 UTC
  • mfrom: (1.1.2 upstream)
  • Revision ID: james.westby@ubuntu.com-20061207184010-0ouu8v0dr8nznob9
Tags: 0.12-0ubuntu1
New upstream release

Show diffs side-by-side

added added

removed removed

Lines of Context:
4
4
<link href="doxygen.css" rel="stylesheet" type="text/css">
5
5
<link href="tabs.css" rel="stylesheet" type="text/css">
6
6
</head><body>
7
 
<!-- Generated by Doxygen 1.4.6 -->
 
7
<!-- Generated by Doxygen 1.5.1 -->
8
8
<div class="tabs">
9
9
  <ul>
10
10
    <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
12
12
    <li id="current"><a href="classes.html"><span>Classes</span></a></li>
13
13
    <li><a href="files.html"><span>Files</span></a></li>
14
14
    <li><a href="examples.html"><span>Examples</span></a></li>
 
15
    <li>
 
16
      <form action="search.php" method="get">
 
17
        <table cellspacing="0" cellpadding="0" border="0">
 
18
          <tr>
 
19
            <td><label>&nbsp;<u>S</u>earch&nbsp;for&nbsp;</label></td>
 
20
            <td><input type="text" name="query" value="" size="20" accesskey="s"/></td>
 
21
          </tr>
 
22
        </table>
 
23
      </form>
 
24
    </li>
15
25
  </ul></div>
16
26
<div class="tabs">
17
27
  <ul>
29
39
<p>
30
40
<a href="classExiv2_1_1DataBuf-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
31
41
<tr><td></td></tr>
 
42
<tr><td colspan="2"><br><h2>Conversions</h2></td></tr>
 
43
<tr><td colspan="2">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></td></tr>
 
44
<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)" -->
 
45
&nbsp;</td><td class="memItemRight" valign="bottom"><b>DataBuf</b> (<a class="el" href="structExiv2_1_1DataBufRef.html">DataBufRef</a> rhs)</td></tr>
 
46
 
 
47
<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)" -->
 
48
<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>
 
49
 
 
50
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="018caf9c4407860f8dbc27b40b2af426"></a><!-- doxytag: member="Exiv2::DataBuf::operator DataBufRef" ref="018caf9c4407860f8dbc27b40b2af426" args="()" -->
 
51
&nbsp;</td><td class="memItemRight" valign="bottom"><b>operator DataBufRef</b> ()</td></tr>
 
52
 
32
53
<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
33
 
<tr><td colspan="2"><div class="groupHeader">Creators</div></td></tr>
34
 
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="7acbb6dd1dc8ba1cfded52cafffe1da9"></a><!-- doxytag: member="Exiv2::DataBuf::DataBuf" ref="7acbb6dd1dc8ba1cfded52cafffe1da9" args="()" -->
35
 
&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classExiv2_1_1DataBuf.html#7acbb6dd1dc8ba1cfded52cafffe1da9">DataBuf</a> ()</td></tr>
36
 
 
37
 
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Default constructor. <br></td></tr>
38
 
<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)" -->
39
 
&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classExiv2_1_1DataBuf.html#a7f5e919eddab5d8623cebbc6af91328">DataBuf</a> (long size)</td></tr>
40
 
 
41
 
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Constructor with an initial buffer size. <br></td></tr>
42
 
<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)" -->
43
 
&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>
44
 
 
45
 
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Constructor, copies an existing buffer. <br></td></tr>
46
 
<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)" -->
47
 
&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>
48
 
 
49
 
<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>
50
 
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="b5ee5eefc2521158847edeb0ff12ac6c"></a><!-- doxytag: member="Exiv2::DataBuf::~DataBuf" ref="b5ee5eefc2521158847edeb0ff12ac6c" args="()" -->
51
 
&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classExiv2_1_1DataBuf.html#b5ee5eefc2521158847edeb0ff12ac6c">~DataBuf</a> ()</td></tr>
52
 
 
53
 
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Destructor, deletes the allocated buffer. <br></td></tr>
54
54
<tr><td colspan="2"><div class="groupHeader">Manipulators</div></td></tr>
55
 
<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)" -->
56
 
<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>
 
55
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="cd3980c818644f6d50f293536b2f5bb6"></a><!-- doxytag: member="Exiv2::DataBuf::operator=" ref="cd3980c818644f6d50f293536b2f5bb6" args="(DataBuf &amp;rhs)" -->
 
56
<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#cd3980c818644f6d50f293536b2f5bb6">operator=</a> (<a class="el" href="classExiv2_1_1DataBuf.html">DataBuf</a> &amp;rhs)</td></tr>
57
57
 
58
58
<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>
59
59
<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)" -->
60
60
void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classExiv2_1_1DataBuf.html#be06b478dee2d020c4bde3f974bdeb90">alloc</a> (long size)</td></tr>
61
61
 
62
62
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Allocate a data buffer of the given size. <br></td></tr>
63
 
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="2fb958d6820e3790d14ab143159f50b2"></a><!-- doxytag: member="Exiv2::DataBuf::release" ref="2fb958d6820e3790d14ab143159f50b2" args="()" -->
64
 
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>
 
63
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="eb81cc1d2285d6259aea6c4b90c04bd3"></a><!-- doxytag: member="Exiv2::DataBuf::release" ref="eb81cc1d2285d6259aea6c4b90c04bd3" args="()" -->
 
64
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#eb81cc1d2285d6259aea6c4b90c04bd3">release</a> ()</td></tr>
65
65
 
66
66
<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>
67
67
<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)))" -->
68
68
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>
69
69
 
70
70
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Reset value. <br></td></tr>
71
 
<tr><td colspan="2"><div class="groupHeader">Conversions</div></td></tr>
72
 
<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>
73
 
<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)" -->
74
 
&nbsp;</td><td class="memItemRight" valign="bottom"><b>DataBuf</b> (<a class="el" href="structExiv2_1_1DataBufRef.html">DataBufRef</a> rhs)</td></tr>
75
 
 
76
 
<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)" -->
77
 
<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>
78
 
 
79
 
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="018caf9c4407860f8dbc27b40b2af426"></a><!-- doxytag: member="Exiv2::DataBuf::operator DataBufRef" ref="018caf9c4407860f8dbc27b40b2af426" args="()" -->
80
 
&nbsp;</td><td class="memItemRight" valign="bottom"><b>operator DataBufRef</b> ()</td></tr>
81
 
 
82
71
<tr><td colspan="2"><br><h2>Public Attributes</h2></td></tr>
83
72
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="9a00173081c913d3add58854d9ad2c39"></a><!-- doxytag: member="Exiv2::DataBuf::pData_" ref="9a00173081c913d3add58854d9ad2c39" args="" -->
84
73
<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>
92
81
<hr><a name="_details"></a><h2>Detailed Description</h2>
93
82
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... 
94
83
<p>
95
 
<hr>The documentation for this class was generated from the following files:<ul>
96
 
<li><a class="el" href="types_8hpp.html">types.hpp</a><li>types.cpp</ul>
97
 
<hr size="1"><address style="align: right;"><small>Generated on Fri Jun 2 23:55:37 2006 for Exiv2 by&nbsp;
 
84
<hr>The documentation for this class was generated from the following file:<ul>
 
85
<li><a class="el" href="types_8hpp.html">types.hpp</a></ul>
 
86
<hr size="1"><address style="align: right;"><small>Generated on Mon Nov 27 20:16:37 2006 for Exiv2 by&nbsp;
98
87
<a href="http://www.doxygen.org/index.html">
99
 
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.6 </small></address>
 
88
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.1 </small></address>
100
89
</body>
101
90
</html>