xfygogo
/
phasicFlow
mirror of https://github.com/PhasicFlow/phasicFlow.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
phasicFlow/doc/code-documentation/html/classpFlow_1_1IOobject_1_1o...

369 lines
20 KiB
HTML
Raw Blame History

<!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.17"/>
<title>PhasicFlow: IOobject::object_t&lt; dataType &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="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.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>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function() { init_search(); });
/* @license-end */
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="customdoxygen.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 id="projectalign" style="padding-left: 0.5em;">
<div id="projectname"><a href="https://cemf.ir">PhasicFlow</a>
&#160;<span id="projectnumber"><a href="https://cemf.ir">v0.1</a></span>
</div>
<div id="projectbrief"><a href="www.github.com/PhasicFlow">www.cemf.ir</a></div>
</td>
<td> <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>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.17 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search');
/* @license-end */
</script>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('classpFlow_1_1IOobject_1_1object__t.html',''); initResizable(); });
/* @license-end */
</script>
<div id="doc-content">
<!-- 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">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pub-attribs">Public Attributes</a> &#124;
<a href="classpFlow_1_1IOobject_1_1object__t-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">IOobject::object_t&lt; dataType &gt; Class Template Reference</div> </div>
</div><!--header-->
<div class="contents">
<div class="dynheader">
Inheritance diagram for IOobject::object_t&lt; dataType &gt;:</div>
<div class="dyncontent">
<div class="center"><img src="classpFlow_1_1IOobject_1_1object__t__inherit__graph.png" border="0" usemap="#IOobject_1_1object__t_3_01dataType_01_4_inherit__map" alt="Inheritance graph"/></div>
<map name="IOobject_1_1object__t_3_01dataType_01_4_inherit__map" id="IOobject_1_1object__t_3_01dataType_01_4_inherit__map">
<area shape="rect" title=" " alt="" coords="5,80,141,121"/>
<area shape="rect" href="classpFlow_1_1IOobject_1_1iObject.html" title=" " alt="" coords="39,5,107,32"/>
</map>
<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
<div class="dynheader">
Collaboration diagram for IOobject::object_t&lt; dataType &gt;:</div>
<div class="dyncontent">
<div class="center"><img src="classpFlow_1_1IOobject_1_1object__t__coll__graph.png" border="0" usemap="#IOobject_1_1object__t_3_01dataType_01_4_coll__map" alt="Collaboration graph"/></div>
<map name="IOobject_1_1object__t_3_01dataType_01_4_coll__map" id="IOobject_1_1object__t_3_01dataType_01_4_coll__map">
<area shape="rect" title=" " alt="" coords="5,80,141,121"/>
<area shape="rect" href="classpFlow_1_1IOobject_1_1iObject.html" title=" " alt="" coords="39,5,107,32"/>
</map>
<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a4ab00941e125a622129d9669e6a9969d"><td class="memTemplParams" colspan="2">template&lt;typename... Args, typename = std::enable_if_t&lt;!std::is_constructible&lt;object_t, Args&amp;&amp;...&gt;::value&gt;&gt; </td></tr>
<tr class="memitem:a4ab00941e125a622129d9669e6a9969d"><td class="memTemplItemLeft" align="right" valign="top">&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classpFlow_1_1IOobject_1_1object__t.html#a4ab00941e125a622129d9669e6a9969d">object_t</a> (Args &amp;&amp;... args)</td></tr>
<tr class="separator:a4ab00941e125a622129d9669e6a9969d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aabff59a098a161ad52c86980852db7db"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpFlow_1_1IOobject_1_1object__t.html#aabff59a098a161ad52c86980852db7db">object_t</a> (const dataType &amp;data)</td></tr>
<tr class="separator:aabff59a098a161ad52c86980852db7db"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a22193b42140a693bd2c4a9bddc56d826"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classpFlow_1_1uniquePtr.html">uniquePtr</a>&lt; <a class="el" href="classpFlow_1_1IOobject_1_1iObject.html">iObject</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpFlow_1_1IOobject_1_1object__t.html#a22193b42140a693bd2c4a9bddc56d826">clone</a> () const</td></tr>
<tr class="separator:a22193b42140a693bd2c4a9bddc56d826"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a39359f8faf12774491014a93a9c930e1"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="namespacepFlow.html#a0ebe792a293e8c717bddf60070c0fe99">word</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpFlow_1_1IOobject_1_1object__t.html#a39359f8faf12774491014a93a9c930e1">typeName</a> () const</td></tr>
<tr class="separator:a39359f8faf12774491014a93a9c930e1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a57192604d396c82e4297a09dcd9457a8"><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpFlow_1_1IOobject_1_1object__t.html#a57192604d396c82e4297a09dcd9457a8">read_object_t</a> (<a class="el" href="classpFlow_1_1iIstream.html">iIstream</a> &amp;is)</td></tr>
<tr class="separator:a57192604d396c82e4297a09dcd9457a8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a700659b492de040bcaba50ca7ce362f7"><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpFlow_1_1IOobject_1_1object__t.html#a700659b492de040bcaba50ca7ce362f7">write_object_t</a> (<a class="el" href="classpFlow_1_1iOstream.html">iOstream</a> &amp;os) const</td></tr>
<tr class="separator:a700659b492de040bcaba50ca7ce362f7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pub_methods_classpFlow_1_1IOobject_1_1iObject"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classpFlow_1_1IOobject_1_1iObject')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="classpFlow_1_1IOobject_1_1iObject.html">IOobject::iObject</a></td></tr>
<tr class="memitem:a0f45fd6684c1173e7de3d344a35f9967 inherit pub_methods_classpFlow_1_1IOobject_1_1iObject"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpFlow_1_1IOobject_1_1iObject.html#a0f45fd6684c1173e7de3d344a35f9967">~iObject</a> ()=default</td></tr>
<tr class="separator:a0f45fd6684c1173e7de3d344a35f9967 inherit pub_methods_classpFlow_1_1IOobject_1_1iObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
Public Attributes</h2></td></tr>
<tr class="memitem:ab875ff0d9fe05289966cf4a20f477bc3"><td class="memItemLeft" align="right" valign="top">dataType&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpFlow_1_1IOobject_1_1object__t.html#ab875ff0d9fe05289966cf4a20f477bc3">data_</a></td></tr>
<tr class="separator:ab875ff0d9fe05289966cf4a20f477bc3"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><h3>template&lt;typename dataType&gt;<br />
class pFlow::IOobject::object_t&lt; dataType &gt;</h3>
<p class="definition">Definition at line <a class="el" href="IOobject_8hpp_source.html#l00060">60</a> of file <a class="el" href="IOobject_8hpp_source.html">IOobject.hpp</a>.</p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a4ab00941e125a622129d9669e6a9969d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4ab00941e125a622129d9669e6a9969d">&#9670;&nbsp;</a></span>object_t() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classpFlow_1_1IOobject_1_1object__t.html">object_t</a> </td>
<td>(</td>
<td class="paramtype">Args &amp;&amp;...&#160;</td>
<td class="paramname"><em>args</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 class="definition">Definition at line <a class="el" href="IOobject_8hpp_source.html#l00071">71</a> of file <a class="el" href="IOobject_8hpp_source.html">IOobject.hpp</a>.</p>
</div>
</div>
<a id="aabff59a098a161ad52c86980852db7db"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aabff59a098a161ad52c86980852db7db">&#9670;&nbsp;</a></span>object_t() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classpFlow_1_1IOobject_1_1object__t.html">object_t</a> </td>
<td>(</td>
<td class="paramtype">const dataType &amp;&#160;</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">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="IOobject_8hpp_source.html#l00077">77</a> of file <a class="el" href="IOobject_8hpp_source.html">IOobject.hpp</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a22193b42140a693bd2c4a9bddc56d826"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a22193b42140a693bd2c4a9bddc56d826">&#9670;&nbsp;</a></span>clone()</h2>
<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="classpFlow_1_1uniquePtr.html">uniquePtr</a>&lt;<a class="el" href="classpFlow_1_1IOobject_1_1iObject.html">iObject</a>&gt; clone </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">inline</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Implements <a class="el" href="classpFlow_1_1IOobject_1_1iObject.html#a831f01cd8f6d17500151d738cc6f220a">IOobject::iObject</a>.</p>
<p class="definition">Definition at line <a class="el" href="IOobject_8hpp_source.html#l00083">83</a> of file <a class="el" href="IOobject_8hpp_source.html">IOobject.hpp</a>.</p>
</div>
</div>
<a id="a39359f8faf12774491014a93a9c930e1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a39359f8faf12774491014a93a9c930e1">&#9670;&nbsp;</a></span>typeName()</h2>
<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="namespacepFlow.html#a0ebe792a293e8c717bddf60070c0fe99">word</a> typeName </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">inline</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Implements <a class="el" href="classpFlow_1_1IOobject_1_1iObject.html#a9521838a2604fc381c2b4d8227615246">IOobject::iObject</a>.</p>
<p class="definition">Definition at line <a class="el" href="IOobject_8hpp_source.html#l00088">88</a> of file <a class="el" href="IOobject_8hpp_source.html">IOobject.hpp</a>.</p>
<p class="reference">References <a class="el" href="IOobject_8hpp_source.html#l00065">IOobject::object_t&lt; dataType &gt;::data_</a>.</p>
</div>
</div>
<a id="a57192604d396c82e4297a09dcd9457a8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a57192604d396c82e4297a09dcd9457a8">&#9670;&nbsp;</a></span>read_object_t()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual bool read_object_t </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classpFlow_1_1iIstream.html">iIstream</a> &amp;&#160;</td>
<td class="paramname"><em>is</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Implements <a class="el" href="classpFlow_1_1IOobject_1_1iObject.html#a8165d6de31ac20289519d262720b3dea">IOobject::iObject</a>.</p>
<p class="definition">Definition at line <a class="el" href="IOobject_8hpp_source.html#l00093">93</a> of file <a class="el" href="IOobject_8hpp_source.html">IOobject.hpp</a>.</p>
<p class="reference">References <a class="el" href="IOobject_8hpp_source.html#l00065">IOobject::object_t&lt; dataType &gt;::data_</a>.</p>
</div>
</div>
<a id="a700659b492de040bcaba50ca7ce362f7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a700659b492de040bcaba50ca7ce362f7">&#9670;&nbsp;</a></span>write_object_t()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual bool write_object_t </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classpFlow_1_1iOstream.html">iOstream</a> &amp;&#160;</td>
<td class="paramname"><em>os</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Implements <a class="el" href="classpFlow_1_1IOobject_1_1iObject.html#acf2f75d89144d08deff2a16d5eccfbfa">IOobject::iObject</a>.</p>
<p class="definition">Definition at line <a class="el" href="IOobject_8hpp_source.html#l00098">98</a> of file <a class="el" href="IOobject_8hpp_source.html">IOobject.hpp</a>.</p>
<p class="reference">References <a class="el" href="IOobject_8hpp_source.html#l00065">IOobject::object_t&lt; dataType &gt;::data_</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a id="ab875ff0d9fe05289966cf4a20f477bc3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab875ff0d9fe05289966cf4a20f477bc3">&#9670;&nbsp;</a></span>data_</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">dataType data_</td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="IOobject_8hpp_source.html#l00065">65</a> of file <a class="el" href="IOobject_8hpp_source.html">IOobject.hpp</a>.</p>
<p class="reference">Referenced by <a class="el" href="IOobjectTemplates_8cpp_source.html#l00042">IOobject::getObject()</a>, <a class="el" href="IOobject_8hpp_source.html#l00093">IOobject::object_t&lt; dataType &gt;::read_object_t()</a>, <a class="el" href="IOobject_8hpp_source.html#l00088">IOobject::object_t&lt; dataType &gt;::typeName()</a>, and <a class="el" href="IOobject_8hpp_source.html#l00098">IOobject::object_t&lt; dataType &gt;::write_object_t()</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>src/phasicFlow/repository/IOobject/<a class="el" href="IOobject_8hpp_source.html">IOobject.hpp</a></li>
</ul>
</div><!-- contents -->
</div><!-- doc-content -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="namespacepFlow.html">pFlow</a></li><li class="navelem"><a class="el" href="classpFlow_1_1IOobject.html">IOobject</a></li><li class="navelem"><a class="el" href="classpFlow_1_1IOobject_1_1object__t.html">object_t</a></li>
<li class="footer">Generated by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.17 </li>
</ul>
</div>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink