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

368 lines
19 KiB
HTML
Raw Blame History

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.17"/>
<title>PhasicFlow: boxRegion 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&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function() { init_search(); });
/* @license-end */
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="customdoxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname"><a href="https://cemf.ir">PhasicFlow</a>
&#160;<span id="projectnumber"><a href="https://cemf.ir">v0.1</a></span>
</div>
<div id="projectbrief"><a href="www.github.com/PhasicFlow">www.cemf.ir</a></div>
</td>
<td> <div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.17 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search');
/* @license-end */
</script>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('classpFlow_1_1boxRegion.html',''); initResizable(); });
/* @license-end */
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pro-attribs">Protected Attributes</a> &#124;
<a href="classpFlow_1_1boxRegion-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">boxRegion Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<div class="dynheader">
Collaboration diagram for boxRegion:</div>
<div class="dyncontent">
<div class="center"><img src="classpFlow_1_1boxRegion__coll__graph.png" border="0" usemap="#boxRegion_coll__map" alt="Collaboration graph"/></div>
<map name="boxRegion_coll__map" id="boxRegion_coll__map">
<area shape="rect" title=" " alt="" coords="101,95,191,121"/>
<area shape="rect" href="classpFlow_1_1uniformRandomReal.html" title=" " alt="" coords="5,5,161,32"/>
<area shape="rect" href="classpFlow_1_1box.html" title=" " alt="" coords="185,5,232,32"/>
</map>
<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a7738719f366d4d8f7778b80d1c8e8eeb"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpFlow_1_1boxRegion.html#a7738719f366d4d8f7778b80d1c8e8eeb">TypeInfoNV</a> (&quot;boxRegion&quot;)</td></tr>
<tr class="separator:a7738719f366d4d8f7778b80d1c8e8eeb"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a837963842fca9d81a7e2c4845d69a628"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpFlow_1_1boxRegion.html#a837963842fca9d81a7e2c4845d69a628">boxRegion</a> (const <a class="el" href="classpFlow_1_1dictionary.html">dictionary</a> &amp;dict)</td></tr>
<tr class="separator:a837963842fca9d81a7e2c4845d69a628"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a66c49023a41a748e1f69ca1954186c06"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpFlow_1_1boxRegion.html#a66c49023a41a748e1f69ca1954186c06">~boxRegion</a> ()=default</td></tr>
<tr class="separator:a66c49023a41a748e1f69ca1954186c06"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aaa6340380ab7af3599579f49f62308da"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpFlow_1_1boxRegion.html#aaa6340380ab7af3599579f49f62308da">isInside</a> (const <a class="el" href="namespacepFlow.html#a5164661f6974ad24fa90bf19433e6116">realx3</a> &amp;p) const</td></tr>
<tr class="separator:aaa6340380ab7af3599579f49f62308da"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a742999f822100111462c25118a0ce0fe"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespacepFlow.html#a5164661f6974ad24fa90bf19433e6116">realx3</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpFlow_1_1boxRegion.html#a742999f822100111462c25118a0ce0fe">peek</a> () const</td></tr>
<tr class="separator:a742999f822100111462c25118a0ce0fe"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6ce0c64db98eb6144d363dbfc86104eb"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpFlow_1_1boxRegion.html#a6ce0c64db98eb6144d363dbfc86104eb">read</a> (const <a class="el" href="classpFlow_1_1dictionary.html">dictionary</a> &amp;dict)</td></tr>
<tr class="separator:a6ce0c64db98eb6144d363dbfc86104eb"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6964e9f1f100001543fdb044fa7fc896"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpFlow_1_1boxRegion.html#a6964e9f1f100001543fdb044fa7fc896">write</a> (<a class="el" href="classpFlow_1_1dictionary.html">dictionary</a> &amp;dict) const</td></tr>
<tr class="separator:a6964e9f1f100001543fdb044fa7fc896"><td class="memSeparator" colspan="2">&#160;</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:aefb81f563e3df7617831459d0ab0b5ee"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classpFlow_1_1box.html">box</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpFlow_1_1boxRegion.html#aefb81f563e3df7617831459d0ab0b5ee">box_</a></td></tr>
<tr class="separator:aefb81f563e3df7617831459d0ab0b5ee"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a809105944d87bd27bb8fa71167a86e14"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classpFlow_1_1uniformRandomReal.html">uniformRandomReal</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpFlow_1_1boxRegion.html#a809105944d87bd27bb8fa71167a86e14">random_</a></td></tr>
<tr class="separator:a809105944d87bd27bb8fa71167a86e14"><td class="memSeparator" colspan="2">&#160;</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="boxRegion_8hpp_source.html#l00031">31</a> of file <a class="el" href="boxRegion_8hpp_source.html">boxRegion.hpp</a>.</p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a837963842fca9d81a7e2c4845d69a628"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a837963842fca9d81a7e2c4845d69a628">&#9670;&nbsp;</a></span>boxRegion()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classpFlow_1_1boxRegion.html">boxRegion</a> </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classpFlow_1_1dictionary.html">dictionary</a> &amp;&#160;</td>
<td class="paramname"><em>dict</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="boxRegion_8cpp_source.html#l00025">25</a> of file <a class="el" href="boxRegion_8cpp_source.html">boxRegion.cpp</a>.</p>
</div>
</div>
<a id="a66c49023a41a748e1f69ca1954186c06"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a66c49023a41a748e1f69ca1954186c06">&#9670;&nbsp;</a></span>~boxRegion()</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_1boxRegion.html">boxRegion</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">default</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a7738719f366d4d8f7778b80d1c8e8eeb"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7738719f366d4d8f7778b80d1c8e8eeb">&#9670;&nbsp;</a></span>TypeInfoNV()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">TypeInfoNV </td>
<td>(</td>
<td class="paramtype">&quot;boxRegion&quot;&#160;</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="aaa6340380ab7af3599579f49f62308da"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aaa6340380ab7af3599579f49f62308da">&#9670;&nbsp;</a></span>isInside()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool isInside </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="namespacepFlow.html#a5164661f6974ad24fa90bf19433e6116">realx3</a> &amp;&#160;</td>
<td class="paramname"><em>p</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="boxRegion_8cpp_source.html#l00036">36</a> of file <a class="el" href="boxRegion_8cpp_source.html">boxRegion.cpp</a>.</p>
</div>
</div>
<a id="a742999f822100111462c25118a0ce0fe"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a742999f822100111462c25118a0ce0fe">&#9670;&nbsp;</a></span>peek()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="namespacepFlow.html#a5164661f6974ad24fa90bf19433e6116">pFlow::realx3</a> peek </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="boxRegion_8cpp_source.html#l00043">43</a> of file <a class="el" href="boxRegion_8cpp_source.html">boxRegion.cpp</a>.</p>
<p class="reference">References <a class="el" href="boxRegion_8hpp_source.html#l00034">boxRegion::box_</a>, <a class="el" href="box_8hpp_source.html#l00094">box::maxPoint()</a>, <a class="el" href="box_8hpp_source.html#l00088">box::minPoint()</a>, <a class="el" href="boxRegion_8hpp_source.html#l00036">boxRegion::random_</a>, and <a class="el" href="uniformRandomReal_8hpp_source.html#l00053">uniformRandomReal::randomNumber()</a>.</p>
<div class="dynheader">
Here is the call graph for this function:</div>
<div class="dyncontent">
<div class="center"><img src="classpFlow_1_1boxRegion_a742999f822100111462c25118a0ce0fe_cgraph.png" border="0" usemap="#classpFlow_1_1boxRegion_a742999f822100111462c25118a0ce0fe_cgraph" alt=""/></div>
<map name="classpFlow_1_1boxRegion_a742999f822100111462c25118a0ce0fe_cgraph" id="classpFlow_1_1boxRegion_a742999f822100111462c25118a0ce0fe_cgraph">
<area shape="rect" title=" " alt="" coords="5,56,60,83"/>
<area shape="rect" href="classpFlow_1_1box.html#a22e25e0baa24f79d1fa113c2a84f00f9" title=" " alt="" coords="128,5,291,32"/>
<area shape="rect" href="classpFlow_1_1box.html#a67424c452a87ed7ff748b65374f89e54" title=" " alt="" coords="130,56,289,83"/>
<area shape="rect" href="classpFlow_1_1uniformRandomReal.html#adafd9f80ea7071089bd8829bb04cdd14" title=" " alt="" coords="108,107,311,149"/>
</map>
</div>
</div>
</div>
<a id="a6ce0c64db98eb6144d363dbfc86104eb"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6ce0c64db98eb6144d363dbfc86104eb">&#9670;&nbsp;</a></span>read()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool read </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classpFlow_1_1dictionary.html">dictionary</a> &amp;&#160;</td>
<td class="paramname"><em>dict</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="boxRegion_8cpp_source.html#l00050">50</a> of file <a class="el" href="boxRegion_8cpp_source.html">boxRegion.cpp</a>.</p>
</div>
</div>
<a id="a6964e9f1f100001543fdb044fa7fc896"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6964e9f1f100001543fdb044fa7fc896">&#9670;&nbsp;</a></span>write()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool write </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classpFlow_1_1dictionary.html">dictionary</a> &amp;&#160;</td>
<td class="paramname"><em>dict</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="boxRegion_8cpp_source.html#l00058">58</a> of file <a class="el" href="boxRegion_8cpp_source.html">boxRegion.cpp</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a id="aefb81f563e3df7617831459d0ab0b5ee"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aefb81f563e3df7617831459d0ab0b5ee">&#9670;&nbsp;</a></span>box_</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_1box.html">box</a> box_</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="boxRegion_8hpp_source.html#l00034">34</a> of file <a class="el" href="boxRegion_8hpp_source.html">boxRegion.hpp</a>.</p>
<p class="reference">Referenced by <a class="el" href="boxRegion_8cpp_source.html#l00043">boxRegion::peek()</a>.</p>
</div>
</div>
<a id="a809105944d87bd27bb8fa71167a86e14"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a809105944d87bd27bb8fa71167a86e14">&#9670;&nbsp;</a></span>random_</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_1uniformRandomReal.html">uniformRandomReal</a> random_</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">mutable</span><span class="mlabel">protected</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="boxRegion_8hpp_source.html#l00036">36</a> of file <a class="el" href="boxRegion_8hpp_source.html">boxRegion.hpp</a>.</p>
<p class="reference">Referenced by <a class="el" href="boxRegion_8cpp_source.html#l00043">boxRegion::peek()</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li>src/phasicFlow/structuredData/peakableRegion/boxRegion/<a class="el" href="boxRegion_8hpp_source.html">boxRegion.hpp</a></li>
<li>src/phasicFlow/structuredData/peakableRegion/boxRegion/<a class="el" href="boxRegion_8cpp_source.html">boxRegion.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_1boxRegion.html">boxRegion</a></li>
<li class="footer">Generated by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.17 </li>
</ul>
</div>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink