603 lines
32 KiB
HTML
603 lines
32 KiB
HTML
<!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"/>
|
|
<meta name="description" content="PhasicFlow is an open-source parallel DEM (discrete element method) package for simulating granular flow. It is developed in C++ and can be exectued on both GPU (like CUDA) and CPU.">
|
|
<title>PhasicFlow: fileStream 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="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&dn=gpl-2.0.txt GPL-v2 */
|
|
$(document).ready(function() { init_search(); });
|
|
/* @license-end */
|
|
</script>
|
|
<script type="text/x-mathjax-config">
|
|
MathJax.Hub.Config({
|
|
extensions: ["tex2jax.js"],
|
|
jax: ["input/TeX","output/HTML-CSS"],
|
|
});
|
|
</script>
|
|
<script type="text/javascript" async="async" src="http://cdn.mathjax.org/mathjax/latest/MathJax.js"></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" >
|
|
<tbody>
|
|
<tr>
|
|
<td id="projectlogo"><a href="https://github.com/PhasicFlow"><img alt="Logo" src="phasicFlow_logo.png"></a></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>
|
|
<tr>
|
|
<td id="projectbrief">
|
|
<a href="https://https://cemf.ir">www.cemf.ir</a>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.8.17 -->
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&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&dn=gpl-2.0.txt GPL-v2 */
|
|
$(document).ready(function(){initNavTree('classpFlow_1_1fileStream.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> |
|
|
<a href="#pro-methods">Protected Member Functions</a> |
|
|
<a href="#pro-attribs">Protected Attributes</a> |
|
|
<a href="classpFlow_1_1fileStream-members.html">List of all members</a> </div>
|
|
<div class="headertitle">
|
|
<div class="title">fileStream Class Reference</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
|
|
<p>Creates and manages an input/output file stream with specified format.
|
|
<a href="classpFlow_1_1fileStream.html#details">More...</a></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 fileStream:</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="classpFlow_1_1fileStream__inherit__graph.png" border="0" usemap="#fileStream_inherit__map" alt="Inheritance graph"/></div>
|
|
<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
|
|
<div id="dynsection-1" onclick="return toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;">
|
|
<img id="dynsection-1-trigger" src="closed.png" alt="+"/> Collaboration diagram for fileStream:</div>
|
|
<div id="dynsection-1-summary" class="dynsummary" style="display:block;">
|
|
</div>
|
|
<div id="dynsection-1-content" class="dyncontent" style="display:none;">
|
|
<div class="center"><img src="classpFlow_1_1fileStream__coll__graph.png" border="0" usemap="#fileStream_coll__map" alt="Collaboration graph"/></div>
|
|
<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:a780823f516935e79254a4fdc28e13ac0"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classpFlow_1_1fileStream.html#a780823f516935e79254a4fdc28e13ac0">fileStream</a> (const <a class="el" href="classpFlow_1_1fileSystem.html">fileSystem</a> &path, bool <a class="el" href="classpFlow_1_1fileStream.html#af3458b34a937eb333ae314095c7725d6">outStream</a>=false, bool binary=false, bool append=false)</td></tr>
|
|
<tr class="memdesc:a780823f516935e79254a4fdc28e13ac0"><td class="mdescLeft"> </td><td class="mdescRight">From file path and input type and format. <a href="classpFlow_1_1fileStream.html#a780823f516935e79254a4fdc28e13ac0">More...</a><br /></td></tr>
|
|
<tr class="separator:a780823f516935e79254a4fdc28e13ac0"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a5d86209d8fe5bac3eacf5301cfaf60e0"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classpFlow_1_1fileStream.html#a5d86209d8fe5bac3eacf5301cfaf60e0">fileStream</a> (const <a class="el" href="classpFlow_1_1fileStream.html">fileStream</a> &)=delete</td></tr>
|
|
<tr class="memdesc:a5d86209d8fe5bac3eacf5301cfaf60e0"><td class="mdescLeft"> </td><td class="mdescRight">No copy. <a href="classpFlow_1_1fileStream.html#a5d86209d8fe5bac3eacf5301cfaf60e0">More...</a><br /></td></tr>
|
|
<tr class="separator:a5d86209d8fe5bac3eacf5301cfaf60e0"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a2ccd493a7a643ff561506567f4d7cc72"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classpFlow_1_1fileStream.html">fileStream</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classpFlow_1_1fileStream.html#a2ccd493a7a643ff561506567f4d7cc72">operator=</a> (const <a class="el" href="classpFlow_1_1fileStream.html">fileStream</a> &)=delete</td></tr>
|
|
<tr class="memdesc:a2ccd493a7a643ff561506567f4d7cc72"><td class="mdescLeft"> </td><td class="mdescRight">No assignment. <a href="classpFlow_1_1fileStream.html#a2ccd493a7a643ff561506567f4d7cc72">More...</a><br /></td></tr>
|
|
<tr class="separator:a2ccd493a7a643ff561506567f4d7cc72"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a5fe998970d1259a6c509c88724a8a599"><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classpFlow_1_1fileStream.html#a5fe998970d1259a6c509c88724a8a599">~fileStream</a> ()</td></tr>
|
|
<tr class="memdesc:a5fe998970d1259a6c509c88724a8a599"><td class="mdescLeft"> </td><td class="mdescRight">Destructor. <a href="classpFlow_1_1fileStream.html#a5fe998970d1259a6c509c88724a8a599">More...</a><br /></td></tr>
|
|
<tr class="separator:a5fe998970d1259a6c509c88724a8a599"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a3bcd8dda96066183fbf2024b67915655"><td class="memItemLeft" align="right" valign="top">std::ifstream & </td><td class="memItemRight" valign="bottom"><a class="el" href="classpFlow_1_1fileStream.html#a3bcd8dda96066183fbf2024b67915655">inStream</a> ()</td></tr>
|
|
<tr class="memdesc:a3bcd8dda96066183fbf2024b67915655"><td class="mdescLeft"> </td><td class="mdescRight">Access input file stream. <a href="classpFlow_1_1fileStream.html#a3bcd8dda96066183fbf2024b67915655">More...</a><br /></td></tr>
|
|
<tr class="separator:a3bcd8dda96066183fbf2024b67915655"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:af3458b34a937eb333ae314095c7725d6"><td class="memItemLeft" align="right" valign="top">std::ofstream & </td><td class="memItemRight" valign="bottom"><a class="el" href="classpFlow_1_1fileStream.html#af3458b34a937eb333ae314095c7725d6">outStream</a> ()</td></tr>
|
|
<tr class="memdesc:af3458b34a937eb333ae314095c7725d6"><td class="mdescLeft"> </td><td class="mdescRight">Access output file stream. <a href="classpFlow_1_1fileStream.html#af3458b34a937eb333ae314095c7725d6">More...</a><br /></td></tr>
|
|
<tr class="separator:af3458b34a937eb333ae314095c7725d6"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-methods"></a>
|
|
Protected Member Functions</h2></td></tr>
|
|
<tr class="memitem:a2202773d095b6ad3bd8186c6b4ef1458"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classpFlow_1_1fileStream.html#a2202773d095b6ad3bd8186c6b4ef1458">openInFile</a> (const <a class="el" href="classpFlow_1_1fileSystem.html">fileSystem</a> &path)</td></tr>
|
|
<tr class="memdesc:a2202773d095b6ad3bd8186c6b4ef1458"><td class="mdescLeft"> </td><td class="mdescRight">open input file <a href="classpFlow_1_1fileStream.html#a2202773d095b6ad3bd8186c6b4ef1458">More...</a><br /></td></tr>
|
|
<tr class="separator:a2202773d095b6ad3bd8186c6b4ef1458"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a8d6b427b76776c3ef060ad31d8ea44fd"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classpFlow_1_1fileStream.html#a8d6b427b76776c3ef060ad31d8ea44fd">openOutFile</a> (const <a class="el" href="classpFlow_1_1fileSystem.html">fileSystem</a> &path)</td></tr>
|
|
<tr class="memdesc:a8d6b427b76776c3ef060ad31d8ea44fd"><td class="mdescLeft"> </td><td class="mdescRight">open output file <a href="classpFlow_1_1fileStream.html#a8d6b427b76776c3ef060ad31d8ea44fd">More...</a><br /></td></tr>
|
|
<tr class="separator:a8d6b427b76776c3ef060ad31d8ea44fd"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a5ae591df94fc66ccb85cbb6565368bca"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classpFlow_1_1fileStream.html#a5ae591df94fc66ccb85cbb6565368bca">close</a> ()</td></tr>
|
|
<tr class="memdesc:a5ae591df94fc66ccb85cbb6565368bca"><td class="mdescLeft"> </td><td class="mdescRight">close streams <a href="classpFlow_1_1fileStream.html#a5ae591df94fc66ccb85cbb6565368bca">More...</a><br /></td></tr>
|
|
<tr class="separator:a5ae591df94fc66ccb85cbb6565368bca"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-attribs"></a>
|
|
Protected Attributes</h2></td></tr>
|
|
<tr class="memitem:a85cc66c39570389f63084c1b0a8c065b"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classpFlow_1_1uniquePtr.html">uniquePtr</a>< std::ifstream > </td><td class="memItemRight" valign="bottom"><a class="el" href="classpFlow_1_1fileStream.html#a85cc66c39570389f63084c1b0a8c065b">inStream_</a></td></tr>
|
|
<tr class="memdesc:a85cc66c39570389f63084c1b0a8c065b"><td class="mdescLeft"> </td><td class="mdescRight">in file stream <a href="classpFlow_1_1fileStream.html#a85cc66c39570389f63084c1b0a8c065b">More...</a><br /></td></tr>
|
|
<tr class="separator:a85cc66c39570389f63084c1b0a8c065b"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:af4210b27304c9ab2813b41ae934328d4"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classpFlow_1_1uniquePtr.html">uniquePtr</a>< std::ofstream > </td><td class="memItemRight" valign="bottom"><a class="el" href="classpFlow_1_1fileStream.html#af4210b27304c9ab2813b41ae934328d4">outStream_</a></td></tr>
|
|
<tr class="memdesc:af4210b27304c9ab2813b41ae934328d4"><td class="mdescLeft"> </td><td class="mdescRight">out file stream <a href="classpFlow_1_1fileStream.html#af4210b27304c9ab2813b41ae934328d4">More...</a><br /></td></tr>
|
|
<tr class="separator:af4210b27304c9ab2813b41ae934328d4"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ad139edcd5a95667fd99c314eccefa0a4"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classpFlow_1_1fileStream.html#ad139edcd5a95667fd99c314eccefa0a4">binary_</a> = false</td></tr>
|
|
<tr class="separator:ad139edcd5a95667fd99c314eccefa0a4"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a0c6d9e064a918fa590951f9236a3bce4"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classpFlow_1_1fileStream.html#a0c6d9e064a918fa590951f9236a3bce4">append_</a> = false</td></tr>
|
|
<tr class="separator:a0c6d9e064a918fa590951f9236a3bce4"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
|
<div class="textblock"><p>Creates and manages an input/output file stream with specified format. </p>
|
|
<p>It is based on OpenFOAM stream, with some modifications/simplifications to be tailored to our needs. </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="fileStream_8hpp_source.html#l00043">43</a> of file <a class="el" href="fileStream_8hpp_source.html">fileStream.hpp</a>.</p>
|
|
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
|
|
<a id="a780823f516935e79254a4fdc28e13ac0"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a780823f516935e79254a4fdc28e13ac0">◆ </a></span>fileStream() <span class="overload">[1/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="classpFlow_1_1fileStream.html">fileStream</a> </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const <a class="el" href="classpFlow_1_1fileSystem.html">fileSystem</a> & </td>
|
|
<td class="paramname"><em>path</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">bool </td>
|
|
<td class="paramname"><em>outStream</em> = <code>false</code>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">bool </td>
|
|
<td class="paramname"><em>binary</em> = <code>false</code>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">bool </td>
|
|
<td class="paramname"><em>append</em> = <code>false</code> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>From file path and input type and format. </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="fileStream_8cpp_source.html#l00120">120</a> of file <a class="el" href="fileStream_8cpp_source.html">fileStream.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a5d86209d8fe5bac3eacf5301cfaf60e0"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a5d86209d8fe5bac3eacf5301cfaf60e0">◆ </a></span>fileStream() <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_1fileStream.html">fileStream</a> </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const <a class="el" href="classpFlow_1_1fileStream.html">fileStream</a> & </td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">delete</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>No copy. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a5fe998970d1259a6c509c88724a8a599"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a5fe998970d1259a6c509c88724a8a599">◆ </a></span>~fileStream()</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_1fileStream.html">fileStream</a> </td>
|
|
<td>(</td>
|
|
<td class="paramname"></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>Destructor. </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="fileStream_8hpp_source.html#l00080">80</a> of file <a class="el" href="fileStream_8hpp_source.html">fileStream.hpp</a>.</p>
|
|
|
|
<p class="reference">References <a class="el" href="fileStream_8cpp_source.html#l00106">fileStream::close()</a>.</p>
|
|
<div id="dynsection-2" onclick="return toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;">
|
|
<img id="dynsection-2-trigger" src="closed.png" alt="+"/> Here is the call graph for this function:</div>
|
|
<div id="dynsection-2-summary" class="dynsummary" style="display:block;">
|
|
</div>
|
|
<div id="dynsection-2-content" class="dyncontent" style="display:none;">
|
|
<div class="center"><img src="classpFlow_1_1fileStream_a5fe998970d1259a6c509c88724a8a599_cgraph.png" border="0" usemap="#classpFlow_1_1fileStream_a5fe998970d1259a6c509c88724a8a599_cgraph" alt=""/></div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Member Function Documentation</h2>
|
|
<a id="a2202773d095b6ad3bd8186c6b4ef1458"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a2202773d095b6ad3bd8186c6b4ef1458">◆ </a></span>openInFile()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void openInFile </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const <a class="el" href="classpFlow_1_1fileSystem.html">fileSystem</a> & </td>
|
|
<td class="paramname"><em>path</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">protected</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>open input file </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="fileStream_8cpp_source.html#l00027">27</a> of file <a class="el" href="fileStream_8cpp_source.html">fileStream.cpp</a>.</p>
|
|
|
|
<p class="reference">References <a class="el" href="fileSystem_8cpp_source.html#l00192">fileSystem::exist()</a>, <a class="el" href="error_8hpp_source.html#l00077">fatalErrorInFunction</a>, <a class="el" href="error_8hpp_source.html#l00098">fatalExit</a>, and <a class="el" href="fileSystem_8hpp_source.html#l00160">fileSystem::wordPath()</a>.</p>
|
|
<div id="dynsection-3" onclick="return toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;">
|
|
<img id="dynsection-3-trigger" src="closed.png" alt="+"/> Here is the call graph for this function:</div>
|
|
<div id="dynsection-3-summary" class="dynsummary" style="display:block;">
|
|
</div>
|
|
<div id="dynsection-3-content" class="dyncontent" style="display:none;">
|
|
<div class="center"><img src="classpFlow_1_1fileStream_a2202773d095b6ad3bd8186c6b4ef1458_cgraph.png" border="0" usemap="#classpFlow_1_1fileStream_a2202773d095b6ad3bd8186c6b4ef1458_cgraph" alt=""/></div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a8d6b427b76776c3ef060ad31d8ea44fd"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a8d6b427b76776c3ef060ad31d8ea44fd">◆ </a></span>openOutFile()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void openOutFile </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const <a class="el" href="classpFlow_1_1fileSystem.html">fileSystem</a> & </td>
|
|
<td class="paramname"><em>path</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">protected</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>open output file </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="fileStream_8cpp_source.html#l00058">58</a> of file <a class="el" href="fileStream_8cpp_source.html">fileStream.cpp</a>.</p>
|
|
|
|
<p class="reference">References <a class="el" href="fileSystem_8cpp_source.html#l00208">fileSystem::createDirs()</a>, <a class="el" href="fileSystem_8cpp_source.html#l00091">fileSystem::dirPath()</a>, <a class="el" href="error_8hpp_source.html#l00077">fatalErrorInFunction</a>, <a class="el" href="error_8hpp_source.html#l00098">fatalExit</a>, and <a class="el" href="fileSystem_8hpp_source.html#l00160">fileSystem::wordPath()</a>.</p>
|
|
<div id="dynsection-4" onclick="return toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;">
|
|
<img id="dynsection-4-trigger" src="closed.png" alt="+"/> Here is the call graph for this function:</div>
|
|
<div id="dynsection-4-summary" class="dynsummary" style="display:block;">
|
|
</div>
|
|
<div id="dynsection-4-content" class="dyncontent" style="display:none;">
|
|
<div class="center"><img src="classpFlow_1_1fileStream_a8d6b427b76776c3ef060ad31d8ea44fd_cgraph.png" border="0" usemap="#classpFlow_1_1fileStream_a8d6b427b76776c3ef060ad31d8ea44fd_cgraph" alt=""/></div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a5ae591df94fc66ccb85cbb6565368bca"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a5ae591df94fc66ccb85cbb6565368bca">◆ </a></span>close()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void 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">protected</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>close streams </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="fileStream_8cpp_source.html#l00106">106</a> of file <a class="el" href="fileStream_8cpp_source.html">fileStream.cpp</a>.</p>
|
|
|
|
<p class="reference">References <a class="el" href="fileStream_8hpp_source.html#l00048">fileStream::inStream_</a>, and <a class="el" href="fileStream_8hpp_source.html#l00051">fileStream::outStream_</a>.</p>
|
|
|
|
<p class="reference">Referenced by <a class="el" href="fileStream_8hpp_source.html#l00080">fileStream::~fileStream()</a>.</p>
|
|
<div id="dynsection-5" onclick="return toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;">
|
|
<img id="dynsection-5-trigger" src="closed.png" alt="+"/> Here is the caller graph for this function:</div>
|
|
<div id="dynsection-5-summary" class="dynsummary" style="display:block;">
|
|
</div>
|
|
<div id="dynsection-5-content" class="dyncontent" style="display:none;">
|
|
<div class="center"><img src="classpFlow_1_1fileStream_a5ae591df94fc66ccb85cbb6565368bca_icgraph.png" border="0" usemap="#classpFlow_1_1fileStream_a5ae591df94fc66ccb85cbb6565368bca_icgraph" alt=""/></div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a2ccd493a7a643ff561506567f4d7cc72"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a2ccd493a7a643ff561506567f4d7cc72">◆ </a></span>operator=()</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_1fileStream.html">fileStream</a>& operator= </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const <a class="el" href="classpFlow_1_1fileStream.html">fileStream</a> & </td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">delete</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>No assignment. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a3bcd8dda96066183fbf2024b67915655"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a3bcd8dda96066183fbf2024b67915655">◆ </a></span>inStream()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">std::ifstream & inStream </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Access input file stream. </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="fileStream_8cpp_source.html#l00143">143</a> of file <a class="el" href="fileStream_8cpp_source.html">fileStream.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="af3458b34a937eb333ae314095c7725d6"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#af3458b34a937eb333ae314095c7725d6">◆ </a></span>outStream()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">std::ofstream & outStream </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Access output file stream. </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="fileStream_8cpp_source.html#l00148">148</a> of file <a class="el" href="fileStream_8cpp_source.html">fileStream.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Member Data Documentation</h2>
|
|
<a id="a85cc66c39570389f63084c1b0a8c065b"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a85cc66c39570389f63084c1b0a8c065b">◆ </a></span>inStream_</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_1uniquePtr.html">uniquePtr</a><std::ifstream> inStream_</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">protected</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>in file stream </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="fileStream_8hpp_source.html#l00048">48</a> of file <a class="el" href="fileStream_8hpp_source.html">fileStream.hpp</a>.</p>
|
|
|
|
<p class="reference">Referenced by <a class="el" href="fileStream_8cpp_source.html#l00106">fileStream::close()</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="af4210b27304c9ab2813b41ae934328d4"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#af4210b27304c9ab2813b41ae934328d4">◆ </a></span>outStream_</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_1uniquePtr.html">uniquePtr</a><std::ofstream> outStream_</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">protected</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>out file stream </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="fileStream_8hpp_source.html#l00051">51</a> of file <a class="el" href="fileStream_8hpp_source.html">fileStream.hpp</a>.</p>
|
|
|
|
<p class="reference">Referenced by <a class="el" href="fileStream_8cpp_source.html#l00106">fileStream::close()</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ad139edcd5a95667fd99c314eccefa0a4"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ad139edcd5a95667fd99c314eccefa0a4">◆ </a></span>binary_</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool binary_ = false</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">protected</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p class="definition">Definition at line <a class="el" href="fileStream_8hpp_source.html#l00053">53</a> of file <a class="el" href="fileStream_8hpp_source.html">fileStream.hpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a0c6d9e064a918fa590951f9236a3bce4"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a0c6d9e064a918fa590951f9236a3bce4">◆ </a></span>append_</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool append_ = false</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">protected</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p class="definition">Definition at line <a class="el" href="fileStream_8hpp_source.html#l00055">55</a> of file <a class="el" href="fileStream_8hpp_source.html">fileStream.hpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<hr/>The documentation for this class was generated from the following files:<ul>
|
|
<li>src/phasicFlow/streams/Fstream/<a class="el" href="fileStream_8hpp_source.html">fileStream.hpp</a></li>
|
|
<li>src/phasicFlow/streams/Fstream/<a class="el" href="fileStream_8cpp_source.html">fileStream.cpp</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_1fileStream.html">fileStream</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>
|