stdex/classstdex_1_1idrec_1_1record.html

785 lines
42 KiB
HTML

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.11.0"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>stdex: stdex::idrec::record&lt; T, T_id, ID, T_size, N_align &gt; Class Template 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>
<script type="text/javascript" src="clipboard.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="cookie.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></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 id="projectrow">
<td id="projectalign">
<div id="projectname">stdex
</div>
<div id="projectbrief">Additional custom or not Standard C++ covered algorithms</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.11.0 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search/",'.html');
/* @license-end */
</script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() { codefold.init(0); });
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
initMenu('',true,false,'search.php','Search',false);
$(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function(){ initResizable(false); });
/* @license-end */
</script>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><b>stdex</b></li><li class="navelem"><b>idrec</b></li><li class="navelem"><a class="el" href="classstdex_1_1idrec_1_1record.html">record</a></li> </ul>
</div>
</div><!-- top -->
<div id="doc-content">
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pub-static-methods">Static Public Member Functions</a> &#124;
<a href="#pub-attribs">Public Attributes</a> &#124;
<a href="#friends">Friends</a> &#124;
<a href="classstdex_1_1idrec_1_1record-members.html">List of all members</a> </div>
<div class="headertitle"><div class="title">stdex::idrec::record&lt; T, T_id, ID, T_size, N_align &gt; Class Template Reference</div></div>
</div><!--header-->
<div class="contents">
<p>Helper class for read/write of records to/from memory.
<a href="#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="idrec_8hpp_source.html">stdex/idrec.hpp</a>&gt;</code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-methods" name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:aa247ad441605fdfb8d8e1cc5bee78168" id="r_aa247ad441605fdfb8d8e1cc5bee78168"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#aa247ad441605fdfb8d8e1cc5bee78168">record</a> (T &amp;d)</td></tr>
<tr class="memdesc:aa247ad441605fdfb8d8e1cc5bee78168"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructs the class. <br /></td></tr>
<tr class="separator:aa247ad441605fdfb8d8e1cc5bee78168"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa714af10b747fb8aa7bf3c6e37484bb2" id="r_aa714af10b747fb8aa7bf3c6e37484bb2"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#aa714af10b747fb8aa7bf3c6e37484bb2">record</a> (const T &amp;d)</td></tr>
<tr class="memdesc:aa714af10b747fb8aa7bf3c6e37484bb2"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructs the class. <br /></td></tr>
<tr class="separator:aa714af10b747fb8aa7bf3c6e37484bb2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a07934d315566b6ad40edbc5f93cb5978" id="r_a07934d315566b6ad40edbc5f93cb5978"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="classstdex_1_1idrec_1_1record.html">record</a>&lt; T, T_id, ID, T_size, N_align &gt; &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a07934d315566b6ad40edbc5f93cb5978">operator=</a> (const <a class="el" href="classstdex_1_1idrec_1_1record.html">record</a>&lt; T, T_id, ID, T_size, N_align &gt; &amp;r)</td></tr>
<tr class="memdesc:a07934d315566b6ad40edbc5f93cb5978"><td class="mdescLeft">&#160;</td><td class="mdescRight">Assignment operator. <br /></td></tr>
<tr class="separator:a07934d315566b6ad40edbc5f93cb5978"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-static-methods" name="pub-static-methods"></a>
Static Public Member Functions</h2></td></tr>
<tr class="memitem:aade8ebd8670982f05cc890c750627365" id="r_aade8ebd8670982f05cc890c750627365"><td class="memItemLeft" align="right" valign="top"><a id="aade8ebd8670982f05cc890c750627365" name="aade8ebd8670982f05cc890c750627365"></a>
static constexpr T_id&#160;</td><td class="memItemRight" valign="bottom"><b>id</b> ()</td></tr>
<tr class="memdesc:aade8ebd8670982f05cc890c750627365"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns record id. <br /></td></tr>
<tr class="separator:aade8ebd8670982f05cc890c750627365"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae6653cf8e8fceac2cde594a8dcf16ce2" id="r_ae6653cf8e8fceac2cde594a8dcf16ce2"><td class="memItemLeft" align="right" valign="top">static std::streamoff&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ae6653cf8e8fceac2cde594a8dcf16ce2">open</a> (std::ostream &amp;stream)</td></tr>
<tr class="memdesc:ae6653cf8e8fceac2cde594a8dcf16ce2"><td class="mdescLeft">&#160;</td><td class="mdescRight">Writes record header. <br /></td></tr>
<tr class="separator:ae6653cf8e8fceac2cde594a8dcf16ce2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a40778f9e615305a67ba6cbfd362945b2" id="r_a40778f9e615305a67ba6cbfd362945b2"><td class="memItemLeft" align="right" valign="top">static stdex::stream::fpos_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a40778f9e615305a67ba6cbfd362945b2">open</a> (<a class="el" href="classstdex_1_1stream_1_1basic__file.html">stdex::stream::basic_file</a> &amp;stream)</td></tr>
<tr class="memdesc:a40778f9e615305a67ba6cbfd362945b2"><td class="mdescLeft">&#160;</td><td class="mdescRight">Writes record header. <br /></td></tr>
<tr class="separator:a40778f9e615305a67ba6cbfd362945b2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9fb4bee3afca4803a36767e3181a35b9" id="r_a9fb4bee3afca4803a36767e3181a35b9"><td class="memItemLeft" align="right" valign="top">static std::streamoff&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a9fb4bee3afca4803a36767e3181a35b9">close</a> (std::ostream &amp;stream, std::streamoff start)</td></tr>
<tr class="memdesc:a9fb4bee3afca4803a36767e3181a35b9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Updates record header. <br /></td></tr>
<tr class="separator:a9fb4bee3afca4803a36767e3181a35b9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4d136084b846a2e1e4b95af5cb60b0dc" id="r_a4d136084b846a2e1e4b95af5cb60b0dc"><td class="memItemLeft" align="right" valign="top">static stdex::stream::fpos_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a4d136084b846a2e1e4b95af5cb60b0dc">close</a> (<a class="el" href="classstdex_1_1stream_1_1basic__file.html">stdex::stream::basic_file</a> &amp;stream, stdex::stream::fpos_t start)</td></tr>
<tr class="memdesc:a4d136084b846a2e1e4b95af5cb60b0dc"><td class="mdescLeft">&#160;</td><td class="mdescRight">Updates record header. <br /></td></tr>
<tr class="separator:a4d136084b846a2e1e4b95af5cb60b0dc"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa142588b42ee8597798e9739f43bbade" id="r_aa142588b42ee8597798e9739f43bbade"><td class="memItemLeft" align="right" valign="top">static bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#aa142588b42ee8597798e9739f43bbade">find</a> (std::istream &amp;stream, std::streamoff end=(std::streamoff) -1)</td></tr>
<tr class="memdesc:aa142588b42ee8597798e9739f43bbade"><td class="mdescLeft">&#160;</td><td class="mdescRight">Finds record data. <br /></td></tr>
<tr class="separator:aa142588b42ee8597798e9739f43bbade"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9614e3b51ba6e74cef9863fcc857e499" id="r_a9614e3b51ba6e74cef9863fcc857e499"><td class="memItemLeft" align="right" valign="top">static bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a9614e3b51ba6e74cef9863fcc857e499">find</a> (<a class="el" href="classstdex_1_1stream_1_1basic__file.html">stdex::stream::basic_file</a> &amp;stream, stdex::stream::fpos_t end=stdex::stream::fpos_max)</td></tr>
<tr class="memdesc:a9614e3b51ba6e74cef9863fcc857e499"><td class="mdescLeft">&#160;</td><td class="mdescRight">Finds record data. <br /></td></tr>
<tr class="separator:a9614e3b51ba6e74cef9863fcc857e499"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-attribs" name="pub-attribs"></a>
Public Attributes</h2></td></tr>
<tr class="memitem:a7919c65ff80e6191192ec8b83d5aaedd" id="r_a7919c65ff80e6191192ec8b83d5aaedd"><td class="memItemLeft" align="right" valign="top"><a id="a7919c65ff80e6191192ec8b83d5aaedd" name="a7919c65ff80e6191192ec8b83d5aaedd"></a>
T &amp;&#160;</td><td class="memItemRight" valign="bottom"><b>data</b></td></tr>
<tr class="memdesc:a7919c65ff80e6191192ec8b83d5aaedd"><td class="mdescLeft">&#160;</td><td class="mdescRight">Record data reference. <br /></td></tr>
<tr class="separator:a7919c65ff80e6191192ec8b83d5aaedd"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="friends" name="friends"></a>
Friends</h2></td></tr>
<tr class="memitem:ac2ad32e2eb383f59c904f50d669c778e" id="r_ac2ad32e2eb383f59c904f50d669c778e"><td class="memItemLeft" align="right" valign="top">std::ostream &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ac2ad32e2eb383f59c904f50d669c778e">operator&lt;&lt;</a> (std::ostream &amp;stream, const <a class="el" href="classstdex_1_1idrec_1_1record.html">record</a>&lt; T, T_id, ID, T_size, N_align &gt; r)</td></tr>
<tr class="memdesc:ac2ad32e2eb383f59c904f50d669c778e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Writes record to a stream. <br /></td></tr>
<tr class="separator:ac2ad32e2eb383f59c904f50d669c778e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a454b67be32aac0b420eb173c37aef149" id="r_a454b67be32aac0b420eb173c37aef149"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classstdex_1_1stream_1_1basic__file.html">stdex::stream::basic_file</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a454b67be32aac0b420eb173c37aef149">operator&lt;&lt;</a> (<a class="el" href="classstdex_1_1stream_1_1basic__file.html">stdex::stream::basic_file</a> &amp;stream, const <a class="el" href="classstdex_1_1idrec_1_1record.html">record</a>&lt; T, T_id, ID, T_size, N_align &gt; r)</td></tr>
<tr class="memdesc:a454b67be32aac0b420eb173c37aef149"><td class="mdescLeft">&#160;</td><td class="mdescRight">Writes record to a file. <br /></td></tr>
<tr class="separator:a454b67be32aac0b420eb173c37aef149"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a01c94bd3b5997913561015f13e89de6c" id="r_a01c94bd3b5997913561015f13e89de6c"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classstdex_1_1stream_1_1basic.html">stdex::stream::basic</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a01c94bd3b5997913561015f13e89de6c">operator&lt;&lt;</a> (<a class="el" href="classstdex_1_1stream_1_1basic.html">stdex::stream::basic</a> &amp;stream, const <a class="el" href="classstdex_1_1idrec_1_1record.html">record</a>&lt; T, T_id, ID, T_size, N_align &gt; r)</td></tr>
<tr class="memdesc:a01c94bd3b5997913561015f13e89de6c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Writes record to a stream. <br /></td></tr>
<tr class="separator:a01c94bd3b5997913561015f13e89de6c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8f2fa168ba01d9df647e166a9799bd63" id="r_a8f2fa168ba01d9df647e166a9799bd63"><td class="memItemLeft" align="right" valign="top">std::istream &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a8f2fa168ba01d9df647e166a9799bd63">operator&gt;&gt;</a> (std::istream &amp;stream, <a class="el" href="classstdex_1_1idrec_1_1record.html">record</a>&lt; T, T_id, ID, T_size, N_align &gt; r)</td></tr>
<tr class="memdesc:a8f2fa168ba01d9df647e166a9799bd63"><td class="mdescLeft">&#160;</td><td class="mdescRight">Reads record from a stream. <br /></td></tr>
<tr class="separator:a8f2fa168ba01d9df647e166a9799bd63"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a74a44367e182a7c1ce600e61495aa7ff" id="r_a74a44367e182a7c1ce600e61495aa7ff"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classstdex_1_1stream_1_1basic__file.html">stdex::stream::basic_file</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a74a44367e182a7c1ce600e61495aa7ff">operator&gt;&gt;</a> (<a class="el" href="classstdex_1_1stream_1_1basic__file.html">stdex::stream::basic_file</a> &amp;stream, <a class="el" href="classstdex_1_1idrec_1_1record.html">record</a>&lt; T, T_id, ID, T_size, N_align &gt; r)</td></tr>
<tr class="memdesc:a74a44367e182a7c1ce600e61495aa7ff"><td class="mdescLeft">&#160;</td><td class="mdescRight">Reads record from a file. <br /></td></tr>
<tr class="separator:a74a44367e182a7c1ce600e61495aa7ff"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a944280f0451d647f8b32bd0082937864" id="r_a944280f0451d647f8b32bd0082937864"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classstdex_1_1stream_1_1basic.html">stdex::stream::basic</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a944280f0451d647f8b32bd0082937864">operator&gt;&gt;</a> (<a class="el" href="classstdex_1_1stream_1_1basic.html">stdex::stream::basic</a> &amp;stream, <a class="el" href="classstdex_1_1idrec_1_1record.html">record</a>&lt; T, T_id, ID, T_size, N_align &gt; r)</td></tr>
<tr class="memdesc:a944280f0451d647f8b32bd0082937864"><td class="mdescLeft">&#160;</td><td class="mdescRight">Reads record from a stream. <br /></td></tr>
<tr class="separator:a944280f0451d647f8b32bd0082937864"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><div class="compoundTemplParams">template&lt;class T, class T_id, const T_id ID, class T_size, T_size N_align&gt;<br />
class stdex::idrec::record&lt; T, T_id, ID, T_size, N_align &gt;</div><p>Helper class for read/write of records to/from memory. </p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="aa247ad441605fdfb8d8e1cc5bee78168" name="aa247ad441605fdfb8d8e1cc5bee78168"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa247ad441605fdfb8d8e1cc5bee78168">&#9670;&#160;</a></span>record() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class T , class T_id , const T_id ID, class T_size , T_size N_align&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classstdex_1_1idrec_1_1record.html">stdex::idrec::record</a>&lt; T, T_id, ID, T_size, N_align &gt;::record </td>
<td>(</td>
<td class="paramtype">T &amp;</td> <td class="paramname"><span class="paramname"><em>d</em></span></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Constructs the class. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">d</td><td>Reference to record data </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="aa714af10b747fb8aa7bf3c6e37484bb2" name="aa714af10b747fb8aa7bf3c6e37484bb2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa714af10b747fb8aa7bf3c6e37484bb2">&#9670;&#160;</a></span>record() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class T , class T_id , const T_id ID, class T_size , T_size N_align&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classstdex_1_1idrec_1_1record.html">stdex::idrec::record</a>&lt; T, T_id, ID, T_size, N_align &gt;::record </td>
<td>(</td>
<td class="paramtype">const T &amp;</td> <td class="paramname"><span class="paramname"><em>d</em></span></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Constructs the class. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">d</td><td>Reference to record data </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a9fb4bee3afca4803a36767e3181a35b9" name="a9fb4bee3afca4803a36767e3181a35b9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9fb4bee3afca4803a36767e3181a35b9">&#9670;&#160;</a></span>close() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class T , class T_id , const T_id ID, class T_size , T_size N_align&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static std::streamoff <a class="el" href="classstdex_1_1idrec_1_1record.html">stdex::idrec::record</a>&lt; T, T_id, ID, T_size, N_align &gt;::close </td>
<td>(</td>
<td class="paramtype">std::ostream &amp;</td> <td class="paramname"><span class="paramname"><em>stream</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">std::streamoff</td> <td class="paramname"><span class="paramname"><em>start</em></span>&#160;)</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Updates record header. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">stream</td><td>Output stream </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">start</td><td>Start position of the record in <code>stream</code> </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Position of the record end in <code>stream</code> </dd></dl>
</div>
</div>
<a id="a4d136084b846a2e1e4b95af5cb60b0dc" name="a4d136084b846a2e1e4b95af5cb60b0dc"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4d136084b846a2e1e4b95af5cb60b0dc">&#9670;&#160;</a></span>close() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class T , class T_id , const T_id ID, class T_size , T_size N_align&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static stdex::stream::fpos_t <a class="el" href="classstdex_1_1idrec_1_1record.html">stdex::idrec::record</a>&lt; T, T_id, ID, T_size, N_align &gt;::close </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classstdex_1_1stream_1_1basic__file.html">stdex::stream::basic_file</a> &amp;</td> <td class="paramname"><span class="paramname"><em>stream</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">stdex::stream::fpos_t</td> <td class="paramname"><span class="paramname"><em>start</em></span>&#160;)</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Updates record header. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">stream</td><td>Output stream </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">start</td><td>Start position of the record in <code>stream</code> </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Position of the record end in <code>stream</code> </dd></dl>
</div>
</div>
<a id="aa142588b42ee8597798e9739f43bbade" name="aa142588b42ee8597798e9739f43bbade"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa142588b42ee8597798e9739f43bbade">&#9670;&#160;</a></span>find() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class T , class T_id , const T_id ID, class T_size , T_size N_align&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static bool <a class="el" href="classstdex_1_1idrec_1_1record.html">stdex::idrec::record</a>&lt; T, T_id, ID, T_size, N_align &gt;::find </td>
<td>(</td>
<td class="paramtype">std::istream &amp;</td> <td class="paramname"><span class="paramname"><em>stream</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">std::streamoff</td> <td class="paramname"><span class="paramname"><em>end</em></span><span class="paramdefsep"> = </span><span class="paramdefval">(std::streamoff)-1</span>&#160;)</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Finds record data. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">stream</td><td>Input stream </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">end</td><td>Position limit. Default is -1 (no limit).</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><ul>
<li><code>true</code> when found</li>
<li><code>false</code> otherwise </li>
</ul>
</dd></dl>
</div>
</div>
<a id="a9614e3b51ba6e74cef9863fcc857e499" name="a9614e3b51ba6e74cef9863fcc857e499"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9614e3b51ba6e74cef9863fcc857e499">&#9670;&#160;</a></span>find() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class T , class T_id , const T_id ID, class T_size , T_size N_align&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static bool <a class="el" href="classstdex_1_1idrec_1_1record.html">stdex::idrec::record</a>&lt; T, T_id, ID, T_size, N_align &gt;::find </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classstdex_1_1stream_1_1basic__file.html">stdex::stream::basic_file</a> &amp;</td> <td class="paramname"><span class="paramname"><em>stream</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">stdex::stream::fpos_t</td> <td class="paramname"><span class="paramname"><em>end</em></span><span class="paramdefsep"> = </span><span class="paramdefval">stdex::stream::fpos_max</span>&#160;)</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Finds record data. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">stream</td><td>Input stream </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">end</td><td>Position limit. Default is stdex::stream::fpos_max (no limit).</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><ul>
<li><code>true</code> when found</li>
<li><code>false</code> otherwise </li>
</ul>
</dd></dl>
</div>
</div>
<a id="ae6653cf8e8fceac2cde594a8dcf16ce2" name="ae6653cf8e8fceac2cde594a8dcf16ce2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae6653cf8e8fceac2cde594a8dcf16ce2">&#9670;&#160;</a></span>open() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class T , class T_id , const T_id ID, class T_size , T_size N_align&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static std::streamoff <a class="el" href="classstdex_1_1idrec_1_1record.html">stdex::idrec::record</a>&lt; T, T_id, ID, T_size, N_align &gt;::open </td>
<td>(</td>
<td class="paramtype">std::ostream &amp;</td> <td class="paramname"><span class="paramname"><em>stream</em></span></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Writes record header. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">stream</td><td>Output stream</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Position of the record header start in <code>stream</code>. Save for later <code>close</code> call. </dd></dl>
</div>
</div>
<a id="a40778f9e615305a67ba6cbfd362945b2" name="a40778f9e615305a67ba6cbfd362945b2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a40778f9e615305a67ba6cbfd362945b2">&#9670;&#160;</a></span>open() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class T , class T_id , const T_id ID, class T_size , T_size N_align&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static stdex::stream::fpos_t <a class="el" href="classstdex_1_1idrec_1_1record.html">stdex::idrec::record</a>&lt; T, T_id, ID, T_size, N_align &gt;::open </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classstdex_1_1stream_1_1basic__file.html">stdex::stream::basic_file</a> &amp;</td> <td class="paramname"><span class="paramname"><em>stream</em></span></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Writes record header. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">stream</td><td>Output stream</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Position of the record header start in <code>stream</code>. Save for later <code>close</code> call. </dd></dl>
</div>
</div>
<a id="a07934d315566b6ad40edbc5f93cb5978" name="a07934d315566b6ad40edbc5f93cb5978"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a07934d315566b6ad40edbc5f93cb5978">&#9670;&#160;</a></span>operator=()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class T , class T_id , const T_id ID, class T_size , T_size N_align&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="classstdex_1_1idrec_1_1record.html">record</a>&lt; T, T_id, ID, T_size, N_align &gt; &amp; <a class="el" href="classstdex_1_1idrec_1_1record.html">stdex::idrec::record</a>&lt; T, T_id, ID, T_size, N_align &gt;::operator= </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classstdex_1_1idrec_1_1record.html">record</a>&lt; T, T_id, ID, T_size, N_align &gt; &amp;</td> <td class="paramname"><span class="paramname"><em>r</em></span></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Assignment operator. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">r</td><td>Source record</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>A const reference to this struct </dd></dl>
</div>
</div>
<h2 class="groupheader">Friends And Related Symbol Documentation</h2>
<a id="ac2ad32e2eb383f59c904f50d669c778e" name="ac2ad32e2eb383f59c904f50d669c778e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac2ad32e2eb383f59c904f50d669c778e">&#9670;&#160;</a></span>operator&lt;&lt; <span class="overload">[1/3]</span></h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class T , class T_id , const T_id ID, class T_size , T_size N_align&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">std::ostream &amp; operator&lt;&lt; </td>
<td>(</td>
<td class="paramtype">std::ostream &amp;</td> <td class="paramname"><span class="paramname"><em>stream</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classstdex_1_1idrec_1_1record.html">record</a>&lt; T, T_id, ID, T_size, N_align &gt;</td> <td class="paramname"><span class="paramname"><em>r</em></span>&#160;)</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">friend</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Writes record to a stream. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">stream</td><td>Output stream </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">r</td><td>Record</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The stream <code>stream</code> </dd></dl>
</div>
</div>
<a id="a01c94bd3b5997913561015f13e89de6c" name="a01c94bd3b5997913561015f13e89de6c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a01c94bd3b5997913561015f13e89de6c">&#9670;&#160;</a></span>operator&lt;&lt; <span class="overload">[2/3]</span></h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class T , class T_id , const T_id ID, class T_size , T_size N_align&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classstdex_1_1stream_1_1basic.html">stdex::stream::basic</a> &amp; operator&lt;&lt; </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classstdex_1_1stream_1_1basic.html">stdex::stream::basic</a> &amp;</td> <td class="paramname"><span class="paramname"><em>stream</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classstdex_1_1idrec_1_1record.html">record</a>&lt; T, T_id, ID, T_size, N_align &gt;</td> <td class="paramname"><span class="paramname"><em>r</em></span>&#160;)</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">friend</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Writes record to a stream. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">stream</td><td>Output stream </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">r</td><td>Record</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The stream <code>stream</code> </dd></dl>
</div>
</div>
<a id="a454b67be32aac0b420eb173c37aef149" name="a454b67be32aac0b420eb173c37aef149"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a454b67be32aac0b420eb173c37aef149">&#9670;&#160;</a></span>operator&lt;&lt; <span class="overload">[3/3]</span></h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class T , class T_id , const T_id ID, class T_size , T_size N_align&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classstdex_1_1stream_1_1basic__file.html">stdex::stream::basic_file</a> &amp; operator&lt;&lt; </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classstdex_1_1stream_1_1basic__file.html">stdex::stream::basic_file</a> &amp;</td> <td class="paramname"><span class="paramname"><em>stream</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classstdex_1_1idrec_1_1record.html">record</a>&lt; T, T_id, ID, T_size, N_align &gt;</td> <td class="paramname"><span class="paramname"><em>r</em></span>&#160;)</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">friend</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Writes record to a file. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">stream</td><td>Output file </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">r</td><td>Record</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The stream <code>stream</code> </dd></dl>
</div>
</div>
<a id="a8f2fa168ba01d9df647e166a9799bd63" name="a8f2fa168ba01d9df647e166a9799bd63"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8f2fa168ba01d9df647e166a9799bd63">&#9670;&#160;</a></span>operator&gt;&gt; <span class="overload">[1/3]</span></h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class T , class T_id , const T_id ID, class T_size , T_size N_align&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">std::istream &amp; operator&gt;&gt; </td>
<td>(</td>
<td class="paramtype">std::istream &amp;</td> <td class="paramname"><span class="paramname"><em>stream</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classstdex_1_1idrec_1_1record.html">record</a>&lt; T, T_id, ID, T_size, N_align &gt;</td> <td class="paramname"><span class="paramname"><em>r</em></span>&#160;)</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">friend</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Reads record from a stream. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">stream</td><td>Input stream </td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">r</td><td>Record</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The stream <code>stream</code> </dd></dl>
</div>
</div>
<a id="a944280f0451d647f8b32bd0082937864" name="a944280f0451d647f8b32bd0082937864"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a944280f0451d647f8b32bd0082937864">&#9670;&#160;</a></span>operator&gt;&gt; <span class="overload">[2/3]</span></h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class T , class T_id , const T_id ID, class T_size , T_size N_align&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classstdex_1_1stream_1_1basic.html">stdex::stream::basic</a> &amp; operator&gt;&gt; </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classstdex_1_1stream_1_1basic.html">stdex::stream::basic</a> &amp;</td> <td class="paramname"><span class="paramname"><em>stream</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classstdex_1_1idrec_1_1record.html">record</a>&lt; T, T_id, ID, T_size, N_align &gt;</td> <td class="paramname"><span class="paramname"><em>r</em></span>&#160;)</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">friend</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Reads record from a stream. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">stream</td><td>Input stream </td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">r</td><td>Record</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The stream <code>stream</code> </dd></dl>
</div>
</div>
<a id="a74a44367e182a7c1ce600e61495aa7ff" name="a74a44367e182a7c1ce600e61495aa7ff"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a74a44367e182a7c1ce600e61495aa7ff">&#9670;&#160;</a></span>operator&gt;&gt; <span class="overload">[3/3]</span></h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class T , class T_id , const T_id ID, class T_size , T_size N_align&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classstdex_1_1stream_1_1basic__file.html">stdex::stream::basic_file</a> &amp; operator&gt;&gt; </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classstdex_1_1stream_1_1basic__file.html">stdex::stream::basic_file</a> &amp;</td> <td class="paramname"><span class="paramname"><em>stream</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classstdex_1_1idrec_1_1record.html">record</a>&lt; T, T_id, ID, T_size, N_align &gt;</td> <td class="paramname"><span class="paramname"><em>r</em></span>&#160;)</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">friend</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Reads record from a file. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">stream</td><td>Input file </td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">r</td><td>Record</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The stream <code>stream</code> </dd></dl>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>include/stdex/<a class="el" href="idrec_8hpp_source.html">idrec.hpp</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Mon May 27 2024 10:18:28 for stdex by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.11.0
</small></address>
</div><!-- doc-content -->
</body>
</html>