Amebis/stdex
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
stdex/classstdex_1_1idrec_1_1record.html

387 lines
19 KiB
HTML
Raw Blame History

<!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.9.7"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>stdex: stdex::idrec::record&lt; T, T_ID, ID, T_SIZE, 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>
<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.9.7 -->
<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" 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');
$(document).ready(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
<!-- 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 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="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, 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="classstdex_1_1idrec_1_1record.html#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:a611da3801d9e7215324c9a5992a27f39"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classstdex_1_1idrec_1_1record.html#a611da3801d9e7215324c9a5992a27f39">record</a> (T &amp;d)</td></tr>
<tr class="memdesc:a611da3801d9e7215324c9a5992a27f39"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructs the class. <br /></td></tr>
<tr class="separator:a611da3801d9e7215324c9a5992a27f39"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab84a09093bd1a2cbf720329b84c6d73b"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classstdex_1_1idrec_1_1record.html#ab84a09093bd1a2cbf720329b84c6d73b">record</a> (const T &amp;d)</td></tr>
<tr class="memdesc:ab84a09093bd1a2cbf720329b84c6d73b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructs the class. <br /></td></tr>
<tr class="separator:ab84a09093bd1a2cbf720329b84c6d73b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3d4bff1bf080fb8cb3960b5b5018392c"><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, ALIGN &gt; &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classstdex_1_1idrec_1_1record.html#a3d4bff1bf080fb8cb3960b5b5018392c">operator=</a> (const <a class="el" href="classstdex_1_1idrec_1_1record.html">record</a>&lt; T, T_ID, ID, T_SIZE, ALIGN &gt; &amp;r)</td></tr>
<tr class="memdesc:a3d4bff1bf080fb8cb3960b5b5018392c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Assignment operator. <br /></td></tr>
<tr class="separator:a3d4bff1bf080fb8cb3960b5b5018392c"><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:a24e54541a476b01e332290c57a495926"><td class="memItemLeft" align="right" valign="top"><a id="a24e54541a476b01e332290c57a495926" name="a24e54541a476b01e332290c57a495926"></a>
static const T_ID&#160;</td><td class="memItemRight" valign="bottom"><b>id</b> ()</td></tr>
<tr class="memdesc:a24e54541a476b01e332290c57a495926"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns record id. <br /></td></tr>
<tr class="separator:a24e54541a476b01e332290c57a495926"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a379d9eeac3c52375982ba75df33604ca"><td class="memItemLeft" align="right" valign="top">static std::streamoff&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classstdex_1_1idrec_1_1record.html#a379d9eeac3c52375982ba75df33604ca">open</a> (std::ostream &amp;stream)</td></tr>
<tr class="memdesc:a379d9eeac3c52375982ba75df33604ca"><td class="mdescLeft">&#160;</td><td class="mdescRight">Writes record header. <br /></td></tr>
<tr class="separator:a379d9eeac3c52375982ba75df33604ca"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae63ba9487daaf8ec39dfe7dd04c13cc9"><td class="memItemLeft" align="right" valign="top">static std::streamoff&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classstdex_1_1idrec_1_1record.html#ae63ba9487daaf8ec39dfe7dd04c13cc9">close</a> (std::ostream &amp;stream, std::streamoff start)</td></tr>
<tr class="memdesc:ae63ba9487daaf8ec39dfe7dd04c13cc9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Updates record header. <br /></td></tr>
<tr class="separator:ae63ba9487daaf8ec39dfe7dd04c13cc9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a19523040d07119055884a7a2f8ef25fd"><td class="memItemLeft" align="right" valign="top">static bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classstdex_1_1idrec_1_1record.html#a19523040d07119055884a7a2f8ef25fd">find</a> (std::istream &amp;stream, std::streamoff end=(std::streamoff) -1)</td></tr>
<tr class="memdesc:a19523040d07119055884a7a2f8ef25fd"><td class="mdescLeft">&#160;</td><td class="mdescRight">Finds record data. <br /></td></tr>
<tr class="separator:a19523040d07119055884a7a2f8ef25fd"><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:a1ab09fae53142836c958a63137fb37cb"><td class="memItemLeft" align="right" valign="top"><a id="a1ab09fae53142836c958a63137fb37cb" name="a1ab09fae53142836c958a63137fb37cb"></a>
T &amp;&#160;</td><td class="memItemRight" valign="bottom"><b>data</b></td></tr>
<tr class="memdesc:a1ab09fae53142836c958a63137fb37cb"><td class="mdescLeft">&#160;</td><td class="mdescRight">Record data reference. <br /></td></tr>
<tr class="separator:a1ab09fae53142836c958a63137fb37cb"><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, unsigned int ALIGN&gt;<br />
class stdex::idrec::record&lt; T, T_ID, ID, T_SIZE, 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="a611da3801d9e7215324c9a5992a27f39" name="a611da3801d9e7215324c9a5992a27f39"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a611da3801d9e7215324c9a5992a27f39">&#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 , unsigned int 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, ALIGN &gt;::record </td>
<td>(</td>
<td class="paramtype">T &amp;&#160;</td>
<td class="paramname"><em>d</em></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="ab84a09093bd1a2cbf720329b84c6d73b" name="ab84a09093bd1a2cbf720329b84c6d73b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab84a09093bd1a2cbf720329b84c6d73b">&#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 , unsigned int 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, ALIGN &gt;::record </td>
<td>(</td>
<td class="paramtype">const T &amp;&#160;</td>
<td class="paramname"><em>d</em></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="ae63ba9487daaf8ec39dfe7dd04c13cc9" name="ae63ba9487daaf8ec39dfe7dd04c13cc9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae63ba9487daaf8ec39dfe7dd04c13cc9">&#9670;&#160;</a></span>close()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class T , class T_ID , const T_ID ID, class T_SIZE , unsigned int 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, ALIGN &gt;::close </td>
<td>(</td>
<td class="paramtype">std::ostream &amp;&#160;</td>
<td class="paramname"><em>stream</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">std::streamoff&#160;</td>
<td class="paramname"><em>start</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</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>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="a19523040d07119055884a7a2f8ef25fd" name="a19523040d07119055884a7a2f8ef25fd"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a19523040d07119055884a7a2f8ef25fd">&#9670;&#160;</a></span>find()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class T , class T_ID , const T_ID ID, class T_SIZE , unsigned int 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, ALIGN &gt;::find </td>
<td>(</td>
<td class="paramtype">std::istream &amp;&#160;</td>
<td class="paramname"><em>stream</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">std::streamoff&#160;</td>
<td class="paramname"><em>end</em> = <code>(std::streamoff)-1</code>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</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>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="a379d9eeac3c52375982ba75df33604ca" name="a379d9eeac3c52375982ba75df33604ca"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a379d9eeac3c52375982ba75df33604ca">&#9670;&#160;</a></span>open()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class T , class T_ID , const T_ID ID, class T_SIZE , unsigned int 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, ALIGN &gt;::open </td>
<td>(</td>
<td class="paramtype">std::ostream &amp;&#160;</td>
<td class="paramname"><em>stream</em></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="a3d4bff1bf080fb8cb3960b5b5018392c" name="a3d4bff1bf080fb8cb3960b5b5018392c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3d4bff1bf080fb8cb3960b5b5018392c">&#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 , unsigned int 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, ALIGN &gt; &amp; <a class="el" href="classstdex_1_1idrec_1_1record.html">stdex::idrec::record</a>&lt; T, T_ID, ID, T_SIZE, 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, ALIGN &gt; &amp;&#160;</td>
<td class="paramname"><em>r</em></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>
<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 Wed Jul 26 2023 10:18:12 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.9.7
</small></address>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink