<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.8"/>
<title>Exiv2: Exiv2::BasicIo Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
$(document).ready(function() { searchBox.OnSelectItem(0); });
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">Exiv2
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.8 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<div id="navrow1" class="tabs">
<ul class="tablist">
<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>
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</span>
</div>
</li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<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="inherits.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class Members</span></a></li>
</ul>
</div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark"> </span>Friends</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(10)"><span class="SelectionMark"> </span>Macros</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(11)"><span class="SelectionMark"> </span>Pages</a></div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="namespaceExiv2.html">Exiv2</a></li><li class="navelem"><a class="el" href="classExiv2_1_1BasicIo.html">BasicIo</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-types">Public Types</a> |
<a href="classExiv2_1_1BasicIo-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">Exiv2::BasicIo Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div> </div>
</div><!--header-->
<div class="contents">
<p>An interface for simple binary IO.
<a href="classExiv2_1_1BasicIo.html#details">More...</a></p>
<p><code>#include <basicio.hpp></code></p>
<div id="dynsection-0" onclick="return toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;">
<img id="dynsection-0-trigger" src="closed.png" alt="+"/> Inheritance diagram for Exiv2::BasicIo:</div>
<div id="dynsection-0-summary" class="dynsummary" style="display:block;">
</div>
<div id="dynsection-0-content" class="dyncontent" style="display:none;">
<div class="center"><img src="classExiv2_1_1BasicIo__inherit__graph.png" border="0" usemap="#Exiv2_1_1BasicIo_inherit__map" alt="Inheritance graph"/></div>
<map name="Exiv2_1_1BasicIo_inherit__map" id="Exiv2_1_1BasicIo_inherit__map">
<area shape="rect" id="node2" href="classExiv2_1_1FileIo.html" title="Provides binary file IO by implementing the BasicIo interface. " alt="" coords="5,80,157,107"/><area shape="rect" id="node3" href="classExiv2_1_1MemIo.html" title="Provides binary IO on blocks of memory by implementing the BasicIo interface. A copy-on-write impleme..." alt="" coords="182,80,325,107"/></map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-types"></a>
Public Types</h2></td></tr>
<tr class="memitem:a1d23c3bf7618f2ee6ebb5cf033b10911"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a1d23c3bf7618f2ee6ebb5cf033b10911"></a>enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="classExiv2_1_1BasicIo.html#a1d23c3bf7618f2ee6ebb5cf033b10911">Position</a> { <b>beg</b>,
<b>cur</b>,
<b>end</b>
}</td></tr>
<tr class="memdesc:a1d23c3bf7618f2ee6ebb5cf033b10911"><td class="mdescLeft"> </td><td class="mdescRight">Seek starting positions. <br /></td></tr>
<tr class="separator:a1d23c3bf7618f2ee6ebb5cf033b10911"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:af8f989522925b884d8c9d3a257265fa1"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="af8f989522925b884d8c9d3a257265fa1"></a>
typedef std::auto_ptr< <a class="el" href="classExiv2_1_1BasicIo.html">BasicIo</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classExiv2_1_1BasicIo.html#af8f989522925b884d8c9d3a257265fa1">AutoPtr</a></td></tr>
<tr class="memdesc:af8f989522925b884d8c9d3a257265fa1"><td class="mdescLeft"> </td><td class="mdescRight"><a class="el" href="classExiv2_1_1BasicIo.html" title="An interface for simple binary IO. ">BasicIo</a> auto_ptr type. <br /></td></tr>
<tr class="separator:af8f989522925b884d8c9d3a257265fa1"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr><td colspan="2"><div class="groupHeader">Manipulators</div></td></tr>
<tr class="memitem:a1beff0dcdf03510bad13b6946379c5f2"><td class="memItemLeft" align="right" valign="top">virtual int </td><td class="memItemRight" valign="bottom"><a class="el" href="classExiv2_1_1BasicIo.html#a1beff0dcdf03510bad13b6946379c5f2">open</a> ()=0</td></tr>
<tr class="memdesc:a1beff0dcdf03510bad13b6946379c5f2"><td class="mdescLeft"> </td><td class="mdescRight">Open the IO source using the default access mode. The default mode should allow for reading and writing. <a href="#a1beff0dcdf03510bad13b6946379c5f2">More...</a><br /></td></tr>
<tr class="separator:a1beff0dcdf03510bad13b6946379c5f2"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a67ae3ca0f8aece92a7b7749dfb02edde"><td class="memItemLeft" align="right" valign="top">virtual int </td><td class="memItemRight" valign="bottom"><a class="el" href="classExiv2_1_1BasicIo.html#a67ae3ca0f8aece92a7b7749dfb02edde">close</a> ()=0</td></tr>
<tr class="memdesc:a67ae3ca0f8aece92a7b7749dfb02edde"><td class="mdescLeft"> </td><td class="mdescRight">Close the IO source. After closing a <a class="el" href="classExiv2_1_1BasicIo.html" title="An interface for simple binary IO. ">BasicIo</a> instance can not be read or written. Closing flushes any unwritten data. It is safe to call close on a closed instance. <a href="#a67ae3ca0f8aece92a7b7749dfb02edde">More...</a><br /></td></tr>
<tr class="separator:a67ae3ca0f8aece92a7b7749dfb02edde"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ac548d52ef633ac425bd01d17ccd2e7e4"><td class="memItemLeft" align="right" valign="top">virtual long </td><td class="memItemRight" valign="bottom"><a class="el" href="classExiv2_1_1BasicIo.html#ac548d52ef633ac425bd01d17ccd2e7e4">write</a> (const <a class="el" href="namespaceExiv2.html#a16f60a5bd4207fe155f6cf93a15efa72">byte</a> *data, long wcount)=0</td></tr>
<tr class="memdesc:ac548d52ef633ac425bd01d17ccd2e7e4"><td class="mdescLeft"> </td><td class="mdescRight">Write data to the IO source. Current IO position is advanced by the number of bytes written. <a href="#ac548d52ef633ac425bd01d17ccd2e7e4">More...</a><br /></td></tr>
<tr class="separator:ac548d52ef633ac425bd01d17ccd2e7e4"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a31334606e230bbe94d6b8768d3c6d75f"><td class="memItemLeft" align="right" valign="top">virtual long </td><td class="memItemRight" valign="bottom"><a class="el" href="classExiv2_1_1BasicIo.html#a31334606e230bbe94d6b8768d3c6d75f">write</a> (<a class="el" href="classExiv2_1_1BasicIo.html">BasicIo</a> &src)=0</td></tr>
<tr class="memdesc:a31334606e230bbe94d6b8768d3c6d75f"><td class="mdescLeft"> </td><td class="mdescRight">Write data that is read from another <a class="el" href="classExiv2_1_1BasicIo.html" title="An interface for simple binary IO. ">BasicIo</a> instance to the IO source. Current IO position is advanced by the number of bytes written. <a href="#a31334606e230bbe94d6b8768d3c6d75f">More...</a><br /></td></tr>
<tr class="separator:a31334606e230bbe94d6b8768d3c6d75f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ad16a1fab0f122c8ca11b86d09b03b9a7"><td class="memItemLeft" align="right" valign="top">virtual int </td><td class="memItemRight" valign="bottom"><a class="el" href="classExiv2_1_1BasicIo.html#ad16a1fab0f122c8ca11b86d09b03b9a7">putb</a> (<a class="el" href="namespaceExiv2.html#a16f60a5bd4207fe155f6cf93a15efa72">byte</a> data)=0</td></tr>
<tr class="memdesc:ad16a1fab0f122c8ca11b86d09b03b9a7"><td class="mdescLeft"> </td><td class="mdescRight">Write one byte to the IO source. Current IO position is advanced by one byte. <a href="#ad16a1fab0f122c8ca11b86d09b03b9a7">More...</a><br /></td></tr>
<tr class="separator:ad16a1fab0f122c8ca11b86d09b03b9a7"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a8c9e6c7377b642afbb2c14a0e3896917"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classExiv2_1_1DataBuf.html">DataBuf</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classExiv2_1_1BasicIo.html#a8c9e6c7377b642afbb2c14a0e3896917">read</a> (long rcount)=0</td></tr>
<tr class="memdesc:a8c9e6c7377b642afbb2c14a0e3896917"><td class="mdescLeft"> </td><td class="mdescRight">Read data from the IO source. Reading starts at the current IO position and the position is advanced by the number of bytes read. <a href="#a8c9e6c7377b642afbb2c14a0e3896917">More...</a><br /></td></tr>
<tr class="separator:a8c9e6c7377b642afbb2c14a0e3896917"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aec8cb20c86e72b87577370a28d66a0ca"><td class="memItemLeft" align="right" valign="top">virtual long </td><td class="memItemRight" valign="bottom"><a class="el" href="classExiv2_1_1BasicIo.html#aec8cb20c86e72b87577370a28d66a0ca">read</a> (<a class="el" href="namespaceExiv2.html#a16f60a5bd4207fe155f6cf93a15efa72">byte</a> *buf, long rcount)=0</td></tr>
<tr class="memdesc:aec8cb20c86e72b87577370a28d66a0ca"><td class="mdescLeft"> </td><td class="mdescRight">Read data from the IO source. Reading starts at the current IO position and the position is advanced by the number of bytes read. <a href="#aec8cb20c86e72b87577370a28d66a0ca">More...</a><br /></td></tr>
<tr class="separator:aec8cb20c86e72b87577370a28d66a0ca"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a648bc0d9b1a79e34684375074d806534"><td class="memItemLeft" align="right" valign="top">virtual int </td><td class="memItemRight" valign="bottom"><a class="el" href="classExiv2_1_1BasicIo.html#a648bc0d9b1a79e34684375074d806534">getb</a> ()=0</td></tr>
<tr class="memdesc:a648bc0d9b1a79e34684375074d806534"><td class="mdescLeft"> </td><td class="mdescRight">Read one byte from the IO source. Current IO position is advanced by one byte. <a href="#a648bc0d9b1a79e34684375074d806534">More...</a><br /></td></tr>
<tr class="separator:a648bc0d9b1a79e34684375074d806534"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:acb964ff603c96da8711baddb66a385a4"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classExiv2_1_1BasicIo.html#acb964ff603c96da8711baddb66a385a4">transfer</a> (<a class="el" href="classExiv2_1_1BasicIo.html">BasicIo</a> &src)=0</td></tr>
<tr class="memdesc:acb964ff603c96da8711baddb66a385a4"><td class="mdescLeft"> </td><td class="mdescRight">Remove all data from this object's IO source and then transfer data from the <em>src</em> <a class="el" href="classExiv2_1_1BasicIo.html" title="An interface for simple binary IO. ">BasicIo</a> object into this object. <a href="#acb964ff603c96da8711baddb66a385a4">More...</a><br /></td></tr>
<tr class="separator:acb964ff603c96da8711baddb66a385a4"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a561221bbe1d215b4d6b5ceceaa2e9a97"><td class="memItemLeft" align="right" valign="top">virtual int </td><td class="memItemRight" valign="bottom"><a class="el" href="classExiv2_1_1BasicIo.html#a561221bbe1d215b4d6b5ceceaa2e9a97">seek</a> (long offset, <a class="el" href="classExiv2_1_1BasicIo.html#a1d23c3bf7618f2ee6ebb5cf033b10911">Position</a> pos)=0</td></tr>
<tr class="memdesc:a561221bbe1d215b4d6b5ceceaa2e9a97"><td class="mdescLeft"> </td><td class="mdescRight">Move the current IO position. <a href="#a561221bbe1d215b4d6b5ceceaa2e9a97">More...</a><br /></td></tr>
<tr class="separator:a561221bbe1d215b4d6b5ceceaa2e9a97"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a8728349cdeb79d569eba6fa6e26d5e74"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="namespaceExiv2.html#a16f60a5bd4207fe155f6cf93a15efa72">byte</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classExiv2_1_1BasicIo.html#a8728349cdeb79d569eba6fa6e26d5e74">mmap</a> (bool isWriteable=false)=0</td></tr>
<tr class="memdesc:a8728349cdeb79d569eba6fa6e26d5e74"><td class="mdescLeft"> </td><td class="mdescRight">Direct access to the IO data. For files, this is done by mapping the file into the process's address space; for memory blocks, this allows direct access to the memory block. <a href="#a8728349cdeb79d569eba6fa6e26d5e74">More...</a><br /></td></tr>
<tr class="separator:a8728349cdeb79d569eba6fa6e26d5e74"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aad39cb2b01e19b5e648988bbb239fa63"><td class="memItemLeft" align="right" valign="top">virtual int </td><td class="memItemRight" valign="bottom"><a class="el" href="classExiv2_1_1BasicIo.html#aad39cb2b01e19b5e648988bbb239fa63">munmap</a> ()=0</td></tr>
<tr class="memdesc:aad39cb2b01e19b5e648988bbb239fa63"><td class="mdescLeft"> </td><td class="mdescRight">Remove a mapping established with <a class="el" href="classExiv2_1_1BasicIo.html#a8728349cdeb79d569eba6fa6e26d5e74" title="Direct access to the IO data. For files, this is done by mapping the file into the process's address ...">mmap()</a>. If the mapped area is writeable, this ensures that changes are written back. <a href="#aad39cb2b01e19b5e648988bbb239fa63">More...</a><br /></td></tr>
<tr class="separator:aad39cb2b01e19b5e648988bbb239fa63"><td class="memSeparator" colspan="2"> </td></tr>
<tr><td colspan="2"><div class="groupHeader">Accessors</div></td></tr>
<tr class="memitem:aeb9673a48a7af7376b7018998fb552e6"><td class="memItemLeft" align="right" valign="top">virtual long </td><td class="memItemRight" valign="bottom"><a class="el" href="classExiv2_1_1BasicIo.html#aeb9673a48a7af7376b7018998fb552e6">tell</a> () const =0</td></tr>
<tr class="memdesc:aeb9673a48a7af7376b7018998fb552e6"><td class="mdescLeft"> </td><td class="mdescRight">Get the current IO position. <a href="#aeb9673a48a7af7376b7018998fb552e6">More...</a><br /></td></tr>
<tr class="separator:aeb9673a48a7af7376b7018998fb552e6"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a01903a1a2310197eb7e3fd41bedc3054"><td class="memItemLeft" align="right" valign="top">virtual long </td><td class="memItemRight" valign="bottom"><a class="el" href="classExiv2_1_1BasicIo.html#a01903a1a2310197eb7e3fd41bedc3054">size</a> () const =0</td></tr>
<tr class="memdesc:a01903a1a2310197eb7e3fd41bedc3054"><td class="mdescLeft"> </td><td class="mdescRight">Get the current size of the IO source in bytes. <a href="#a01903a1a2310197eb7e3fd41bedc3054">More...</a><br /></td></tr>
<tr class="separator:a01903a1a2310197eb7e3fd41bedc3054"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a17744832ee807c68f9c8d744692d9aaf"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a17744832ee807c68f9c8d744692d9aaf"></a>
virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classExiv2_1_1BasicIo.html#a17744832ee807c68f9c8d744692d9aaf">isopen</a> () const =0</td></tr>
<tr class="memdesc:a17744832ee807c68f9c8d744692d9aaf"><td class="mdescLeft"> </td><td class="mdescRight">Returns true if the IO source is open, otherwise false. <br /></td></tr>
<tr class="separator:a17744832ee807c68f9c8d744692d9aaf"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ad674727cddbf9cea627423620a8bb3d0"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ad674727cddbf9cea627423620a8bb3d0"></a>
virtual int </td><td class="memItemRight" valign="bottom"><a class="el" href="classExiv2_1_1BasicIo.html#ad674727cddbf9cea627423620a8bb3d0">error</a> () const =0</td></tr>
<tr class="memdesc:ad674727cddbf9cea627423620a8bb3d0"><td class="mdescLeft"> </td><td class="mdescRight">Returns 0 if the IO source is in a valid state, otherwise nonzero. <br /></td></tr>
<tr class="separator:ad674727cddbf9cea627423620a8bb3d0"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a29b826f89a8aac3c83ece6f8f343ed72"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a29b826f89a8aac3c83ece6f8f343ed72"></a>
virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classExiv2_1_1BasicIo.html#a29b826f89a8aac3c83ece6f8f343ed72">eof</a> () const =0</td></tr>
<tr class="memdesc:a29b826f89a8aac3c83ece6f8f343ed72"><td class="mdescLeft"> </td><td class="mdescRight">Returns true if the IO position has reach the end, otherwise false. <br /></td></tr>
<tr class="separator:a29b826f89a8aac3c83ece6f8f343ed72"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a8c4af60d14039fd99d36c73ce8354c15"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a8c4af60d14039fd99d36c73ce8354c15"></a>
virtual std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classExiv2_1_1BasicIo.html#a8c4af60d14039fd99d36c73ce8354c15">path</a> () const =0</td></tr>
<tr class="memdesc:a8c4af60d14039fd99d36c73ce8354c15"><td class="mdescLeft"> </td><td class="mdescRight">Return the path to the IO resource. Often used to form comprehensive error messages where only a <a class="el" href="classExiv2_1_1BasicIo.html" title="An interface for simple binary IO. ">BasicIo</a> instance is available. <br /></td></tr>
<tr class="separator:a8c4af60d14039fd99d36c73ce8354c15"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aec9dd2dd223ce57650462c74a0770502"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classExiv2_1_1BasicIo.html#af8f989522925b884d8c9d3a257265fa1">BasicIo::AutoPtr</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classExiv2_1_1BasicIo.html#aec9dd2dd223ce57650462c74a0770502">temporary</a> () const =0</td></tr>
<tr class="memdesc:aec9dd2dd223ce57650462c74a0770502"><td class="mdescLeft"> </td><td class="mdescRight">Returns a temporary data storage location. This is often needed to rewrite an IO source. <a href="#aec9dd2dd223ce57650462c74a0770502">More...</a><br /></td></tr>
<tr class="separator:aec9dd2dd223ce57650462c74a0770502"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="member-group"></a>
Creators</h2></td></tr>
<tr class="memitem:a85137a48df4f7503e6197711b6021203"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a85137a48df4f7503e6197711b6021203"></a>
virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classExiv2_1_1BasicIo.html#a85137a48df4f7503e6197711b6021203">~BasicIo</a> ()</td></tr>
<tr class="memdesc:a85137a48df4f7503e6197711b6021203"><td class="mdescLeft"> </td><td class="mdescRight">Destructor. <br /></td></tr>
<tr class="separator:a85137a48df4f7503e6197711b6021203"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ac726bef377a5da282b0f2cadb5b779be"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ac726bef377a5da282b0f2cadb5b779be"></a>
 </td><td class="memItemRight" valign="bottom"><a class="el" href="classExiv2_1_1BasicIo.html#ac726bef377a5da282b0f2cadb5b779be">BasicIo</a> ()</td></tr>
<tr class="memdesc:ac726bef377a5da282b0f2cadb5b779be"><td class="mdescLeft"> </td><td class="mdescRight">Default Constructor. <br /></td></tr>
<tr class="separator:ac726bef377a5da282b0f2cadb5b779be"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>An interface for simple binary IO. </p>
<p>Designed to have semantics and names similar to those of C style FILE* operations. Subclasses should all behave the same so that they can be interchanged. </p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="a67ae3ca0f8aece92a7b7749dfb02edde"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual int Exiv2::BasicIo::close </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Close the IO source. After closing a <a class="el" href="classExiv2_1_1BasicIo.html" title="An interface for simple binary IO. ">BasicIo</a> instance can not be read or written. Closing flushes any unwritten data. It is safe to call close on a closed instance. </p>
<dl class="section return"><dt>Returns</dt><dd>0 if successful;<br />
Nonzero if failure. </dd></dl>
<p>Implemented in <a class="el" href="classExiv2_1_1MemIo.html#a7c87d3a1b552a4a93fe38255b43d0fc5">Exiv2::MemIo</a>, and <a class="el" href="classExiv2_1_1FileIo.html#ae0a881364b273ff14fb90c9375e9378b">Exiv2::FileIo</a>.</p>
<p>Referenced by <a class="el" href="classExiv2_1_1FileIo.html#a7820fe3bdac99ff4a78dccccba1eed10">Exiv2::FileIo::transfer()</a>, and <a class="el" href="classExiv2_1_1MemIo.html#ac0c261a78dfeb097eacb51d14552389c">Exiv2::MemIo::transfer()</a>.</p>
</div>
</div>
<a class="anchor" id="a648bc0d9b1a79e34684375074d806534"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual int Exiv2::BasicIo::getb </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Read one byte from the IO source. Current IO position is advanced by one byte. </p>
<dl class="section return"><dt>Returns</dt><dd>The byte read from the IO source if successful;<br />
EOF if failure; </dd></dl>
<p>Implemented in <a class="el" href="classExiv2_1_1MemIo.html#ac3a53ab7bda3678eb813e505bad4e50a">Exiv2::MemIo</a>, and <a class="el" href="classExiv2_1_1FileIo.html#a7b211213f0c2e3b9153a69f67c15ab47">Exiv2::FileIo</a>.</p>
</div>
</div>
<a class="anchor" id="a8728349cdeb79d569eba6fa6e26d5e74"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="namespaceExiv2.html#a16f60a5bd4207fe155f6cf93a15efa72">byte</a>* Exiv2::BasicIo::mmap </td>
<td>(</td>
<td class="paramtype">bool </td>
<td class="paramname"><em>isWriteable</em> = <code>false</code></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Direct access to the IO data. For files, this is done by mapping the file into the process's address space; for memory blocks, this allows direct access to the memory block. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">isWriteable</td><td>Set to true if the mapped area should be writeable (default is false). </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>A pointer to the mapped area. </dd></dl>
<dl class="exception"><dt>Exceptions</dt><dd>
<table class="exception">
<tr><td class="paramname">Error</td><td>In case of failure. </td></tr>
</table>
</dd>
</dl>
<p>Implemented in <a class="el" href="classExiv2_1_1MemIo.html#a9472d3d09a1aebce9fca15f36803caf5">Exiv2::MemIo</a>, and <a class="el" href="classExiv2_1_1FileIo.html#abacf2e7547c849c8809d472872c9a3a2">Exiv2::FileIo</a>.</p>
</div>
</div>
<a class="anchor" id="aad39cb2b01e19b5e648988bbb239fa63"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual int Exiv2::BasicIo::munmap </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Remove a mapping established with <a class="el" href="classExiv2_1_1BasicIo.html#a8728349cdeb79d569eba6fa6e26d5e74" title="Direct access to the IO data. For files, this is done by mapping the file into the process's address ...">mmap()</a>. If the mapped area is writeable, this ensures that changes are written back. </p>
<dl class="section return"><dt>Returns</dt><dd>0 if successful;<br />
Nonzero if failure; </dd></dl>
<p>Implemented in <a class="el" href="classExiv2_1_1MemIo.html#ac6b4bbc56cd98263494f4c9fab153630">Exiv2::MemIo</a>, and <a class="el" href="classExiv2_1_1FileIo.html#ac23e31007bdcf3d4e7f17bc2b0341759">Exiv2::FileIo</a>.</p>
</div>
</div>
<a class="anchor" id="a1beff0dcdf03510bad13b6946379c5f2"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual int Exiv2::BasicIo::open </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Open the IO source using the default access mode. The default mode should allow for reading and writing. </p>
<p>This method can also be used to "reopen" an IO source which will flush any unwritten data and reset the IO position to the start. Subclasses may provide custom methods to allow for opening IO sources differently.</p>
<dl class="section return"><dt>Returns</dt><dd>0 if successful;<br />
Nonzero if failure. </dd></dl>
<p>Implemented in <a class="el" href="classExiv2_1_1MemIo.html#a32f5d13aff64550f03dbc93692d27d16">Exiv2::MemIo</a>, and <a class="el" href="classExiv2_1_1FileIo.html#a82a0cd197da227242ad8fcc50a70d29b">Exiv2::FileIo</a>.</p>
<p>Referenced by <a class="el" href="classExiv2_1_1ImageFactory.html#abd5d3ab76420ec7db45cc2105f4e5907">Exiv2::ImageFactory::getType()</a>, <a class="el" href="classExiv2_1_1FileIo.html#a7820fe3bdac99ff4a78dccccba1eed10">Exiv2::FileIo::transfer()</a>, and <a class="el" href="classExiv2_1_1MemIo.html#ac0c261a78dfeb097eacb51d14552389c">Exiv2::MemIo::transfer()</a>.</p>
</div>
</div>
<a class="anchor" id="ad16a1fab0f122c8ca11b86d09b03b9a7"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual int Exiv2::BasicIo::putb </td>
<td>(</td>
<td class="paramtype"><a class="el" href="namespaceExiv2.html#a16f60a5bd4207fe155f6cf93a15efa72">byte</a> </td>
<td class="paramname"><em>data</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Write one byte to the IO source. Current IO position is advanced by one byte. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">data</td><td>The single byte to be written. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The value of the byte written if successful;<br />
EOF if failure; </dd></dl>
<p>Implemented in <a class="el" href="classExiv2_1_1MemIo.html#a2737a46ff783d3e9c66c6f8ce255d913">Exiv2::MemIo</a>, and <a class="el" href="classExiv2_1_1FileIo.html#a5d982468386b392b34b5ee8142b73396">Exiv2::FileIo</a>.</p>
<p>Referenced by <a class="el" href="classExiv2_1_1Internal_1_1IoWrapper.html#a248b4747439e4bcbe9eabce1906ef48b">Exiv2::Internal::IoWrapper::putb()</a>.</p>
</div>
</div>
<a class="anchor" id="a8c9e6c7377b642afbb2c14a0e3896917"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="classExiv2_1_1DataBuf.html">DataBuf</a> Exiv2::BasicIo::read </td>
<td>(</td>
<td class="paramtype">long </td>
<td class="paramname"><em>rcount</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Read data from the IO source. Reading starts at the current IO position and the position is advanced by the number of bytes read. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">rcount</td><td>Maximum number of bytes to read. Fewer bytes may be read if <em>rcount</em> bytes are not available. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="classExiv2_1_1DataBuf.html" title="Utility class containing a character array. All it does is to take care of memory allocation and dele...">DataBuf</a> instance containing the bytes read. Use the <a class="el" href="classExiv2_1_1DataBuf.html#a5e6028d5cdae2e149749667cf66c3e91" title="The current size of the buffer. ">DataBuf::size_</a> member to find the number of bytes read. <a class="el" href="classExiv2_1_1DataBuf.html#a5e6028d5cdae2e149749667cf66c3e91" title="The current size of the buffer. ">DataBuf::size_</a> will be 0 on failure. </dd></dl>
<p>Implemented in <a class="el" href="classExiv2_1_1MemIo.html#ab5b0239fe9df1d515e581d318ccceb7c">Exiv2::MemIo</a>, and <a class="el" href="classExiv2_1_1FileIo.html#a5c7364fbbdc740ec0736da33ad9a82f0">Exiv2::FileIo</a>.</p>
<p>Referenced by <a class="el" href="namespaceExiv2.html#a6344a9183a9acb24b8c2bcf44fad8228">Exiv2::isAsfType()</a>, <a class="el" href="namespaceExiv2.html#a82b3160e1cdce93c1f30c7717d04a4da">Exiv2::isBmpType()</a>, <a class="el" href="namespaceExiv2.html#a9762d2176964085e569e969c282cdda9">Exiv2::isCr2Type()</a>, <a class="el" href="namespaceExiv2.html#a72ae59b54c2052cc1bc6e08880fec280">Exiv2::isCrwType()</a>, <a class="el" href="namespaceExiv2.html#a97ee22daaeaeae27429093f977fe8258">Exiv2::isEpsType()</a>, <a class="el" href="namespaceExiv2.html#ae0d08d5f85e7ce057e6ac5c0e5d1d95a">Exiv2::isExvType()</a>, <a class="el" href="namespaceExiv2.html#ae2b8b0eceeb28acf1bc2a78b18acbfc4">Exiv2::isGifType()</a>, <a class="el" href="namespaceExiv2.html#a1061485827f94c46921d3e1ceda8ba29">Exiv2::isJp2Type()</a>, <a class="el" href="namespaceExiv2.html#a79d7543e864557d19e67b91bb1843962">Exiv2::isJpegType()</a>, <a class="el" href="namespaceExiv2.html#aeb9acb098a113c94f4f7f02f930aadca">Exiv2::isMkvType()</a>, <a class="el" href="namespaceExiv2.html#a49bd48d4c5759f607e7ddaa7a7ce3d3f">Exiv2::isMrwType()</a>, <a class="el" href="namespaceExiv2.html#a87cc9dd7270c22d05d95bf695f21d796">Exiv2::isOrfType()</a>, <a class="el" href="namespaceExiv2.html#addb4cc95dc380c767efbe94584b4df6a">Exiv2::isPgfType()</a>, <a class="el" href="namespaceExiv2.html#aa8f35a1ff80fbea87aec202f8ddb69c7">Exiv2::isPngType()</a>, <a class="el" href="namespaceExiv2.html#ae1922df87be2eb2db5ca64ce1152cd9d">Exiv2::isPsdType()</a>, <a class="el" href="namespaceExiv2.html#af437212d7fe25ccddc931abb5efcbcdc">Exiv2::isQTimeType()</a>, <a class="el" href="namespaceExiv2.html#a8f90949be425b2396c454eb9084bebbf">Exiv2::isRafType()</a>, <a class="el" href="namespaceExiv2.html#a9bd5bbc2d1c8a279955910f5674114c1">Exiv2::isRiffType()</a>, <a class="el" href="namespaceExiv2.html#a31dc6a983c786692a5a6b100ae58cde3">Exiv2::isRw2Type()</a>, <a class="el" href="namespaceExiv2.html#a8e28192e762ae5664c12afe6677a2593">Exiv2::isTgaType()</a>, <a class="el" href="namespaceExiv2.html#a6f5d5b19b7e5fcd822a1d8ef9eed4ca9">Exiv2::isTiffType()</a>, <a class="el" href="namespaceExiv2.html#aeb5e294dbd9da3393aa3ceb205409660">Exiv2::isXmpType()</a>, <a class="el" href="classExiv2_1_1FileIo.html#ad388515b87717088238dca8d71e75470">Exiv2::FileIo::write()</a>, and <a class="el" href="classExiv2_1_1MemIo.html#a0d22943b9f0f0cc399bd7616dd7dd695">Exiv2::MemIo::write()</a>.</p>
</div>
</div>
<a class="anchor" id="aec8cb20c86e72b87577370a28d66a0ca"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual long Exiv2::BasicIo::read </td>
<td>(</td>
<td class="paramtype"><a class="el" href="namespaceExiv2.html#a16f60a5bd4207fe155f6cf93a15efa72">byte</a> * </td>
<td class="paramname"><em>buf</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">long </td>
<td class="paramname"><em>rcount</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Read data from the IO source. Reading starts at the current IO position and the position is advanced by the number of bytes read. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">buf</td><td>Pointer to a block of memory into which the read data is stored. The memory block must be at least <em>rcount</em> bytes long. </td></tr>
<tr><td class="paramname">rcount</td><td>Maximum number of bytes to read. Fewer bytes may be read if <em>rcount</em> bytes are not available. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Number of bytes read from IO source successfully;<br />
0 if failure; </dd></dl>
<p>Implemented in <a class="el" href="classExiv2_1_1MemIo.html#a3c4d85990cf914c9c5475466ba522289">Exiv2::MemIo</a>, and <a class="el" href="classExiv2_1_1FileIo.html#a23f598a52577e98be9f4292518ba6198">Exiv2::FileIo</a>.</p>
</div>
</div>
<a class="anchor" id="a561221bbe1d215b4d6b5ceceaa2e9a97"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual int Exiv2::BasicIo::seek </td>
<td>(</td>
<td class="paramtype">long </td>
<td class="paramname"><em>offset</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classExiv2_1_1BasicIo.html#a1d23c3bf7618f2ee6ebb5cf033b10911">Position</a> </td>
<td class="paramname"><em>pos</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Move the current IO position. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">offset</td><td>Number of bytes to move the position relative to the starting position specified by <em>pos</em> </td></tr>
<tr><td class="paramname">pos</td><td>Position from which the seek should start </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>0 if successful;<br />
Nonzero if failure; </dd></dl>
<p>Implemented in <a class="el" href="classExiv2_1_1MemIo.html#a550d335e942b1f7d3a3d2c35bd4c443e">Exiv2::MemIo</a>, and <a class="el" href="classExiv2_1_1FileIo.html#af3f07fc65378860f0b4fe048a398a1bf">Exiv2::FileIo</a>.</p>
<p>Referenced by <a class="el" href="namespaceExiv2.html#a6344a9183a9acb24b8c2bcf44fad8228">Exiv2::isAsfType()</a>, <a class="el" href="namespaceExiv2.html#a82b3160e1cdce93c1f30c7717d04a4da">Exiv2::isBmpType()</a>, <a class="el" href="namespaceExiv2.html#a9762d2176964085e569e969c282cdda9">Exiv2::isCr2Type()</a>, <a class="el" href="namespaceExiv2.html#a72ae59b54c2052cc1bc6e08880fec280">Exiv2::isCrwType()</a>, <a class="el" href="namespaceExiv2.html#a97ee22daaeaeae27429093f977fe8258">Exiv2::isEpsType()</a>, <a class="el" href="namespaceExiv2.html#ae0d08d5f85e7ce057e6ac5c0e5d1d95a">Exiv2::isExvType()</a>, <a class="el" href="namespaceExiv2.html#ae2b8b0eceeb28acf1bc2a78b18acbfc4">Exiv2::isGifType()</a>, <a class="el" href="namespaceExiv2.html#a1061485827f94c46921d3e1ceda8ba29">Exiv2::isJp2Type()</a>, <a class="el" href="namespaceExiv2.html#a79d7543e864557d19e67b91bb1843962">Exiv2::isJpegType()</a>, <a class="el" href="namespaceExiv2.html#aeb9acb098a113c94f4f7f02f930aadca">Exiv2::isMkvType()</a>, <a class="el" href="namespaceExiv2.html#a49bd48d4c5759f607e7ddaa7a7ce3d3f">Exiv2::isMrwType()</a>, <a class="el" href="namespaceExiv2.html#a87cc9dd7270c22d05d95bf695f21d796">Exiv2::isOrfType()</a>, <a class="el" href="namespaceExiv2.html#addb4cc95dc380c767efbe94584b4df6a">Exiv2::isPgfType()</a>, <a class="el" href="namespaceExiv2.html#aa8f35a1ff80fbea87aec202f8ddb69c7">Exiv2::isPngType()</a>, <a class="el" href="namespaceExiv2.html#ae1922df87be2eb2db5ca64ce1152cd9d">Exiv2::isPsdType()</a>, <a class="el" href="namespaceExiv2.html#af437212d7fe25ccddc931abb5efcbcdc">Exiv2::isQTimeType()</a>, <a class="el" href="namespaceExiv2.html#a8f90949be425b2396c454eb9084bebbf">Exiv2::isRafType()</a>, <a class="el" href="namespaceExiv2.html#a9bd5bbc2d1c8a279955910f5674114c1">Exiv2::isRiffType()</a>, <a class="el" href="namespaceExiv2.html#a31dc6a983c786692a5a6b100ae58cde3">Exiv2::isRw2Type()</a>, <a class="el" href="namespaceExiv2.html#a8e28192e762ae5664c12afe6677a2593">Exiv2::isTgaType()</a>, <a class="el" href="namespaceExiv2.html#a6f5d5b19b7e5fcd822a1d8ef9eed4ca9">Exiv2::isTiffType()</a>, <a class="el" href="namespaceExiv2.html#aeb5e294dbd9da3393aa3ceb205409660">Exiv2::isXmpType()</a>, <a class="el" href="classExiv2_1_1FileIo.html#ad388515b87717088238dca8d71e75470">Exiv2::FileIo::write()</a>, and <a class="el" href="classExiv2_1_1Internal_1_1OffsetWriter.html#aeecd16d5bdc23ce332fa3630258c8543">Exiv2::Internal::OffsetWriter::writeOffsets()</a>.</p>
</div>
</div>
<a class="anchor" id="a01903a1a2310197eb7e3fd41bedc3054"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual long Exiv2::BasicIo::size </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the current size of the IO source in bytes. </p>
<dl class="section return"><dt>Returns</dt><dd>Size of the IO source in bytes;<br />
-1 if failure; </dd></dl>
<p>Implemented in <a class="el" href="classExiv2_1_1MemIo.html#a4cba82129b173367e5e987125d2a1635">Exiv2::MemIo</a>, and <a class="el" href="classExiv2_1_1FileIo.html#a661e30ac842bbbeedef11aa9e1454f6d">Exiv2::FileIo</a>.</p>
</div>
</div>
<a class="anchor" id="aeb9673a48a7af7376b7018998fb552e6"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual long Exiv2::BasicIo::tell </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the current IO position. </p>
<dl class="section return"><dt>Returns</dt><dd>Offset from the start of IO if successful;<br />
-1 if failure; </dd></dl>
<p>Implemented in <a class="el" href="classExiv2_1_1MemIo.html#a832a61a8b49b570024068efb54d08955">Exiv2::MemIo</a>, and <a class="el" href="classExiv2_1_1FileIo.html#abf285ea310f0c53d3107de6ba6e518db">Exiv2::FileIo</a>.</p>
<p>Referenced by <a class="el" href="namespaceExiv2.html#a8e28192e762ae5664c12afe6677a2593">Exiv2::isTgaType()</a>.</p>
</div>
</div>
<a class="anchor" id="aec9dd2dd223ce57650462c74a0770502"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="classExiv2_1_1BasicIo.html#af8f989522925b884d8c9d3a257265fa1">BasicIo::AutoPtr</a> Exiv2::BasicIo::temporary </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns a temporary data storage location. This is often needed to rewrite an IO source. </p>
<p>For example, data may be read from the original IO source, modified in some way, and then saved to the temporary instance. After the operation is complete, the <a class="el" href="classExiv2_1_1BasicIo.html#acb964ff603c96da8711baddb66a385a4" title="Remove all data from this object's IO source and then transfer data from the src BasicIo object into ...">BasicIo::transfer</a> method can be used to replace the original IO source with the modified version. Subclasses are free to return any class that derives from <a class="el" href="classExiv2_1_1BasicIo.html" title="An interface for simple binary IO. ">BasicIo</a>.</p>
<dl class="section return"><dt>Returns</dt><dd>An instance of <a class="el" href="classExiv2_1_1BasicIo.html" title="An interface for simple binary IO. ">BasicIo</a> on success </dd></dl>
<dl class="exception"><dt>Exceptions</dt><dd>
<table class="exception">
<tr><td class="paramname">Error</td><td>In case of failure </td></tr>
</table>
</dd>
</dl>
<p>Implemented in <a class="el" href="classExiv2_1_1MemIo.html#ac3d6031a13b8a7eae6959178bb1301a0">Exiv2::MemIo</a>, and <a class="el" href="classExiv2_1_1FileIo.html#affc1034970489c7734cfefed90b4d8d1">Exiv2::FileIo</a>.</p>
<p>Referenced by <a class="el" href="classExiv2_1_1Internal_1_1TiffParserWorker.html#a997834afb3498e2abd298921fc14dee7">Exiv2::Internal::TiffParserWorker::encode()</a>.</p>
</div>
</div>
<a class="anchor" id="acb964ff603c96da8711baddb66a385a4"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual void Exiv2::BasicIo::transfer </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classExiv2_1_1BasicIo.html">BasicIo</a> & </td>
<td class="paramname"><em>src</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Remove all data from this object's IO source and then transfer data from the <em>src</em> <a class="el" href="classExiv2_1_1BasicIo.html" title="An interface for simple binary IO. ">BasicIo</a> object into this object. </p>
<p>The source object is invalidated by this operation and should not be used after this method returns. This method exists primarily to be used with the <a class="el" href="classExiv2_1_1BasicIo.html#aec9dd2dd223ce57650462c74a0770502" title="Returns a temporary data storage location. This is often needed to rewrite an IO source. ">BasicIo::temporary()</a> method.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">src</td><td>Reference to another <a class="el" href="classExiv2_1_1BasicIo.html" title="An interface for simple binary IO. ">BasicIo</a> instance. The entire contents of src are transferred to this object. The <em>src</em> object is invalidated by the method. </td></tr>
</table>
</dd>
</dl>
<dl class="exception"><dt>Exceptions</dt><dd>
<table class="exception">
<tr><td class="paramname">Error</td><td>In case of failure </td></tr>
</table>
</dd>
</dl>
<p>Implemented in <a class="el" href="classExiv2_1_1MemIo.html#ac0c261a78dfeb097eacb51d14552389c">Exiv2::MemIo</a>, and <a class="el" href="classExiv2_1_1FileIo.html#a7820fe3bdac99ff4a78dccccba1eed10">Exiv2::FileIo</a>.</p>
<p>Referenced by <a class="el" href="classExiv2_1_1Internal_1_1TiffParserWorker.html#a997834afb3498e2abd298921fc14dee7">Exiv2::Internal::TiffParserWorker::encode()</a>.</p>
</div>
</div>
<a class="anchor" id="ac548d52ef633ac425bd01d17ccd2e7e4"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual long Exiv2::BasicIo::write </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="namespaceExiv2.html#a16f60a5bd4207fe155f6cf93a15efa72">byte</a> * </td>
<td class="paramname"><em>data</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">long </td>
<td class="paramname"><em>wcount</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Write data to the IO source. Current IO position is advanced by the number of bytes written. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">data</td><td>Pointer to data. Data must be at least <em>wcount</em> bytes long </td></tr>
<tr><td class="paramname">wcount</td><td>Number of bytes to be written. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Number of bytes written to IO source successfully;<br />
0 if failure; </dd></dl>
<p>Implemented in <a class="el" href="classExiv2_1_1MemIo.html#ab34c91ef04dd9b8f5faf51d380aa55b9">Exiv2::MemIo</a>, and <a class="el" href="classExiv2_1_1FileIo.html#a5b3d5f5a5b4b7f9d3d8cec46a4ad95f7">Exiv2::FileIo</a>.</p>
<p>Referenced by <a class="el" href="classExiv2_1_1Internal_1_1IoWrapper.html#a248b4747439e4bcbe9eabce1906ef48b">Exiv2::Internal::IoWrapper::putb()</a>, <a class="el" href="classExiv2_1_1Internal_1_1IoWrapper.html#a6fabb0585e55152b54f60c56e837c672">Exiv2::Internal::IoWrapper::write()</a>, <a class="el" href="classExiv2_1_1JpegImage.html#a8a3082eb94f566db8b52ae5dfd80754d">Exiv2::JpegImage::writeHeader()</a>, <a class="el" href="classExiv2_1_1ExvImage.html#ac8d38bdde6a43d90e9c5d8ec1eacc7b0">Exiv2::ExvImage::writeHeader()</a>, and <a class="el" href="classExiv2_1_1Internal_1_1OffsetWriter.html#aeecd16d5bdc23ce332fa3630258c8543">Exiv2::Internal::OffsetWriter::writeOffsets()</a>.</p>
</div>
</div>
<a class="anchor" id="a31334606e230bbe94d6b8768d3c6d75f"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual long Exiv2::BasicIo::write </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classExiv2_1_1BasicIo.html">BasicIo</a> & </td>
<td class="paramname"><em>src</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Write data that is read from another <a class="el" href="classExiv2_1_1BasicIo.html" title="An interface for simple binary IO. ">BasicIo</a> instance to the IO source. Current IO position is advanced by the number of bytes written. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">src</td><td>Reference to another <a class="el" href="classExiv2_1_1BasicIo.html" title="An interface for simple binary IO. ">BasicIo</a> instance. Reading start at the source's current IO position </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Number of bytes written to IO source successfully;<br />
0 if failure; </dd></dl>
<p>Implemented in <a class="el" href="classExiv2_1_1MemIo.html#a0d22943b9f0f0cc399bd7616dd7dd695">Exiv2::MemIo</a>, and <a class="el" href="classExiv2_1_1FileIo.html#ad388515b87717088238dca8d71e75470">Exiv2::FileIo</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li><a class="el" href="basicio_8hpp.html">basicio.hpp</a></li>
<li>basicio.cpp</li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Fri Mar 4 2016 17:51:50 for Exiv2 by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.8
</small></address>
</body>
</html>
distrib
>
Mageia
>
5
>
x86_64
>
media
>
core-updates
>
by-pkgid
>
12cd2b60e7ffa1b93f26cacdd7197eb9
>
files
>
147
