mirror of
https://github.com/PhasicFlow/phasicFlow.git
synced 2025-07-28 03:27:05 +00:00
documentation for v1.0
This commit is contained in:
HRN
@ -130,7 +130,7 @@ $(document).ready(function(){initNavTree('vibrating_8cpp_source.html',''); initR
|
||||
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span>  </div>
|
||||
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span>  </div>
|
||||
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <a class="code" href="pFlowMacros_8hpp.html#a4a0e2a760ea30cb5fe3d40c0cb3fe4a9">FUNCTION_H</a></div>
|
||||
<div class="line"><a name="l00026"></a><span class="lineno"><a class="line" href="classpFlow_1_1vibrating.html#a2b355a11348fa109643c5396da68e170"> 26</a></span> <a class="code" href="classpFlow_1_1vibrating.html#a3a6da07d4af1a874177be0d6535c3511">pFlow::vibrating::vibrating</a>(<span class="keyword">const</span> <a class="code" href="classpFlow_1_1dictionary.html">dictionary</a>& dict)</div>
|
||||
<div class="line"><a name="l00026"></a><span class="lineno"><a class="line" href="classpFlow_1_1vibrating.html#a2b355a11348fa109643c5396da68e170"> 26</a></span> <a class="code" href="classpFlow_1_1vibrating.html#a4c0cbe0ffd49984c2e7986db0d0649ef">pFlow::vibrating::vibrating</a>(<span class="keyword">const</span> <a class="code" href="classpFlow_1_1dictionary.html">dictionary</a>& dict)</div>
|
||||
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span> {</div>
|
||||
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span>  </div>
|
||||
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span>  <span class="keywordflow">if</span>(!<a class="code" href="classpFlow_1_1vibrating.html#ab25b05023549e7fec0ee1d0f6ce239dd">read</a>(dict))</div>
|
||||
@ -209,30 +209,30 @@ $(document).ready(function(){initNavTree('vibrating_8cpp_source.html',''); initR
|
||||
<div class="line"><a name="l00102"></a><span class="lineno"> 102</span> }</div>
|
||||
</div><!-- fragment --></div><!-- contents -->
|
||||
</div><!-- doc-content -->
|
||||
<div class="ttc" id="aerror_8hpp_html_a6d29ef74f19f6d5a225841705985eb8b"><div class="ttname"><a href="error_8hpp.html#a6d29ef74f19f6d5a225841705985eb8b">notImplementedFunction</a></div><div class="ttdeci">#define notImplementedFunction</div><div class="ttdef"><b>Definition:</b> <a href="error_8hpp_source.html#l00047">error.hpp:47</a></div></div>
|
||||
<div class="ttc" id="aclasspFlow_1_1dictionary_html_a5585dc9a8b971fbfe2c99fdb75c5d647"><div class="ttname"><a href="classpFlow_1_1dictionary.html#a5585dc9a8b971fbfe2c99fdb75c5d647">pFlow::dictionary::getValOrSet</a></div><div class="ttdeci">T getValOrSet(const word &keyword, const T &setVal) const</div><div class="ttdef"><b>Definition:</b> <a href="dictionary_8hpp_source.html#l00325">dictionary.hpp:325</a></div></div>
|
||||
<div class="ttc" id="aerror_8hpp_html_aad22a1cd3b45a97ac8cd195f06fe61fe"><div class="ttname"><a href="error_8hpp.html#aad22a1cd3b45a97ac8cd195f06fe61fe">fatalExit</a></div><div class="ttdeci">#define fatalExit</div><div class="ttdef"><b>Definition:</b> <a href="error_8hpp_source.html#l00057">error.hpp:57</a></div></div>
|
||||
<div class="ttc" id="aerror_8hpp_html_a6d29ef74f19f6d5a225841705985eb8b"><div class="ttname"><a href="error_8hpp.html#a6d29ef74f19f6d5a225841705985eb8b">notImplementedFunction</a></div><div class="ttdeci">#define notImplementedFunction</div><div class="ttdoc">Report that a function is yet not implemented.</div><div class="ttdef"><b>Definition:</b> <a href="error_8hpp_source.html#l00084">error.hpp:84</a></div></div>
|
||||
<div class="ttc" id="aclasspFlow_1_1dictionary_html_a5585dc9a8b971fbfe2c99fdb75c5d647"><div class="ttname"><a href="classpFlow_1_1dictionary.html#a5585dc9a8b971fbfe2c99fdb75c5d647">pFlow::dictionary::getValOrSet</a></div><div class="ttdeci">T getValOrSet(const word &keyword, const T &setVal) const</div><div class="ttdoc">get the value of data entry or if not found, set the value to setVal</div><div class="ttdef"><b>Definition:</b> <a href="dictionary_8hpp_source.html#l00415">dictionary.hpp:415</a></div></div>
|
||||
<div class="ttc" id="aerror_8hpp_html_aad22a1cd3b45a97ac8cd195f06fe61fe"><div class="ttname"><a href="error_8hpp.html#aad22a1cd3b45a97ac8cd195f06fe61fe">fatalExit</a></div><div class="ttdeci">#define fatalExit</div><div class="ttdoc">Fatal exit.</div><div class="ttdef"><b>Definition:</b> <a href="error_8hpp_source.html#l00098">error.hpp:98</a></div></div>
|
||||
<div class="ttc" id="aclasspFlow_1_1timeInterval_html_a279dae2ee3345fbb2b31e5af9ec0a5b4"><div class="ttname"><a href="classpFlow_1_1timeInterval.html#a279dae2ee3345fbb2b31e5af9ec0a5b4">pFlow::timeInterval::write</a></div><div class="ttdeci">FUNCTION_H bool write(dictionary &dict) const</div><div class="ttdef"><b>Definition:</b> <a href="timeInterval_8cpp_source.html#l00026">timeInterval.cpp:26</a></div></div>
|
||||
<div class="ttc" id="apFlowMacros_8hpp_html_a922d2784284e8f6ee4009c3d92ba48b6"><div class="ttname"><a href="pFlowMacros_8hpp.html#a922d2784284e8f6ee4009c3d92ba48b6">FUNCTION_NAME</a></div><div class="ttdeci">#define FUNCTION_NAME</div><div class="ttdef"><b>Definition:</b> <a href="pFlowMacros_8hpp_source.html#l00029">pFlowMacros.hpp:29</a></div></div>
|
||||
<div class="ttc" id="aclasspFlow_1_1dictionary_html_a85c3c1fce0c14d36030092df2f27b632"><div class="ttname"><a href="classpFlow_1_1dictionary.html#a85c3c1fce0c14d36030092df2f27b632">pFlow::dictionary::globalName</a></div><div class="ttdeci">virtual word globalName() const</div><div class="ttdef"><b>Definition:</b> <a href="dictionary_8cpp_source.html#l00349">dictionary.cpp:349</a></div></div>
|
||||
<div class="ttc" id="aclasspFlow_1_1dictionary_html_a6ae2ea14b8b5e5661c2f207aae2d4bdc"><div class="ttname"><a href="classpFlow_1_1dictionary.html#a6ae2ea14b8b5e5661c2f207aae2d4bdc">pFlow::dictionary::add</a></div><div class="ttdeci">bool add(const word &keyword, const float &v)</div><div class="ttdef"><b>Definition:</b> <a href="dictionary_8cpp_source.html#l00422">dictionary.cpp:422</a></div></div>
|
||||
<div class="ttc" id="aclasspFlow_1_1dictionary_html_a85c3c1fce0c14d36030092df2f27b632"><div class="ttname"><a href="classpFlow_1_1dictionary.html#a85c3c1fce0c14d36030092df2f27b632">pFlow::dictionary::globalName</a></div><div class="ttdeci">virtual word globalName() const</div><div class="ttdoc">global name of entry, separated with dots</div><div class="ttdef"><b>Definition:</b> <a href="dictionary_8cpp_source.html#l00356">dictionary.cpp:356</a></div></div>
|
||||
<div class="ttc" id="aclasspFlow_1_1dictionary_html_a6ae2ea14b8b5e5661c2f207aae2d4bdc"><div class="ttname"><a href="classpFlow_1_1dictionary.html#a6ae2ea14b8b5e5661c2f207aae2d4bdc">pFlow::dictionary::add</a></div><div class="ttdeci">bool add(const word &keyword, const float &v)</div><div class="ttdoc">add a float dataEntry</div><div class="ttdef"><b>Definition:</b> <a href="dictionary_8cpp_source.html#l00435">dictionary.cpp:435</a></div></div>
|
||||
<div class="ttc" id="aclasspFlow_1_1timeInterval_html_ab25b05023549e7fec0ee1d0f6ce239dd"><div class="ttname"><a href="classpFlow_1_1timeInterval.html#ab25b05023549e7fec0ee1d0f6ce239dd">pFlow::timeInterval::read</a></div><div class="ttdeci">FUNCTION_H bool read(const dictionary &dict)</div><div class="ttdef"><b>Definition:</b> <a href="timeInterval_8cpp_source.html#l00017">timeInterval.cpp:17</a></div></div>
|
||||
<div class="ttc" id="anamespacepFlow_html_aba8f0c455a3fdb4b05ad33a25b13b189"><div class="ttname"><a href="namespacepFlow.html#aba8f0c455a3fdb4b05ad33a25b13b189">pFlow::endl</a></div><div class="ttdeci">iOstream & endl(iOstream &os)</div><div class="ttdoc">Add newline and flush stream.</div><div class="ttdef"><b>Definition:</b> <a href="iOstream_8hpp_source.html#l00320">iOstream.hpp:320</a></div></div>
|
||||
<div class="ttc" id="anamespacepFlow_html_a5164661f6974ad24fa90bf19433e6116"><div class="ttname"><a href="namespacepFlow.html#a5164661f6974ad24fa90bf19433e6116">pFlow::realx3</a></div><div class="ttdeci">triple< real > realx3</div><div class="ttdef"><b>Definition:</b> <a href="types_8hpp_source.html#l00048">types.hpp:48</a></div></div>
|
||||
<div class="ttc" id="anamespacepFlow_html_aba8f0c455a3fdb4b05ad33a25b13b189"><div class="ttname"><a href="namespacepFlow.html#aba8f0c455a3fdb4b05ad33a25b13b189">pFlow::endl</a></div><div class="ttdeci">iOstream & endl(iOstream &os)</div><div class="ttdoc">Add newline and flush stream.</div><div class="ttdef"><b>Definition:</b> <a href="iOstream_8hpp_source.html#l00341">iOstream.hpp:341</a></div></div>
|
||||
<div class="ttc" id="anamespacepFlow_html_a5164661f6974ad24fa90bf19433e6116"><div class="ttname"><a href="namespacepFlow.html#a5164661f6974ad24fa90bf19433e6116">pFlow::realx3</a></div><div class="ttdeci">triple< real > realx3</div><div class="ttdef"><b>Definition:</b> <a href="types_8hpp_source.html#l00043">types.hpp:43</a></div></div>
|
||||
<div class="ttc" id="avibrating_8hpp_html"><div class="ttname"><a href="vibrating_8hpp.html">vibrating.hpp</a></div></div>
|
||||
<div class="ttc" id="aclasspFlow_1_1IOstream_html_a367eb3425fc4e8270e2aa961df8ac8a5"><div class="ttname"><a href="classpFlow_1_1IOstream.html#a367eb3425fc4e8270e2aa961df8ac8a5">pFlow::IOstream::check</a></div><div class="ttdeci">virtual bool check(const char *operation) const</div><div class="ttdoc">Check IOstream status for given operation.</div><div class="ttdef"><b>Definition:</b> <a href="IOstream_8cpp_source.html#l00042">IOstream.cpp:42</a></div></div>
|
||||
<div class="ttc" id="apFlowMacros_8hpp_html_a4a0e2a760ea30cb5fe3d40c0cb3fe4a9"><div class="ttname"><a href="pFlowMacros_8hpp.html#a4a0e2a760ea30cb5fe3d40c0cb3fe4a9">FUNCTION_H</a></div><div class="ttdeci">#define FUNCTION_H</div><div class="ttdef"><b>Definition:</b> <a href="pFlowMacros_8hpp_source.html#l00058">pFlowMacros.hpp:58</a></div></div>
|
||||
<div class="ttc" id="aclasspFlow_1_1iIstream_html"><div class="ttname"><a href="classpFlow_1_1iIstream.html">pFlow::iIstream</a></div><div class="ttdef"><b>Definition:</b> <a href="iIstream_8hpp_source.html#l00033">iIstream.hpp:33</a></div></div>
|
||||
<div class="ttc" id="aerror_8hpp_html_aca9aa547c8441e4410a65a2ce7c21554"><div class="ttname"><a href="error_8hpp.html#aca9aa547c8441e4410a65a2ce7c21554">fatalErrorInFunction</a></div><div class="ttdeci">#define fatalErrorInFunction</div><div class="ttdef"><b>Definition:</b> <a href="error_8hpp_source.html#l00042">error.hpp:42</a></div></div>
|
||||
<div class="ttc" id="apFlowMacros_8hpp_html_a4a0e2a760ea30cb5fe3d40c0cb3fe4a9"><div class="ttname"><a href="pFlowMacros_8hpp.html#a4a0e2a760ea30cb5fe3d40c0cb3fe4a9">FUNCTION_H</a></div><div class="ttdeci">#define FUNCTION_H</div><div class="ttdef"><b>Definition:</b> <a href="pFlowMacros_8hpp_source.html#l00062">pFlowMacros.hpp:62</a></div></div>
|
||||
<div class="ttc" id="aclasspFlow_1_1iIstream_html"><div class="ttname"><a href="classpFlow_1_1iIstream.html">pFlow::iIstream</a></div><div class="ttdoc">Interface class for any input stream</div><div class="ttdef"><b>Definition:</b> <a href="iIstream_8hpp_source.html#l00037">iIstream.hpp:37</a></div></div>
|
||||
<div class="ttc" id="aerror_8hpp_html_aca9aa547c8441e4410a65a2ce7c21554"><div class="ttname"><a href="error_8hpp.html#aca9aa547c8441e4410a65a2ce7c21554">fatalErrorInFunction</a></div><div class="ttdeci">#define fatalErrorInFunction</div><div class="ttdoc">Report a fatal error and function name and exit the application.</div><div class="ttdef"><b>Definition:</b> <a href="error_8hpp_source.html#l00077">error.hpp:77</a></div></div>
|
||||
<div class="ttc" id="adictionary_8hpp_html"><div class="ttname"><a href="dictionary_8hpp.html">dictionary.hpp</a></div></div>
|
||||
<div class="ttc" id="aclasspFlow_1_1vibrating_html_ab25b05023549e7fec0ee1d0f6ce239dd"><div class="ttname"><a href="classpFlow_1_1vibrating.html#ab25b05023549e7fec0ee1d0f6ce239dd">pFlow::vibrating::read</a></div><div class="ttdeci">FUNCTION_H bool read(const dictionary &dict)</div><div class="ttdef"><b>Definition:</b> <a href="vibrating_8cpp_source.html#l00040">vibrating.cpp:40</a></div></div>
|
||||
<div class="ttc" id="aclasspFlow_1_1dictionary_html_a523bcff98ab38f3c5961e56eeb0b1d47"><div class="ttname"><a href="classpFlow_1_1dictionary.html#a523bcff98ab38f3c5961e56eeb0b1d47">pFlow::dictionary::getVal</a></div><div class="ttdeci">T getVal(const word &keyword) const</div><div class="ttdef"><b>Definition:</b> <a href="dictionary_8hpp_source.html#l00309">dictionary.hpp:309</a></div></div>
|
||||
<div class="ttc" id="aclasspFlow_1_1dictionary_html_a523bcff98ab38f3c5961e56eeb0b1d47"><div class="ttname"><a href="classpFlow_1_1dictionary.html#a523bcff98ab38f3c5961e56eeb0b1d47">pFlow::dictionary::getVal</a></div><div class="ttdeci">T getVal(const word &keyword) const</div><div class="ttdoc">get the value of data entry</div><div class="ttdef"><b>Definition:</b> <a href="dictionary_8hpp_source.html#l00379">dictionary.hpp:379</a></div></div>
|
||||
<div class="ttc" id="aclasspFlow_1_1vibrating_html_a279dae2ee3345fbb2b31e5af9ec0a5b4"><div class="ttname"><a href="classpFlow_1_1vibrating.html#a279dae2ee3345fbb2b31e5af9ec0a5b4">pFlow::vibrating::write</a></div><div class="ttdeci">FUNCTION_H bool write(dictionary &dict) const</div><div class="ttdef"><b>Definition:</b> <a href="vibrating_8cpp_source.html#l00055">vibrating.cpp:55</a></div></div>
|
||||
<div class="ttc" id="aclasspFlow_1_1vibrating_html_a4c0cbe0ffd49984c2e7986db0d0649ef"><div class="ttname"><a href="classpFlow_1_1vibrating.html#a4c0cbe0ffd49984c2e7986db0d0649ef">pFlow::vibrating::vibrating</a></div><div class="ttdeci">FUNCTION_HD vibrating()=default</div></div>
|
||||
<div class="ttc" id="aclasspFlow_1_1triple_html"><div class="ttname"><a href="classpFlow_1_1triple.html">pFlow::triple< real ></a></div></div>
|
||||
<div class="ttc" id="aclasspFlow_1_1iOstream_html"><div class="ttname"><a href="classpFlow_1_1iOstream.html">pFlow::iOstream</a></div><div class="ttdef"><b>Definition:</b> <a href="iOstream_8hpp_source.html#l00053">iOstream.hpp:53</a></div></div>
|
||||
<div class="ttc" id="aclasspFlow_1_1iOstream_html_a21c60a5f3cd7a26eb97fa28923cbaec6"><div class="ttname"><a href="classpFlow_1_1iOstream.html#a21c60a5f3cd7a26eb97fa28923cbaec6">pFlow::iOstream::writeWordEntry</a></div><div class="ttdeci">iOstream & writeWordEntry(const word &key, const T &value)</div><div class="ttdoc">Write a keyword/value entry.</div><div class="ttdef"><b>Definition:</b> <a href="iOstream_8hpp_source.html#l00224">iOstream.hpp:224</a></div></div>
|
||||
<div class="ttc" id="aclasspFlow_1_1dictionary_html"><div class="ttname"><a href="classpFlow_1_1dictionary.html">pFlow::dictionary</a></div><div class="ttdef"><b>Definition:</b> <a href="dictionary_8hpp_source.html#l00038">dictionary.hpp:38</a></div></div>
|
||||
<div class="ttc" id="aclasspFlow_1_1vibrating_html_a3a6da07d4af1a874177be0d6535c3511"><div class="ttname"><a href="classpFlow_1_1vibrating.html#a3a6da07d4af1a874177be0d6535c3511">pFlow::vibrating::vibrating</a></div><div class="ttdeci">FUNCTION_HD vibrating()</div><div class="ttdef"><b>Definition:</b> <a href="vibrating_8hpp_source.html#l00098">vibrating.hpp:98</a></div></div>
|
||||
<div class="ttc" id="aclasspFlow_1_1iOstream_html"><div class="ttname"><a href="classpFlow_1_1iOstream.html">pFlow::iOstream</a></div><div class="ttdoc">Interface class for any output stream.</div><div class="ttdef"><b>Definition:</b> <a href="iOstream_8hpp_source.html#l00059">iOstream.hpp:59</a></div></div>
|
||||
<div class="ttc" id="aclasspFlow_1_1iOstream_html_a21c60a5f3cd7a26eb97fa28923cbaec6"><div class="ttname"><a href="classpFlow_1_1iOstream.html#a21c60a5f3cd7a26eb97fa28923cbaec6">pFlow::iOstream::writeWordEntry</a></div><div class="ttdeci">iOstream & writeWordEntry(const word &key, const T &value)</div><div class="ttdoc">Write a keyword/value entry.</div><div class="ttdef"><b>Definition:</b> <a href="iOstream_8hpp_source.html#l00239">iOstream.hpp:239</a></div></div>
|
||||
<div class="ttc" id="aclasspFlow_1_1dictionary_html"><div class="ttname"><a href="classpFlow_1_1dictionary.html">pFlow::dictionary</a></div><div class="ttdoc">Dictionary holds a set of data entries or sub-dictionaries that are enclosed in a curely braces or ar...</div><div class="ttdef"><b>Definition:</b> <a href="dictionary_8hpp_source.html#l00067">dictionary.hpp:67</a></div></div>
|
||||
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
|
||||
<ul>
|
||||
<li class="navelem"><a class="el" href="dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li><li class="navelem"><a class="el" href="dir_47ec108d6cccce3c0382fd3240a6cec7.html">MotionModel</a></li><li class="navelem"><a class="el" href="dir_dfffb364e858dce2ad53d04d398ac8d4.html">entities</a></li><li class="navelem"><a class="el" href="dir_ce79a630321861b087ba326c0e4a9313.html">vibrating</a></li><li class="navelem"><a class="el" href="vibrating_8cpp.html">vibrating.cpp</a></li>
|
||||
|
||||
Reference in New Issue
Block a user