mirror of
https://github.com/PhasicFlow/phasicFlow.git
synced 2025-06-22 16:28:30 +00:00
documentation for v1.0
This commit is contained in:
HRN
@ -341,37 +341,37 @@ $(document).ready(function(){initNavTree('tokenIO_8cpp_source.html',''); initRes
|
||||
<div class="line"><a name="l00234"></a><span class="lineno"> 234</span>  </div>
|
||||
</div><!-- fragment --></div><!-- contents -->
|
||||
</div><!-- doc-content -->
|
||||
<div class="ttc" id="aclasspFlow_1_1iOstream_html_a8da7514808d6493ccfd30582fc945aa1"><div class="ttname"><a href="classpFlow_1_1iOstream.html#a8da7514808d6493ccfd30582fc945aa1">pFlow::iOstream::write</a></div><div class="ttdeci">virtual bool write(const token &tok)=0</div><div class="ttdoc">Write Functions.</div></div>
|
||||
<div class="ttc" id="aclasspFlow_1_1token_html_a60330c34e8555025752e615e0c73e99a"><div class="ttname"><a href="classpFlow_1_1token.html#a60330c34e8555025752e615e0c73e99a">pFlow::token::type</a></div><div class="ttdeci">tokenType type() const</div><div class="ttdef"><b>Definition:</b> <a href="tokenI_8hpp_source.html#l00284">tokenI.hpp:284</a></div></div>
|
||||
<div class="ttc" id="aclasspFlow_1_1iIstream_html_ac35c0ab7b3a6a0cdcf8c2bd2bf24de11"><div class="ttname"><a href="classpFlow_1_1iIstream.html#ac35c0ab7b3a6a0cdcf8c2bd2bf24de11">pFlow::iIstream::read</a></div><div class="ttdeci">virtual iIstream & read(token &)=0</div></div>
|
||||
<div class="ttc" id="aclasspFlow_1_1token_html"><div class="ttname"><a href="classpFlow_1_1token.html">pFlow::token</a></div><div class="ttdef"><b>Definition:</b> <a href="token_8hpp_source.html#l00042">token.hpp:42</a></div></div>
|
||||
<div class="ttc" id="aclasspFlow_1_1token_html_aaa8bf55f686d97ee30090681fd0bfc04"><div class="ttname"><a href="classpFlow_1_1token.html#aaa8bf55f686d97ee30090681fd0bfc04">pFlow::token::pToken</a></div><div class="ttdeci">punctuationToken pToken() const</div><div class="ttdef"><b>Definition:</b> <a href="tokenI_8hpp_source.html#l00452">tokenI.hpp:452</a></div></div>
|
||||
<div class="ttc" id="aclasspFlow_1_1iOstream_html_a8da7514808d6493ccfd30582fc945aa1"><div class="ttname"><a href="classpFlow_1_1iOstream.html#a8da7514808d6493ccfd30582fc945aa1">pFlow::iOstream::write</a></div><div class="ttdeci">virtual bool write(const token &tok)=0</div><div class="ttdoc">Write token to stream or otherwise handle it.</div></div>
|
||||
<div class="ttc" id="aclasspFlow_1_1token_html_a60330c34e8555025752e615e0c73e99a"><div class="ttname"><a href="classpFlow_1_1token.html#a60330c34e8555025752e615e0c73e99a">pFlow::token::type</a></div><div class="ttdeci">tokenType type() const</div><div class="ttdoc">Return the token type.</div><div class="ttdef"><b>Definition:</b> <a href="tokenI_8hpp_source.html#l00302">tokenI.hpp:302</a></div></div>
|
||||
<div class="ttc" id="aclasspFlow_1_1iIstream_html_ac35c0ab7b3a6a0cdcf8c2bd2bf24de11"><div class="ttname"><a href="classpFlow_1_1iIstream.html#ac35c0ab7b3a6a0cdcf8c2bd2bf24de11">pFlow::iIstream::read</a></div><div class="ttdeci">virtual iIstream & read(token &)=0</div><div class="ttdoc">Return next token from stream.</div></div>
|
||||
<div class="ttc" id="aclasspFlow_1_1token_html"><div class="ttname"><a href="classpFlow_1_1token.html">pFlow::token</a></div><div class="ttdoc">Token class based on OpenFOAM stream, with some modifications/simplifications to be tailored to our n...</div><div class="ttdef"><b>Definition:</b> <a href="token_8hpp_source.html#l00044">token.hpp:44</a></div></div>
|
||||
<div class="ttc" id="aclasspFlow_1_1token_html_aaa8bf55f686d97ee30090681fd0bfc04"><div class="ttname"><a href="classpFlow_1_1token.html#aaa8bf55f686d97ee30090681fd0bfc04">pFlow::token::pToken</a></div><div class="ttdeci">punctuationToken pToken() const</div><div class="ttdoc">Return punctuation character.</div><div class="ttdef"><b>Definition:</b> <a href="tokenI_8hpp_source.html#l00470">tokenI.hpp:470</a></div></div>
|
||||
<div class="ttc" id="aiIstream_8hpp_html"><div class="ttname"><a href="iIstream_8hpp.html">iIstream.hpp</a></div></div>
|
||||
<div class="ttc" id="anamespacepFlow_html_a085bff06be72a06c81e84c1d1cb3a21a"><div class="ttname"><a href="namespacepFlow.html#a085bff06be72a06c81e84c1d1cb3a21a">pFlow::printTokenInfo</a></div><div class="ttdeci">static OS & printTokenInfo(OS &os, const token &tok)</div><div class="ttdef"><b>Definition:</b> <a href="tokenIO_8cpp_source.html#l00032">tokenIO.cpp:32</a></div></div>
|
||||
<div class="ttc" id="aerror_8hpp_html_a889d5e8bf195a24964ffb883bcb2fc3b"><div class="ttname"><a href="error_8hpp.html#a889d5e8bf195a24964ffb883bcb2fc3b">warningInFunction</a></div><div class="ttdeci">#define warningInFunction</div><div class="ttdef"><b>Definition:</b> <a href="error_8hpp_source.html#l00055">error.hpp:55</a></div></div>
|
||||
<div class="ttc" id="aclasspFlow_1_1token_html_a4aba281d025f1d580c3835d67656fd31"><div class="ttname"><a href="classpFlow_1_1token.html#a4aba281d025f1d580c3835d67656fd31">pFlow::token::punctuationToken</a></div><div class="ttdeci">punctuationToken</div><div class="ttdef"><b>Definition:</b> <a href="token_8hpp_source.html#l00081">token.hpp:81</a></div></div>
|
||||
<div class="ttc" id="aclasspFlow_1_1token_html_aa81aefc6aea3503b1eb4aefbafc8d0bc"><div class="ttname"><a href="classpFlow_1_1token.html#aa81aefc6aea3503b1eb4aefbafc8d0bc">pFlow::token::stringToken</a></div><div class="ttdeci">const word & stringToken() const</div><div class="ttdef"><b>Definition:</b> <a href="tokenI_8hpp_source.html#l00624">tokenI.hpp:624</a></div></div>
|
||||
<div class="ttc" id="aerror_8hpp_html_a889d5e8bf195a24964ffb883bcb2fc3b"><div class="ttname"><a href="error_8hpp.html#a889d5e8bf195a24964ffb883bcb2fc3b">warningInFunction</a></div><div class="ttdeci">#define warningInFunction</div><div class="ttdoc">Report a warning.</div><div class="ttdef"><b>Definition:</b> <a href="error_8hpp_source.html#l00095">error.hpp:95</a></div></div>
|
||||
<div class="ttc" id="aclasspFlow_1_1token_html_a4aba281d025f1d580c3835d67656fd31"><div class="ttname"><a href="classpFlow_1_1token.html#a4aba281d025f1d580c3835d67656fd31">pFlow::token::punctuationToken</a></div><div class="ttdeci">punctuationToken</div><div class="ttdoc">Standard punctuation tokens (a character)</div><div class="ttdef"><b>Definition:</b> <a href="token_8hpp_source.html#l00083">token.hpp:83</a></div></div>
|
||||
<div class="ttc" id="aclasspFlow_1_1token_html_aa81aefc6aea3503b1eb4aefbafc8d0bc"><div class="ttname"><a href="classpFlow_1_1token.html#aa81aefc6aea3503b1eb4aefbafc8d0bc">pFlow::token::stringToken</a></div><div class="ttdeci">const word & stringToken() const</div><div class="ttdoc">Return const reference to the string contents.</div><div class="ttdef"><b>Definition:</b> <a href="tokenI_8hpp_source.html#l00642">tokenI.hpp:642</a></div></div>
|
||||
<div class="ttc" id="atoken_8hpp_html"><div class="ttname"><a href="token_8hpp.html">token.hpp</a></div></div>
|
||||
<div class="ttc" id="anamespacepFlow_html_a0ebe792a293e8c717bddf60070c0fe99"><div class="ttname"><a href="namespacepFlow.html#a0ebe792a293e8c717bddf60070c0fe99">pFlow::word</a></div><div class="ttdeci">std::string word</div><div class="ttdef"><b>Definition:</b> <a href="builtinTypes_8hpp_source.html#l00063">builtinTypes.hpp:63</a></div></div>
|
||||
<div class="ttc" id="anamespacepFlow_html_a0ebe792a293e8c717bddf60070c0fe99"><div class="ttname"><a href="namespacepFlow.html#a0ebe792a293e8c717bddf60070c0fe99">pFlow::word</a></div><div class="ttdeci">std::string word</div><div class="ttdef"><b>Definition:</b> <a href="builtinTypes_8hpp_source.html#l00064">builtinTypes.hpp:64</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_1token_html_a527884d8106fbcdc51fb1d8b937b9f71"><div class="ttname"><a href="classpFlow_1_1token.html#a527884d8106fbcdc51fb1d8b937b9f71">pFlow::token::int64Token</a></div><div class="ttdeci">int64 int64Token() const</div><div class="ttdef"><b>Definition:</b> <a href="tokenI_8hpp_source.html#l00484">tokenI.hpp:484</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"><div class="ttname"><a href="namespacepFlow.html">pFlow</a></div><div class="ttdef"><b>Definition:</b> <a href="demComponent_8hpp_source.html#l00028">demComponent.hpp:28</a></div></div>
|
||||
<div class="ttc" id="aclasspFlow_1_1token_html_a527884d8106fbcdc51fb1d8b937b9f71"><div class="ttname"><a href="classpFlow_1_1token.html#a527884d8106fbcdc51fb1d8b937b9f71">pFlow::token::int64Token</a></div><div class="ttdeci">int64 int64Token() const</div><div class="ttdoc">Return int64 value.</div><div class="ttdef"><b>Definition:</b> <a href="tokenI_8hpp_source.html#l00502">tokenI.hpp:502</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"><div class="ttname"><a href="namespacepFlow.html">pFlow</a></div><div class="ttdef"><b>Definition:</b> <a href="demGeometry_8hpp_source.html#l00027">demGeometry.hpp:27</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="aclasspFlow_1_1token_html_ad20897c5c8bd47f5d4005989bead0e55"><div class="ttname"><a href="classpFlow_1_1token.html#ad20897c5c8bd47f5d4005989bead0e55">pFlow::token::reset</a></div><div class="ttdeci">void reset()</div><div class="ttdef"><b>Definition:</b> <a href="tokenI_8hpp_source.html#l00245">tokenI.hpp:245</a></div></div>
|
||||
<div class="ttc" id="aclasspFlow_1_1token_html_a72af10fee1f9c2ef1de55b08a0c429ed"><div class="ttname"><a href="classpFlow_1_1token.html#a72af10fee1f9c2ef1de55b08a0c429ed">pFlow::token::token</a></div><div class="ttdeci">constexpr token() noexcept</div><div class="ttdef"><b>Definition:</b> <a href="tokenI_8hpp_source.html#l00089">tokenI.hpp:89</a></div></div>
|
||||
<div class="ttc" id="aclasspFlow_1_1token_html_a9de6957d916b0d8a10cab9c0e2688fe6"><div class="ttname"><a href="classpFlow_1_1token.html#a9de6957d916b0d8a10cab9c0e2688fe6">pFlow::token::doubleToken</a></div><div class="ttdeci">double doubleToken() const</div><div class="ttdef"><b>Definition:</b> <a href="tokenI_8hpp_source.html#l00524">tokenI.hpp:524</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="aclasspFlow_1_1token_html_ad20897c5c8bd47f5d4005989bead0e55"><div class="ttname"><a href="classpFlow_1_1token.html#ad20897c5c8bd47f5d4005989bead0e55">pFlow::token::reset</a></div><div class="ttdeci">void reset()</div><div class="ttdoc">Reset token to UNDEFINED and clear any allocated storage.</div><div class="ttdef"><b>Definition:</b> <a href="tokenI_8hpp_source.html#l00263">tokenI.hpp:263</a></div></div>
|
||||
<div class="ttc" id="aclasspFlow_1_1token_html_a72af10fee1f9c2ef1de55b08a0c429ed"><div class="ttname"><a href="classpFlow_1_1token.html#a72af10fee1f9c2ef1de55b08a0c429ed">pFlow::token::token</a></div><div class="ttdeci">constexpr token() noexcept</div><div class="ttdoc">Default construct, initialized to an UNDEFINED token.</div><div class="ttdef"><b>Definition:</b> <a href="tokenI_8hpp_source.html#l00089">tokenI.hpp:89</a></div></div>
|
||||
<div class="ttc" id="aclasspFlow_1_1token_html_a9de6957d916b0d8a10cab9c0e2688fe6"><div class="ttname"><a href="classpFlow_1_1token.html#a9de6957d916b0d8a10cab9c0e2688fe6">pFlow::token::doubleToken</a></div><div class="ttdeci">double doubleToken() const</div><div class="ttdoc">Return double value.</div><div class="ttdef"><b>Definition:</b> <a href="tokenI_8hpp_source.html#l00542">tokenI.hpp:542</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="aclasspFlow_1_1token_html_aa74a2c0611922abf868950e4fe75d00d"><div class="ttname"><a href="classpFlow_1_1token.html#aa74a2c0611922abf868950e4fe75d00d">pFlow::token::printInfo</a></div><div class="ttdeci">iOstream & printInfo(iOstream &os) const</div><div class="ttdef"><b>Definition:</b> <a href="tokenIO_8cpp_source.html#l00224">tokenIO.cpp:224</a></div></div>
|
||||
<div class="ttc" id="anamespacepFlow_html_a85ed561d066dae339196cd058783674f"><div class="ttname"><a href="namespacepFlow.html#a85ed561d066dae339196cd058783674f">pFlow::operator>></a></div><div class="ttdeci">INLINE_FUNCTION iIstream & operator>>(iIstream &str, AB3History &ab3)</div><div class="ttdef"><b>Definition:</b> <a href="AdamsBashforth3_8hpp_source.html#l00041">AdamsBashforth3.hpp:41</a></div></div>
|
||||
<div class="ttc" id="aclasspFlow_1_1token_html_a4c72fd962e5ec6cf9143fb6a78ddb2ab"><div class="ttname"><a href="classpFlow_1_1token.html#a4c72fd962e5ec6cf9143fb6a78ddb2ab">pFlow::token::floatToken</a></div><div class="ttdeci">float floatToken() const</div><div class="ttdef"><b>Definition:</b> <a href="tokenI_8hpp_source.html#l00506">tokenI.hpp:506</a></div></div>
|
||||
<div class="ttc" id="aclasspFlow_1_1token_html_a4c72fd962e5ec6cf9143fb6a78ddb2ab"><div class="ttname"><a href="classpFlow_1_1token.html#a4c72fd962e5ec6cf9143fb6a78ddb2ab">pFlow::token::floatToken</a></div><div class="ttdeci">float floatToken() const</div><div class="ttdoc">Return float value.</div><div class="ttdef"><b>Definition:</b> <a href="tokenI_8hpp_source.html#l00524">tokenI.hpp:524</a></div></div>
|
||||
<div class="ttc" id="anamespacepFlow_html_a148d74ad0977268be8ea8b26a147f619"><div class="ttname"><a href="namespacepFlow.html#a148d74ad0977268be8ea8b26a147f619">pFlow::operator<<</a></div><div class="ttdeci">INLINE_FUNCTION iOstream & operator<<(iOstream &str, const AB3History &ab3)</div><div class="ttdef"><b>Definition:</b> <a href="AdamsBashforth3_8hpp_source.html#l00057">AdamsBashforth3.hpp:57</a></div></div>
|
||||
<div class="ttc" id="aiOstream_8hpp_html"><div class="ttname"><a href="iOstream_8hpp.html">iOstream.hpp</a></div></div>
|
||||
<div class="ttc" id="aclasspFlow_1_1token_html_a4c4b7703e6fdb86d441032675709e39c"><div class="ttname"><a href="classpFlow_1_1token.html#a4c4b7703e6fdb86d441032675709e39c">pFlow::token::name</a></div><div class="ttdeci">word name() const</div><div class="ttdef"><b>Definition:</b> <a href="tokenIO_8cpp_source.html#l00110">tokenIO.cpp:110</a></div></div>
|
||||
<div class="ttc" id="aclasspFlow_1_1token_html_a828aae3b94527316d86c741d8d17976b"><div class="ttname"><a href="classpFlow_1_1token.html#a828aae3b94527316d86c741d8d17976b">pFlow::token::type_</a></div><div class="ttdeci">tokenType type_</div><div class="ttdef"><b>Definition:</b> <a href="token_8hpp_source.html#l00182">token.hpp:182</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_1token_html_a8658f0b0a04ffdb6e74c5af4ca27edf1"><div class="ttname"><a href="classpFlow_1_1token.html#a8658f0b0a04ffdb6e74c5af4ca27edf1">pFlow::token::wordToken</a></div><div class="ttdeci">const word & wordToken() const</div><div class="ttdef"><b>Definition:</b> <a href="tokenI_8hpp_source.html#l00600">tokenI.hpp:600</a></div></div>
|
||||
<div class="ttc" id="aclasspFlow_1_1token_html_a1c8abe34223b7d5e9341eac78c9907b5"><div class="ttname"><a href="classpFlow_1_1token.html#a1c8abe34223b7d5e9341eac78c9907b5">pFlow::token::lineNumber</a></div><div class="ttdeci">int32 lineNumber() const</div><div class="ttdef"><b>Definition:</b> <a href="tokenI_8hpp_source.html#l00360">tokenI.hpp:360</a></div></div>
|
||||
<div class="ttc" id="aclasspFlow_1_1token_html_a4c4b7703e6fdb86d441032675709e39c"><div class="ttname"><a href="classpFlow_1_1token.html#a4c4b7703e6fdb86d441032675709e39c">pFlow::token::name</a></div><div class="ttdeci">word name() const</div><div class="ttdoc">Return the name of the token type.</div><div class="ttdef"><b>Definition:</b> <a href="tokenIO_8cpp_source.html#l00110">tokenIO.cpp:110</a></div></div>
|
||||
<div class="ttc" id="aclasspFlow_1_1token_html_a828aae3b94527316d86c741d8d17976b"><div class="ttname"><a href="classpFlow_1_1token.html#a828aae3b94527316d86c741d8d17976b">pFlow::token::type_</a></div><div class="ttdeci">tokenType type_</div><div class="ttdoc">The token type.</div><div class="ttdef"><b>Definition:</b> <a href="token_8hpp_source.html#l00184">token.hpp:184</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_1token_html_a8658f0b0a04ffdb6e74c5af4ca27edf1"><div class="ttname"><a href="classpFlow_1_1token.html#a8658f0b0a04ffdb6e74c5af4ca27edf1">pFlow::token::wordToken</a></div><div class="ttdeci">const word & wordToken() const</div><div class="ttdoc">Return const reference to the word contents.</div><div class="ttdef"><b>Definition:</b> <a href="tokenI_8hpp_source.html#l00618">tokenI.hpp:618</a></div></div>
|
||||
<div class="ttc" id="aclasspFlow_1_1token_html_a1c8abe34223b7d5e9341eac78c9907b5"><div class="ttname"><a href="classpFlow_1_1token.html#a1c8abe34223b7d5e9341eac78c9907b5">pFlow::token::lineNumber</a></div><div class="ttdeci">int32 lineNumber() const</div><div class="ttdoc">The line number for the token.</div><div class="ttdef"><b>Definition:</b> <a href="tokenI_8hpp_source.html#l00378">tokenI.hpp:378</a></div></div>
|
||||
<div class="ttc" id="aerror_8hpp_html"><div class="ttname"><a href="error_8hpp.html">error.hpp</a></div></div>
|
||||
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
|
||||
<ul>
|
||||
|
||||
Reference in New Issue
Block a user