1074 lines
72 KiB
HTML
1074 lines
72 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: IOfileHeader 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_1IOfileHeader.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_1IOfileHeader-members.html">List of all members</a> </div>
|
|
<div class="headertitle">
|
|
<div class="title">IOfileHeader Class Reference</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<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 IOfileHeader:</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_1IOfileHeader__inherit__graph.png" border="0" usemap="#IOfileHeader_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 IOfileHeader:</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_1IOfileHeader__coll__graph.png" border="0" usemap="#IOfileHeader_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:a27694b34ae10a55819c0647e27e52424"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classpFlow_1_1IOfileHeader.html#a27694b34ae10a55819c0647e27e52424">IOfileHeader</a> (const <a class="el" href="classpFlow_1_1objectFile.html">objectFile</a> &objf)</td></tr>
|
|
<tr class="separator:a27694b34ae10a55819c0647e27e52424"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a4ae6d6ea877ec8652d86076eaf333c12"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="namespacepFlow.html#a0ebe792a293e8c717bddf60070c0fe99">word</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classpFlow_1_1IOfileHeader.html#a4ae6d6ea877ec8652d86076eaf333c12">objectName</a> () const</td></tr>
|
|
<tr class="separator:a4ae6d6ea877ec8652d86076eaf333c12"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a67068cb6552c42a5ddb1c66bf6bbf6b3"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="namespacepFlow.html#a0ebe792a293e8c717bddf60070c0fe99">word</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classpFlow_1_1IOfileHeader.html#a67068cb6552c42a5ddb1c66bf6bbf6b3">objectType</a> () const</td></tr>
|
|
<tr class="separator:a67068cb6552c42a5ddb1c66bf6bbf6b3"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a6fc6abb626e9155a819c52624443ca0c"><td class="memItemLeft" align="right" valign="top">virtual const <a class="el" href="classpFlow_1_1repository.html">repository</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classpFlow_1_1IOfileHeader.html#a6fc6abb626e9155a819c52624443ca0c">owner</a> () const</td></tr>
|
|
<tr class="separator:a6fc6abb626e9155a819c52624443ca0c"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:add8e03162ae5c99e43a6a512ef9b7e36"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classpFlow_1_1IOfileHeader.html#add8e03162ae5c99e43a6a512ef9b7e36">isIncluded</a> (const <a class="el" href="namespacepFlow.html#a0ebe792a293e8c717bddf60070c0fe99">word</a> &objName) const</td></tr>
|
|
<tr class="separator:add8e03162ae5c99e43a6a512ef9b7e36"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:af78fefb5053ee53f6846c61c61a3a1be"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classpFlow_1_1IOfileHeader.html#af78fefb5053ee53f6846c61c61a3a1be">isExcluded</a> (const <a class="el" href="namespacepFlow.html#a0ebe792a293e8c717bddf60070c0fe99">word</a> &objName) const</td></tr>
|
|
<tr class="separator:af78fefb5053ee53f6846c61c61a3a1be"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ae1921a7f20c43d1438221946e607c488"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classpFlow_1_1fileSystem.html">fileSystem</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classpFlow_1_1IOfileHeader.html#ae1921a7f20c43d1438221946e607c488">path</a> () const</td></tr>
|
|
<tr class="separator:ae1921a7f20c43d1438221946e607c488"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aefb380f32e3c6839d26dbc93ff4eb00a"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classpFlow_1_1IOfileHeader.html#aefb380f32e3c6839d26dbc93ff4eb00a">outFileBinary</a> () const</td></tr>
|
|
<tr class="separator:aefb380f32e3c6839d26dbc93ff4eb00a"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a6e04bca1658d3c571a38d8ac1d62462e"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classpFlow_1_1IOfileHeader.html#a6e04bca1658d3c571a38d8ac1d62462e">inFileBinary</a> () const</td></tr>
|
|
<tr class="separator:a6e04bca1658d3c571a38d8ac1d62462e"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a1a248aa0488b774d5160449992ad31e5"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classpFlow_1_1IOfileHeader.html#a1a248aa0488b774d5160449992ad31e5">headerOk</a> (bool silent=false)</td></tr>
|
|
<tr class="separator:a1a248aa0488b774d5160449992ad31e5"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aac13e923e67df5e79d9a75f592b97da3"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classpFlow_1_1IOfileHeader.html#aac13e923e67df5e79d9a75f592b97da3">implyRead</a> () const</td></tr>
|
|
<tr class="memdesc:aac13e923e67df5e79d9a75f592b97da3"><td class="mdescLeft"> </td><td class="mdescRight">Imply read. <a href="classpFlow_1_1IOfileHeader.html#aac13e923e67df5e79d9a75f592b97da3">More...</a><br /></td></tr>
|
|
<tr class="separator:aac13e923e67df5e79d9a75f592b97da3"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:adfb03998f9b3b981631dc794cffd05a1"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classpFlow_1_1IOfileHeader.html#adfb03998f9b3b981631dc794cffd05a1">implyWrite</a> () const</td></tr>
|
|
<tr class="memdesc:adfb03998f9b3b981631dc794cffd05a1"><td class="mdescLeft"> </td><td class="mdescRight">Imply write. <a href="classpFlow_1_1IOfileHeader.html#adfb03998f9b3b981631dc794cffd05a1">More...</a><br /></td></tr>
|
|
<tr class="separator:adfb03998f9b3b981631dc794cffd05a1"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ac38363de350016ce974d10db7d4d0753"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classpFlow_1_1IOfileHeader.html#ac38363de350016ce974d10db7d4d0753">fileExist</a> () const</td></tr>
|
|
<tr class="memdesc:ac38363de350016ce974d10db7d4d0753"><td class="mdescLeft"> </td><td class="mdescRight">Check if file exists. <a href="classpFlow_1_1IOfileHeader.html#ac38363de350016ce974d10db7d4d0753">More...</a><br /></td></tr>
|
|
<tr class="separator:ac38363de350016ce974d10db7d4d0753"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aad1bd18bfebe1913d2b10785c0aff822"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classpFlow_1_1IOfileHeader.html#aad1bd18bfebe1913d2b10785c0aff822">readIfPresent</a> () const</td></tr>
|
|
<tr class="memdesc:aad1bd18bfebe1913d2b10785c0aff822"><td class="mdescLeft"> </td><td class="mdescRight">Check read if present. <a href="classpFlow_1_1IOfileHeader.html#aad1bd18bfebe1913d2b10785c0aff822">More...</a><br /></td></tr>
|
|
<tr class="separator:aad1bd18bfebe1913d2b10785c0aff822"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a68bff73fd26a260a1d26e7890897d4e4"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classpFlow_1_1IOfileHeader.html#a68bff73fd26a260a1d26e7890897d4e4">writeHeader</a> () const</td></tr>
|
|
<tr class="memdesc:a68bff73fd26a260a1d26e7890897d4e4"><td class="mdescLeft"> </td><td class="mdescRight">Check if the header should be written to file True: on master + implyWrite + readWriteHeader = true False: otherwise. <a href="classpFlow_1_1IOfileHeader.html#a68bff73fd26a260a1d26e7890897d4e4">More...</a><br /></td></tr>
|
|
<tr class="separator:a68bff73fd26a260a1d26e7890897d4e4"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ab83d4ca3dd2d2995f15ffe5e2693f316"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classpFlow_1_1IOfileHeader.html#ab83d4ca3dd2d2995f15ffe5e2693f316">writeHeader</a> (<a class="el" href="classpFlow_1_1iOstream.html">iOstream</a> &os, const <a class="el" href="namespacepFlow.html#a0ebe792a293e8c717bddf60070c0fe99">word</a> &typeName, bool forceWrite=false) const</td></tr>
|
|
<tr class="memdesc:ab83d4ca3dd2d2995f15ffe5e2693f316"><td class="mdescLeft"> </td><td class="mdescRight">Write the header to the file , typeName comes from caller. <a href="classpFlow_1_1IOfileHeader.html#ab83d4ca3dd2d2995f15ffe5e2693f316">More...</a><br /></td></tr>
|
|
<tr class="separator:ab83d4ca3dd2d2995f15ffe5e2693f316"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a5d569ab3079ca594877dfbdf4d45cae4"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classpFlow_1_1IOfileHeader.html#a5d569ab3079ca594877dfbdf4d45cae4">writeHeader</a> (<a class="el" href="classpFlow_1_1iOstream.html">iOstream</a> &os, bool forceWrite=false) const</td></tr>
|
|
<tr class="memdesc:a5d569ab3079ca594877dfbdf4d45cae4"><td class="mdescLeft"> </td><td class="mdescRight">Write the header to the file, typeName comes from the one read from file. <a href="classpFlow_1_1IOfileHeader.html#a5d569ab3079ca594877dfbdf4d45cae4">More...</a><br /></td></tr>
|
|
<tr class="separator:a5d569ab3079ca594877dfbdf4d45cae4"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aaf27120b2528b8d3d77903c4f4481127"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classpFlow_1_1IOfileHeader.html#aaf27120b2528b8d3d77903c4f4481127">readHeader</a> () const</td></tr>
|
|
<tr class="memdesc:aaf27120b2528b8d3d77903c4f4481127"><td class="mdescLeft"> </td><td class="mdescRight">Check if header should be read from file. <a href="classpFlow_1_1IOfileHeader.html#aaf27120b2528b8d3d77903c4f4481127">More...</a><br /></td></tr>
|
|
<tr class="separator:aaf27120b2528b8d3d77903c4f4481127"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ad3e735fcc23f3717d149728c03f5074a"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classpFlow_1_1IOfileHeader.html#ad3e735fcc23f3717d149728c03f5074a">readHeader</a> (<a class="el" href="classpFlow_1_1iIstream.html">iIstream</a> &is, bool silent=false)</td></tr>
|
|
<tr class="memdesc:ad3e735fcc23f3717d149728c03f5074a"><td class="mdescLeft"> </td><td class="mdescRight">Read the header in the file. <a href="classpFlow_1_1IOfileHeader.html#ad3e735fcc23f3717d149728c03f5074a">More...</a><br /></td></tr>
|
|
<tr class="separator:ad3e735fcc23f3717d149728c03f5074a"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a935aedcbc2d9fc4e32646d718eaec1f4"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classpFlow_1_1IOfileHeader.html#a935aedcbc2d9fc4e32646d718eaec1f4">writeBanner</a> (<a class="el" href="classpFlow_1_1iOstream.html">iOstream</a> &os) const</td></tr>
|
|
<tr class="memdesc:a935aedcbc2d9fc4e32646d718eaec1f4"><td class="mdescLeft"> </td><td class="mdescRight">write the banner <a href="classpFlow_1_1IOfileHeader.html#a935aedcbc2d9fc4e32646d718eaec1f4">More...</a><br /></td></tr>
|
|
<tr class="separator:a935aedcbc2d9fc4e32646d718eaec1f4"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a7724614a5d68ca0d55beead4b79f6051"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classpFlow_1_1IOfileHeader.html#a7724614a5d68ca0d55beead4b79f6051">writeSeparator</a> (<a class="el" href="classpFlow_1_1iOstream.html">iOstream</a> &os) const</td></tr>
|
|
<tr class="memdesc:a7724614a5d68ca0d55beead4b79f6051"><td class="mdescLeft"> </td><td class="mdescRight">wirte a separator line <a href="classpFlow_1_1IOfileHeader.html#a7724614a5d68ca0d55beead4b79f6051">More...</a><br /></td></tr>
|
|
<tr class="separator:a7724614a5d68ca0d55beead4b79f6051"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="inherit_header pub_methods_classpFlow_1_1objectFile"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classpFlow_1_1objectFile')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="classpFlow_1_1objectFile.html">objectFile</a></td></tr>
|
|
<tr class="memitem:a03145445e47fe40d36071d3207e4eaae inherit pub_methods_classpFlow_1_1objectFile"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classpFlow_1_1objectFile.html#a03145445e47fe40d36071d3207e4eaae">objectFile</a> (const <a class="el" href="namespacepFlow.html#a0ebe792a293e8c717bddf60070c0fe99">word</a> &<a class="el" href="classpFlow_1_1objectFile.html#a754ce9966caae1ee331378bf4a87269b">name</a>)</td></tr>
|
|
<tr class="separator:a03145445e47fe40d36071d3207e4eaae inherit pub_methods_classpFlow_1_1objectFile"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a697165e3ce0c66f2e8b3cd10ceabbc1f inherit pub_methods_classpFlow_1_1objectFile"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classpFlow_1_1objectFile.html#a697165e3ce0c66f2e8b3cd10ceabbc1f">objectFile</a> (const <a class="el" href="namespacepFlow.html#a0ebe792a293e8c717bddf60070c0fe99">word</a> &<a class="el" href="classpFlow_1_1objectFile.html#a754ce9966caae1ee331378bf4a87269b">name</a>, const <a class="el" href="classpFlow_1_1fileSystem.html">fileSystem</a> &<a class="el" href="classpFlow_1_1objectFile.html#a55c0ceffcfed66ff50377088cbac2d8d">localPath</a>, const <a class="el" href="classpFlow_1_1objectFile.html#a314ebf993d731f5b477f5b2670de2135">readFlag</a> &rf=readFlag::READ_NEVER, const <a class="el" href="classpFlow_1_1objectFile.html#a167fce7aaf9bbff61e0e5ad4815d09fb">writeFlag</a> &wf=writeFlag::WRITE_NEVER, bool rwHeader=true)</td></tr>
|
|
<tr class="separator:a697165e3ce0c66f2e8b3cd10ceabbc1f inherit pub_methods_classpFlow_1_1objectFile"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:acfc22694eec3cb20477252e35e8d38c4 inherit pub_methods_classpFlow_1_1objectFile"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classpFlow_1_1objectFile.html#acfc22694eec3cb20477252e35e8d38c4">objectFile</a> (const <a class="el" href="classpFlow_1_1objectFile.html">objectFile</a> &src)=default</td></tr>
|
|
<tr class="separator:acfc22694eec3cb20477252e35e8d38c4 inherit pub_methods_classpFlow_1_1objectFile"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a0d9f2616944d55462ad8c9665b27086c inherit pub_methods_classpFlow_1_1objectFile"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classpFlow_1_1objectFile.html#a0d9f2616944d55462ad8c9665b27086c">objectFile</a> (<a class="el" href="classpFlow_1_1objectFile.html">objectFile</a> &&src)=default</td></tr>
|
|
<tr class="separator:a0d9f2616944d55462ad8c9665b27086c inherit pub_methods_classpFlow_1_1objectFile"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ad48d19db468e7a67e0ace83c38905e32 inherit pub_methods_classpFlow_1_1objectFile"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classpFlow_1_1objectFile.html">objectFile</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classpFlow_1_1objectFile.html#ad48d19db468e7a67e0ace83c38905e32">operator=</a> (const <a class="el" href="classpFlow_1_1objectFile.html">objectFile</a> &rhs)=default</td></tr>
|
|
<tr class="separator:ad48d19db468e7a67e0ace83c38905e32 inherit pub_methods_classpFlow_1_1objectFile"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a724fdc744ee41f5b154c325701f14c2d inherit pub_methods_classpFlow_1_1objectFile"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classpFlow_1_1objectFile.html">objectFile</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classpFlow_1_1objectFile.html#a724fdc744ee41f5b154c325701f14c2d">operator=</a> (<a class="el" href="classpFlow_1_1objectFile.html">objectFile</a> &&rhs)=default</td></tr>
|
|
<tr class="separator:a724fdc744ee41f5b154c325701f14c2d inherit pub_methods_classpFlow_1_1objectFile"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a5eb42fccb46707b1c231389b56ec574b inherit pub_methods_classpFlow_1_1objectFile"><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classpFlow_1_1objectFile.html#a5eb42fccb46707b1c231389b56ec574b">~objectFile</a> ()=default</td></tr>
|
|
<tr class="separator:a5eb42fccb46707b1c231389b56ec574b inherit pub_methods_classpFlow_1_1objectFile"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a754ce9966caae1ee331378bf4a87269b inherit pub_methods_classpFlow_1_1objectFile"><td class="memItemLeft" align="right" valign="top">virtual const <a class="el" href="namespacepFlow.html#a0ebe792a293e8c717bddf60070c0fe99">word</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classpFlow_1_1objectFile.html#a754ce9966caae1ee331378bf4a87269b">name</a> () const</td></tr>
|
|
<tr class="separator:a754ce9966caae1ee331378bf4a87269b inherit pub_methods_classpFlow_1_1objectFile"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a55c0ceffcfed66ff50377088cbac2d8d inherit pub_methods_classpFlow_1_1objectFile"><td class="memItemLeft" align="right" valign="top">virtual const <a class="el" href="classpFlow_1_1fileSystem.html">fileSystem</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classpFlow_1_1objectFile.html#a55c0ceffcfed66ff50377088cbac2d8d">localPath</a> () const</td></tr>
|
|
<tr class="separator:a55c0ceffcfed66ff50377088cbac2d8d inherit pub_methods_classpFlow_1_1objectFile"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a349924059ebb9ce3b154dbd6850c601d inherit pub_methods_classpFlow_1_1objectFile"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classpFlow_1_1objectFile.html#a314ebf993d731f5b477f5b2670de2135">readFlag</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classpFlow_1_1objectFile.html#a349924059ebb9ce3b154dbd6850c601d">rFlag</a> () const</td></tr>
|
|
<tr class="separator:a349924059ebb9ce3b154dbd6850c601d inherit pub_methods_classpFlow_1_1objectFile"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:af42da690717c749e1ee5108dcee62e7d inherit pub_methods_classpFlow_1_1objectFile"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classpFlow_1_1objectFile.html#a167fce7aaf9bbff61e0e5ad4815d09fb">writeFlag</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classpFlow_1_1objectFile.html#af42da690717c749e1ee5108dcee62e7d">wFlag</a> () const</td></tr>
|
|
<tr class="separator:af42da690717c749e1ee5108dcee62e7d inherit pub_methods_classpFlow_1_1objectFile"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a7097fa42f98e5a95fd95ec46bdf6cd60 inherit pub_methods_classpFlow_1_1objectFile"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classpFlow_1_1objectFile.html#a7097fa42f98e5a95fd95ec46bdf6cd60">isReadAlways</a> () const</td></tr>
|
|
<tr class="separator:a7097fa42f98e5a95fd95ec46bdf6cd60 inherit pub_methods_classpFlow_1_1objectFile"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a0c27a5cdee1d686f94bea4254bdbe650 inherit pub_methods_classpFlow_1_1objectFile"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classpFlow_1_1objectFile.html#a0c27a5cdee1d686f94bea4254bdbe650">isReadNever</a> () const</td></tr>
|
|
<tr class="separator:a0c27a5cdee1d686f94bea4254bdbe650 inherit pub_methods_classpFlow_1_1objectFile"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a2d01f4526e21bccb1392a344d3e6cbfd inherit pub_methods_classpFlow_1_1objectFile"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classpFlow_1_1objectFile.html#a2d01f4526e21bccb1392a344d3e6cbfd">isReadIfPresent</a> () const</td></tr>
|
|
<tr class="separator:a2d01f4526e21bccb1392a344d3e6cbfd inherit pub_methods_classpFlow_1_1objectFile"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:acbd01f9965d77d91b82df73d1fc67438 inherit pub_methods_classpFlow_1_1objectFile"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classpFlow_1_1objectFile.html#acbd01f9965d77d91b82df73d1fc67438">isWriteAlways</a> () const</td></tr>
|
|
<tr class="separator:acbd01f9965d77d91b82df73d1fc67438 inherit pub_methods_classpFlow_1_1objectFile"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a91e42168656b6587284c9167ef8b678e inherit pub_methods_classpFlow_1_1objectFile"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classpFlow_1_1objectFile.html#a91e42168656b6587284c9167ef8b678e">isWriteNever</a> () const</td></tr>
|
|
<tr class="separator:a91e42168656b6587284c9167ef8b678e inherit pub_methods_classpFlow_1_1objectFile"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ae10b53b60cb4631fdeb46271ccab67aa inherit pub_methods_classpFlow_1_1objectFile"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classpFlow_1_1objectFile.html#ae10b53b60cb4631fdeb46271ccab67aa">readWriteHeader</a> () const</td></tr>
|
|
<tr class="separator:ae10b53b60cb4631fdeb46271ccab67aa inherit pub_methods_classpFlow_1_1objectFile"><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:a770eebd1866493c91efe18ab806d9568"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classpFlow_1_1uniquePtr.html">uniquePtr</a>< <a class="el" href="classpFlow_1_1iFstream.html">iFstream</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classpFlow_1_1IOfileHeader.html#a770eebd1866493c91efe18ab806d9568">inStream</a> () const</td></tr>
|
|
<tr class="separator:a770eebd1866493c91efe18ab806d9568"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aadf02aad5ab9dd4c10306e74510f4dd0"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classpFlow_1_1uniquePtr.html">uniquePtr</a>< <a class="el" href="classpFlow_1_1oFstream.html">oFstream</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classpFlow_1_1IOfileHeader.html#aadf02aad5ab9dd4c10306e74510f4dd0">outStream</a> () const</td></tr>
|
|
<tr class="separator:aadf02aad5ab9dd4c10306e74510f4dd0"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a40f592c06afad8142b602fa255a5dc20"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classpFlow_1_1uniquePtr.html">uniquePtr</a>< <a class="el" href="classpFlow_1_1oFstream.html">oFstream</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classpFlow_1_1IOfileHeader.html#a40f592c06afad8142b602fa255a5dc20">dummyOutStream</a> () const</td></tr>
|
|
<tr class="separator:a40f592c06afad8142b602fa255a5dc20"><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:a0fc09585fc6fa997b81807dff8b8236d"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespacepFlow.html#a0ebe792a293e8c717bddf60070c0fe99">word</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classpFlow_1_1IOfileHeader.html#a0fc09585fc6fa997b81807dff8b8236d">objectName_</a></td></tr>
|
|
<tr class="separator:a0fc09585fc6fa997b81807dff8b8236d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:adf7afc3ea2cc179930f4e4f4ca48797c"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespacepFlow.html#a0ebe792a293e8c717bddf60070c0fe99">word</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classpFlow_1_1IOfileHeader.html#adf7afc3ea2cc179930f4e4f4ca48797c">objectType_</a></td></tr>
|
|
<tr class="separator:adf7afc3ea2cc179930f4e4f4ca48797c"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a4df46db2aad0395fac9c0522d8c409a9"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespacepFlow.html#a0ebe792a293e8c717bddf60070c0fe99">word</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classpFlow_1_1IOfileHeader.html#a4df46db2aad0395fac9c0522d8c409a9">fileFormat_</a> = "ASCII"</td></tr>
|
|
<tr class="memdesc:a4df46db2aad0395fac9c0522d8c409a9"><td class="mdescLeft"> </td><td class="mdescRight">file format read from file <a href="classpFlow_1_1IOfileHeader.html#a4df46db2aad0395fac9c0522d8c409a9">More...</a><br /></td></tr>
|
|
<tr class="separator:a4df46db2aad0395fac9c0522d8c409a9"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="inherited"></a>
|
|
Additional Inherited Members</h2></td></tr>
|
|
<tr class="inherit_header pub_types_classpFlow_1_1objectFile"><td colspan="2" onclick="javascript:toggleInherit('pub_types_classpFlow_1_1objectFile')"><img src="closed.png" alt="-"/> Public Types inherited from <a class="el" href="classpFlow_1_1objectFile.html">objectFile</a></td></tr>
|
|
<tr class="memitem:a314ebf993d731f5b477f5b2670de2135 inherit pub_types_classpFlow_1_1objectFile"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="classpFlow_1_1objectFile.html#a314ebf993d731f5b477f5b2670de2135">readFlag</a> { <a class="el" href="classpFlow_1_1objectFile.html#a314ebf993d731f5b477f5b2670de2135ae52db7f5bc766c98892c85b3da80035d">READ_ALWAYS</a>,
|
|
<a class="el" href="classpFlow_1_1objectFile.html#a314ebf993d731f5b477f5b2670de2135a5d213848a5257045c66f1131ba592588">READ_NEVER</a>,
|
|
<a class="el" href="classpFlow_1_1objectFile.html#a314ebf993d731f5b477f5b2670de2135a93b5e7478325255e6d8414b6b2ccc6f0">READ_IF_PRESENT</a>
|
|
}</td></tr>
|
|
<tr class="separator:a314ebf993d731f5b477f5b2670de2135 inherit pub_types_classpFlow_1_1objectFile"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a167fce7aaf9bbff61e0e5ad4815d09fb inherit pub_types_classpFlow_1_1objectFile"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="classpFlow_1_1objectFile.html#a167fce7aaf9bbff61e0e5ad4815d09fb">writeFlag</a> { <a class="el" href="classpFlow_1_1objectFile.html#a167fce7aaf9bbff61e0e5ad4815d09fba37ad78d623d69d7a70f565528efc0f59">WRITE_ALWAYS</a>,
|
|
<a class="el" href="classpFlow_1_1objectFile.html#a167fce7aaf9bbff61e0e5ad4815d09fbad27c52a51ad59856941a9597905f9130">WRITE_NEVER</a>
|
|
}</td></tr>
|
|
<tr class="separator:a167fce7aaf9bbff61e0e5ad4815d09fb inherit pub_types_classpFlow_1_1objectFile"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
|
<div class="textblock">
|
|
<p class="definition">Definition at line <a class="el" href="IOfileHeader_8hpp_source.html#l00035">35</a> of file <a class="el" href="IOfileHeader_8hpp_source.html">IOfileHeader.hpp</a>.</p>
|
|
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
|
|
<a id="a27694b34ae10a55819c0647e27e52424"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a27694b34ae10a55819c0647e27e52424">◆ </a></span>IOfileHeader()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="classpFlow_1_1IOfileHeader.html">IOfileHeader</a> </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const <a class="el" href="classpFlow_1_1objectFile.html">objectFile</a> & </td>
|
|
<td class="paramname"><em>objf</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p class="definition">Definition at line <a class="el" href="IOfileHeader_8cpp_source.html#l00058">58</a> of file <a class="el" href="IOfileHeader_8cpp_source.html">IOfileHeader.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Member Function Documentation</h2>
|
|
<a id="a770eebd1866493c91efe18ab806d9568"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a770eebd1866493c91efe18ab806d9568">◆ </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">pFlow::uniquePtr</a>< <a class="el" href="classpFlow_1_1iFstream.html">pFlow::iFstream</a> > inStream </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">protected</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p class="definition">Definition at line <a class="el" href="IOfileHeader_8cpp_source.html#l00024">24</a> of file <a class="el" href="IOfileHeader_8cpp_source.html">IOfileHeader.cpp</a>.</p>
|
|
|
|
<p class="reference">References <a class="el" href="IOfileHeader_8cpp_source.html#l00134">IOfileHeader::fileExist()</a>, <a class="el" href="IOfileHeader_8cpp_source.html#l00087">IOfileHeader::inFileBinary()</a>, and <a class="el" href="IOfileHeader_8cpp_source.html#l00063">IOfileHeader::path()</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_1IOfileHeader_a770eebd1866493c91efe18ab806d9568_cgraph.png" border="0" usemap="#classpFlow_1_1IOfileHeader_a770eebd1866493c91efe18ab806d9568_cgraph" alt=""/></div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="aadf02aad5ab9dd4c10306e74510f4dd0"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aadf02aad5ab9dd4c10306e74510f4dd0">◆ </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">pFlow::uniquePtr</a>< <a class="el" href="classpFlow_1_1oFstream.html">pFlow::oFstream</a> > outStream </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">protected</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p class="definition">Definition at line <a class="el" href="IOfileHeader_8cpp_source.html#l00032">32</a> of file <a class="el" href="IOfileHeader_8cpp_source.html">IOfileHeader.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a40f592c06afad8142b602fa255a5dc20"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a40f592c06afad8142b602fa255a5dc20">◆ </a></span>dummyOutStream()</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">pFlow::uniquePtr</a>< <a class="el" href="classpFlow_1_1oFstream.html">pFlow::oFstream</a> > dummyOutStream </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">protected</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p class="definition">Definition at line <a class="el" href="IOfileHeader_8cpp_source.html#l00045">45</a> of file <a class="el" href="IOfileHeader_8cpp_source.html">IOfileHeader.cpp</a>.</p>
|
|
|
|
<p class="reference">References <a class="el" href="fileSystem_8hpp_source.html#l00221">pFlow::CWD()</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_1IOfileHeader_a40f592c06afad8142b602fa255a5dc20_cgraph.png" border="0" usemap="#classpFlow_1_1IOfileHeader_a40f592c06afad8142b602fa255a5dc20_cgraph" alt=""/></div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a4ae6d6ea877ec8652d86076eaf333c12"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a4ae6d6ea877ec8652d86076eaf333c12">◆ </a></span>objectName()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">const <a class="el" href="namespacepFlow.html#a0ebe792a293e8c717bddf60070c0fe99">word</a>& objectName </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> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p class="definition">Definition at line <a class="el" href="IOfileHeader_8hpp_source.html#l00069">69</a> of file <a class="el" href="IOfileHeader_8hpp_source.html">IOfileHeader.hpp</a>.</p>
|
|
|
|
<p class="reference">References <a class="el" href="IOfileHeader_8hpp_source.html#l00045">IOfileHeader::objectName_</a>.</p>
|
|
|
|
<p class="reference">Referenced by <a class="el" href="pointFieldToVTK_8hpp_source.html#l00094">pFlow::PFtoVTK::convertIntPointField()</a>, <a class="el" href="pointFieldToVTK_8cpp_source.html#l00270">pFlow::PFtoVTK::convertRealTypePointField()</a>, <a class="el" href="pointFieldToVTK_8cpp_source.html#l00298">pFlow::PFtoVTK::convertRealx3TypePointField()</a>, <a class="el" href="triSurfaceFieldToVTK_8cpp_source.html#l00289">pFlow::TSFtoVTK::convertRealx3TypetriSurfaceField()</a>, <a class="el" href="triSurfaceFieldToVTK_8cpp_source.html#l00321">pFlow::TSFtoVTK::convertRealx3TypetriSurfaceFieldSeparate()</a>, <a class="el" href="pointFieldToVTK_8cpp_source.html#l00008">pFlow::PFtoVTK::convertTimeFolderPointFields()</a>, and <a class="el" href="pointFieldToVTK_8cpp_source.html#l00095">pFlow::PFtoVTK::convertTimeFolderPointFieldsSelected()</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 caller 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_1IOfileHeader_a4ae6d6ea877ec8652d86076eaf333c12_icgraph.png" border="0" usemap="#classpFlow_1_1IOfileHeader_a4ae6d6ea877ec8652d86076eaf333c12_icgraph" alt=""/></div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a67068cb6552c42a5ddb1c66bf6bbf6b3"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a67068cb6552c42a5ddb1c66bf6bbf6b3">◆ </a></span>objectType()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">const <a class="el" href="namespacepFlow.html#a0ebe792a293e8c717bddf60070c0fe99">word</a>& objectType </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> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p class="definition">Definition at line <a class="el" href="IOfileHeader_8hpp_source.html#l00075">75</a> of file <a class="el" href="IOfileHeader_8hpp_source.html">IOfileHeader.hpp</a>.</p>
|
|
|
|
<p class="reference">References <a class="el" href="IOfileHeader_8hpp_source.html#l00048">IOfileHeader::objectType_</a>.</p>
|
|
|
|
<p class="reference">Referenced by <a class="el" href="pointFieldToVTK_8hpp_source.html#l00094">pFlow::PFtoVTK::convertIntPointField()</a>, <a class="el" href="pointFieldToVTK_8cpp_source.html#l00270">pFlow::PFtoVTK::convertRealTypePointField()</a>, <a class="el" href="pointFieldToVTK_8cpp_source.html#l00298">pFlow::PFtoVTK::convertRealx3TypePointField()</a>, <a class="el" href="triSurfaceFieldToVTK_8cpp_source.html#l00289">pFlow::TSFtoVTK::convertRealx3TypetriSurfaceField()</a>, <a class="el" href="triSurfaceFieldToVTK_8cpp_source.html#l00321">pFlow::TSFtoVTK::convertRealx3TypetriSurfaceFieldSeparate()</a>, <a class="el" href="pointFieldToVTK_8cpp_source.html#l00008">pFlow::PFtoVTK::convertTimeFolderPointFields()</a>, and <a class="el" href="pointFieldToVTK_8cpp_source.html#l00095">pFlow::PFtoVTK::convertTimeFolderPointFieldsSelected()</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_1IOfileHeader_a67068cb6552c42a5ddb1c66bf6bbf6b3_icgraph.png" border="0" usemap="#classpFlow_1_1IOfileHeader_a67068cb6552c42a5ddb1c66bf6bbf6b3_icgraph" alt=""/></div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a6fc6abb626e9155a819c52624443ca0c"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a6fc6abb626e9155a819c52624443ca0c">◆ </a></span>owner()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual const <a class="el" href="classpFlow_1_1repository.html">repository</a>* owner </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>Reimplemented in <a class="el" href="classpFlow_1_1IOobject.html#a09a559f42cef65f7e9b3ce24cfb42905">IOobject</a>.</p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="IOfileHeader_8hpp_source.html#l00082">82</a> of file <a class="el" href="IOfileHeader_8hpp_source.html">IOfileHeader.hpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="add8e03162ae5c99e43a6a512ef9b7e36"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#add8e03162ae5c99e43a6a512ef9b7e36">◆ </a></span>isIncluded()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual bool isIncluded </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const <a class="el" href="namespacepFlow.html#a0ebe792a293e8c717bddf60070c0fe99">word</a> & </td>
|
|
<td class="paramname"><em>objName</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>Reimplemented in <a class="el" href="classpFlow_1_1IOobject.html#ae86a22cbcc2022c0f2d7c1bd188889d6">IOobject</a>.</p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="IOfileHeader_8hpp_source.html#l00088">88</a> of file <a class="el" href="IOfileHeader_8hpp_source.html">IOfileHeader.hpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="af78fefb5053ee53f6846c61c61a3a1be"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#af78fefb5053ee53f6846c61c61a3a1be">◆ </a></span>isExcluded()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual bool isExcluded </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const <a class="el" href="namespacepFlow.html#a0ebe792a293e8c717bddf60070c0fe99">word</a> & </td>
|
|
<td class="paramname"><em>objName</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>Reimplemented in <a class="el" href="classpFlow_1_1IOobject.html#a5f6e9860479ec6d8584a6c1bfa456dea">IOobject</a>.</p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="IOfileHeader_8hpp_source.html#l00094">94</a> of file <a class="el" href="IOfileHeader_8hpp_source.html">IOfileHeader.hpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ae1921a7f20c43d1438221946e607c488"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ae1921a7f20c43d1438221946e607c488">◆ </a></span>path()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="classpFlow_1_1fileSystem.html">pFlow::fileSystem</a> path </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p class="definition">Definition at line <a class="el" href="IOfileHeader_8cpp_source.html#l00063">63</a> of file <a class="el" href="IOfileHeader_8cpp_source.html">IOfileHeader.cpp</a>.</p>
|
|
|
|
<p class="reference">References <a class="el" href="fileSystem_8hpp_source.html#l00154">fileSystem::path()</a>.</p>
|
|
|
|
<p class="reference">Referenced by <a class="el" href="fileDictionary_8cpp_source.html#l00047">fileDictionary::fileDictionary()</a>, <a class="el" href="geometry_8cpp_source.html#l00070">geometry::geometry()</a>, <a class="el" href="IOfileHeader_8cpp_source.html#l00024">IOfileHeader::inStream()</a>, and <a class="el" href="pointStructure_8cpp_source.html#l00094">pointStructure::pointStructure()</a>.</p>
|
|
<div id="dynsection-6" onclick="return toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;">
|
|
<img id="dynsection-6-trigger" src="closed.png" alt="+"/> Here is the call graph for this function:</div>
|
|
<div id="dynsection-6-summary" class="dynsummary" style="display:block;">
|
|
</div>
|
|
<div id="dynsection-6-content" class="dyncontent" style="display:none;">
|
|
<div class="center"><img src="classpFlow_1_1IOfileHeader_ae1921a7f20c43d1438221946e607c488_cgraph.png" border="0" usemap="#classpFlow_1_1IOfileHeader_ae1921a7f20c43d1438221946e607c488_cgraph" alt=""/></div>
|
|
</div>
|
|
<div id="dynsection-7" onclick="return toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;">
|
|
<img id="dynsection-7-trigger" src="closed.png" alt="+"/> Here is the caller graph for this function:</div>
|
|
<div id="dynsection-7-summary" class="dynsummary" style="display:block;">
|
|
</div>
|
|
<div id="dynsection-7-content" class="dyncontent" style="display:none;">
|
|
<div class="center"><img src="classpFlow_1_1IOfileHeader_ae1921a7f20c43d1438221946e607c488_icgraph.png" border="0" usemap="#classpFlow_1_1IOfileHeader_ae1921a7f20c43d1438221946e607c488_icgraph" alt=""/></div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="aefb380f32e3c6839d26dbc93ff4eb00a"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aefb380f32e3c6839d26dbc93ff4eb00a">◆ </a></span>outFileBinary()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool outFileBinary </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p class="definition">Definition at line <a class="el" href="IOfileHeader_8cpp_source.html#l00079">79</a> of file <a class="el" href="IOfileHeader_8cpp_source.html">IOfileHeader.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a6e04bca1658d3c571a38d8ac1d62462e"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a6e04bca1658d3c571a38d8ac1d62462e">◆ </a></span>inFileBinary()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool inFileBinary </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p class="definition">Definition at line <a class="el" href="IOfileHeader_8cpp_source.html#l00087">87</a> of file <a class="el" href="IOfileHeader_8cpp_source.html">IOfileHeader.cpp</a>.</p>
|
|
|
|
<p class="reference">References <a class="el" href="bTypesFunctions_8cpp_source.html#l00043">pFlow::toUpper()</a>.</p>
|
|
|
|
<p class="reference">Referenced by <a class="el" href="IOfileHeader_8cpp_source.html#l00024">IOfileHeader::inStream()</a>.</p>
|
|
<div id="dynsection-8" onclick="return toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;">
|
|
<img id="dynsection-8-trigger" src="closed.png" alt="+"/> Here is the call graph for this function:</div>
|
|
<div id="dynsection-8-summary" class="dynsummary" style="display:block;">
|
|
</div>
|
|
<div id="dynsection-8-content" class="dyncontent" style="display:none;">
|
|
<div class="center"><img src="classpFlow_1_1IOfileHeader_a6e04bca1658d3c571a38d8ac1d62462e_cgraph.png" border="0" usemap="#classpFlow_1_1IOfileHeader_a6e04bca1658d3c571a38d8ac1d62462e_cgraph" alt=""/></div>
|
|
</div>
|
|
<div id="dynsection-9" onclick="return toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;">
|
|
<img id="dynsection-9-trigger" src="closed.png" alt="+"/> Here is the caller graph for this function:</div>
|
|
<div id="dynsection-9-summary" class="dynsummary" style="display:block;">
|
|
</div>
|
|
<div id="dynsection-9-content" class="dyncontent" style="display:none;">
|
|
<div class="center"><img src="classpFlow_1_1IOfileHeader_a6e04bca1658d3c571a38d8ac1d62462e_icgraph.png" border="0" usemap="#classpFlow_1_1IOfileHeader_a6e04bca1658d3c571a38d8ac1d62462e_icgraph" alt=""/></div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a1a248aa0488b774d5160449992ad31e5"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a1a248aa0488b774d5160449992ad31e5">◆ </a></span>headerOk()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool headerOk </td>
|
|
<td>(</td>
|
|
<td class="paramtype">bool </td>
|
|
<td class="paramname"><em>silent</em> = <code>false</code></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p class="definition">Definition at line <a class="el" href="IOfileHeader_8cpp_source.html#l00092">92</a> of file <a class="el" href="IOfileHeader_8cpp_source.html">IOfileHeader.cpp</a>.</p>
|
|
|
|
<p class="reference">References <a class="el" href="iOstream_8hpp_source.html#l00341">pFlow::endl()</a>, and <a class="el" href="error_8hpp_source.html#l00095">warningInFunction</a>.</p>
|
|
|
|
<p class="reference">Referenced by <a class="el" href="pointFieldToVTK_8cpp_source.html#l00008">pFlow::PFtoVTK::convertTimeFolderPointFields()</a>, <a class="el" href="pointFieldToVTK_8cpp_source.html#l00095">pFlow::PFtoVTK::convertTimeFolderPointFieldsSelected()</a>, <a class="el" href="triSurfaceFieldToVTK_8cpp_source.html#l00005">pFlow::TSFtoVTK::convertTimeFolderTriSurfaceFields()</a>, <a class="el" href="triSurfaceFieldToVTK_8cpp_source.html#l00211">pFlow::TSFtoVTK::convertTimeFolderTriSurfaceFieldsSeparate()</a>, <a class="el" href="triSurfaceFieldToVTK_8cpp_source.html#l00151">pFlow::TSFtoVTK::convertTimeFolderTriSurfaceFieldsSingle()</a>, and <a class="el" href="readFromTimeFolder_8cpp_source.html#l00030">readFromTimeFolder::fieldExists()</a>.</p>
|
|
<div id="dynsection-10" onclick="return toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;">
|
|
<img id="dynsection-10-trigger" src="closed.png" alt="+"/> Here is the call graph for this function:</div>
|
|
<div id="dynsection-10-summary" class="dynsummary" style="display:block;">
|
|
</div>
|
|
<div id="dynsection-10-content" class="dyncontent" style="display:none;">
|
|
<div class="center"><img src="classpFlow_1_1IOfileHeader_a1a248aa0488b774d5160449992ad31e5_cgraph.png" border="0" usemap="#classpFlow_1_1IOfileHeader_a1a248aa0488b774d5160449992ad31e5_cgraph" alt=""/></div>
|
|
</div>
|
|
<div id="dynsection-11" onclick="return toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;">
|
|
<img id="dynsection-11-trigger" src="closed.png" alt="+"/> Here is the caller graph for this function:</div>
|
|
<div id="dynsection-11-summary" class="dynsummary" style="display:block;">
|
|
</div>
|
|
<div id="dynsection-11-content" class="dyncontent" style="display:none;">
|
|
<div class="center"><img src="classpFlow_1_1IOfileHeader_a1a248aa0488b774d5160449992ad31e5_icgraph.png" border="0" usemap="#classpFlow_1_1IOfileHeader_a1a248aa0488b774d5160449992ad31e5_icgraph" alt=""/></div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="aac13e923e67df5e79d9a75f592b97da3"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aac13e923e67df5e79d9a75f592b97da3">◆ </a></span>implyRead()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool implyRead </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Imply read. </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="IOfileHeader_8cpp_source.html#l00121">121</a> of file <a class="el" href="IOfileHeader_8cpp_source.html">IOfileHeader.cpp</a>.</p>
|
|
|
|
<p class="reference">Referenced by <a class="el" href="insertion_8cpp_source.html#l00027">insertion::insertion()</a>.</p>
|
|
<div id="dynsection-12" onclick="return toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;">
|
|
<img id="dynsection-12-trigger" src="closed.png" alt="+"/> Here is the caller graph for this function:</div>
|
|
<div id="dynsection-12-summary" class="dynsummary" style="display:block;">
|
|
</div>
|
|
<div id="dynsection-12-content" class="dyncontent" style="display:none;">
|
|
<div class="center"><img src="classpFlow_1_1IOfileHeader_aac13e923e67df5e79d9a75f592b97da3_icgraph.png" border="0" usemap="#classpFlow_1_1IOfileHeader_aac13e923e67df5e79d9a75f592b97da3_icgraph" alt=""/></div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="adfb03998f9b3b981631dc794cffd05a1"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#adfb03998f9b3b981631dc794cffd05a1">◆ </a></span>implyWrite()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool implyWrite </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Imply write. </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="IOfileHeader_8cpp_source.html#l00127">127</a> of file <a class="el" href="IOfileHeader_8cpp_source.html">IOfileHeader.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ac38363de350016ce974d10db7d4d0753"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ac38363de350016ce974d10db7d4d0753">◆ </a></span>fileExist()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool fileExist </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Check if file exists. </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="IOfileHeader_8cpp_source.html#l00134">134</a> of file <a class="el" href="IOfileHeader_8cpp_source.html">IOfileHeader.cpp</a>.</p>
|
|
|
|
<p class="reference">Referenced by <a class="el" href="IOfileHeader_8cpp_source.html#l00024">IOfileHeader::inStream()</a>.</p>
|
|
<div id="dynsection-13" onclick="return toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;">
|
|
<img id="dynsection-13-trigger" src="closed.png" alt="+"/> Here is the caller graph for this function:</div>
|
|
<div id="dynsection-13-summary" class="dynsummary" style="display:block;">
|
|
</div>
|
|
<div id="dynsection-13-content" class="dyncontent" style="display:none;">
|
|
<div class="center"><img src="classpFlow_1_1IOfileHeader_ac38363de350016ce974d10db7d4d0753_icgraph.png" border="0" usemap="#classpFlow_1_1IOfileHeader_ac38363de350016ce974d10db7d4d0753_icgraph" alt=""/></div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="aad1bd18bfebe1913d2b10785c0aff822"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aad1bd18bfebe1913d2b10785c0aff822">◆ </a></span>readIfPresent()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool readIfPresent </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Check read if present. </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="IOfileHeader_8cpp_source.html#l00139">139</a> of file <a class="el" href="IOfileHeader_8cpp_source.html">IOfileHeader.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a68bff73fd26a260a1d26e7890897d4e4"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a68bff73fd26a260a1d26e7890897d4e4">◆ </a></span>writeHeader() <span class="overload">[1/3]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool writeHeader </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Check if the header should be written to file True: on master + implyWrite + readWriteHeader = true False: otherwise. </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="IOfileHeader_8cpp_source.html#l00144">144</a> of file <a class="el" href="IOfileHeader_8cpp_source.html">IOfileHeader.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ab83d4ca3dd2d2995f15ffe5e2693f316"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ab83d4ca3dd2d2995f15ffe5e2693f316">◆ </a></span>writeHeader() <span class="overload">[2/3]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool writeHeader </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="classpFlow_1_1iOstream.html">iOstream</a> & </td>
|
|
<td class="paramname"><em>os</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const <a class="el" href="namespacepFlow.html#a0ebe792a293e8c717bddf60070c0fe99">word</a> & </td>
|
|
<td class="paramname"><em>typeName</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">bool </td>
|
|
<td class="paramname"><em>forceWrite</em> = <code>false</code> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td> const</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Write the header to the file , typeName comes from caller. </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="IOfileHeader_8cpp_source.html#l00154">154</a> of file <a class="el" href="IOfileHeader_8cpp_source.html">IOfileHeader.cpp</a>.</p>
|
|
|
|
<p class="reference">References <a class="el" href="IOstream_8cpp_source.html#l00048">IOstream::fatalCheck()</a>, and <a class="el" href="iOstream_8hpp_source.html#l00239">iOstream::writeWordEntry()</a>.</p>
|
|
<div id="dynsection-14" onclick="return toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;">
|
|
<img id="dynsection-14-trigger" src="closed.png" alt="+"/> Here is the call graph for this function:</div>
|
|
<div id="dynsection-14-summary" class="dynsummary" style="display:block;">
|
|
</div>
|
|
<div id="dynsection-14-content" class="dyncontent" style="display:none;">
|
|
<div class="center"><img src="classpFlow_1_1IOfileHeader_ab83d4ca3dd2d2995f15ffe5e2693f316_cgraph.png" border="0" usemap="#classpFlow_1_1IOfileHeader_ab83d4ca3dd2d2995f15ffe5e2693f316_cgraph" alt=""/></div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a5d569ab3079ca594877dfbdf4d45cae4"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a5d569ab3079ca594877dfbdf4d45cae4">◆ </a></span>writeHeader() <span class="overload">[3/3]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool writeHeader </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="classpFlow_1_1iOstream.html">iOstream</a> & </td>
|
|
<td class="paramname"><em>os</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">bool </td>
|
|
<td class="paramname"><em>forceWrite</em> = <code>false</code> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td> const</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Write the header to the file, typeName comes from the one read from file. </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="IOfileHeader_8cpp_source.html#l00184">184</a> of file <a class="el" href="IOfileHeader_8cpp_source.html">IOfileHeader.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="aaf27120b2528b8d3d77903c4f4481127"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aaf27120b2528b8d3d77903c4f4481127">◆ </a></span>readHeader() <span class="overload">[1/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool readHeader </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Check if header should be read from file. </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="IOfileHeader_8cpp_source.html#l00189">189</a> of file <a class="el" href="IOfileHeader_8cpp_source.html">IOfileHeader.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ad3e735fcc23f3717d149728c03f5074a"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ad3e735fcc23f3717d149728c03f5074a">◆ </a></span>readHeader() <span class="overload">[2/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool readHeader </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="classpFlow_1_1iIstream.html">iIstream</a> & </td>
|
|
<td class="paramname"><em>is</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">bool </td>
|
|
<td class="paramname"><em>silent</em> = <code>false</code> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Read the header in the file. </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="IOfileHeader_8cpp_source.html#l00196">196</a> of file <a class="el" href="IOfileHeader_8cpp_source.html">IOfileHeader.cpp</a>.</p>
|
|
|
|
<p class="reference">References <a class="el" href="iOstream_8hpp_source.html#l00341">pFlow::endl()</a>, <a class="el" href="iIstream_8cpp_source.html#l00203">iIstream::findTokenAndNextSilent()</a>, <a class="el" href="IOstream_8cpp_source.html#l00031">IOstream::name()</a>, and <a class="el" href="error_8hpp_source.html#l00095">warningInFunction</a>.</p>
|
|
<div id="dynsection-15" onclick="return toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;">
|
|
<img id="dynsection-15-trigger" src="closed.png" alt="+"/> Here is the call graph for this function:</div>
|
|
<div id="dynsection-15-summary" class="dynsummary" style="display:block;">
|
|
</div>
|
|
<div id="dynsection-15-content" class="dyncontent" style="display:none;">
|
|
<div class="center"><img src="classpFlow_1_1IOfileHeader_ad3e735fcc23f3717d149728c03f5074a_cgraph.png" border="0" usemap="#classpFlow_1_1IOfileHeader_ad3e735fcc23f3717d149728c03f5074a_cgraph" alt=""/></div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a935aedcbc2d9fc4e32646d718eaec1f4"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a935aedcbc2d9fc4e32646d718eaec1f4">◆ </a></span>writeBanner()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool writeBanner </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="classpFlow_1_1iOstream.html">iOstream</a> & </td>
|
|
<td class="paramname"><em>os</em></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>write the banner </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="IOfileHeader_8cpp_source.html#l00238">238</a> of file <a class="el" href="IOfileHeader_8cpp_source.html">IOfileHeader.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a7724614a5d68ca0d55beead4b79f6051"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a7724614a5d68ca0d55beead4b79f6051">◆ </a></span>writeSeparator()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool writeSeparator </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="classpFlow_1_1iOstream.html">iOstream</a> & </td>
|
|
<td class="paramname"><em>os</em></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>wirte a separator line </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="IOfileHeader_8cpp_source.html#l00249">249</a> of file <a class="el" href="IOfileHeader_8cpp_source.html">IOfileHeader.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Member Data Documentation</h2>
|
|
<a id="a0fc09585fc6fa997b81807dff8b8236d"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a0fc09585fc6fa997b81807dff8b8236d">◆ </a></span>objectName_</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="namespacepFlow.html#a0ebe792a293e8c717bddf60070c0fe99">word</a> objectName_</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="IOfileHeader_8hpp_source.html#l00045">45</a> of file <a class="el" href="IOfileHeader_8hpp_source.html">IOfileHeader.hpp</a>.</p>
|
|
|
|
<p class="reference">Referenced by <a class="el" href="IOfileHeader_8hpp_source.html#l00069">IOfileHeader::objectName()</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="adf7afc3ea2cc179930f4e4f4ca48797c"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#adf7afc3ea2cc179930f4e4f4ca48797c">◆ </a></span>objectType_</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="namespacepFlow.html#a0ebe792a293e8c717bddf60070c0fe99">word</a> objectType_</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="IOfileHeader_8hpp_source.html#l00048">48</a> of file <a class="el" href="IOfileHeader_8hpp_source.html">IOfileHeader.hpp</a>.</p>
|
|
|
|
<p class="reference">Referenced by <a class="el" href="IOfileHeader_8hpp_source.html#l00075">IOfileHeader::objectType()</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a4df46db2aad0395fac9c0522d8c409a9"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a4df46db2aad0395fac9c0522d8c409a9">◆ </a></span>fileFormat_</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="namespacepFlow.html#a0ebe792a293e8c717bddf60070c0fe99">word</a> fileFormat_ = "ASCII"</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>file format read from file </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="IOfileHeader_8hpp_source.html#l00051">51</a> of file <a class="el" href="IOfileHeader_8hpp_source.html">IOfileHeader.hpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<hr/>The documentation for this class was generated from the following files:<ul>
|
|
<li>src/phasicFlow/repository/IOobject/<a class="el" href="IOfileHeader_8hpp_source.html">IOfileHeader.hpp</a></li>
|
|
<li>src/phasicFlow/repository/IOobject/<a class="el" href="IOfileHeader_8cpp_source.html">IOfileHeader.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_1IOfileHeader.html">IOfileHeader</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>
|