Skip to content

Commit

Permalink
Commiting Documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
GitHub Action committed Mar 25, 2024
1 parent 7ffad47 commit 4b951bc
Show file tree
Hide file tree
Showing 734 changed files with 28,227 additions and 35,592 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -290,7 +290,7 @@
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="footer">Generated on Fri Mar 22 2024 02:55:45 for NGen by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.8 </li>
<li class="footer">Generated on Mon Mar 25 2024 15:10:06 for NGen by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.8 </li>
</ul>
</div>
</body>
Expand Down
12 changes: 6 additions & 6 deletions _abstract_c_lib_bmi_adapter_8hpp_source.html
Original file line number Diff line number Diff line change
Expand Up @@ -292,11 +292,11 @@
<div class="ttc" id="aclassmodels_1_1bmi_1_1_abstract_c_lib_bmi_adapter_html_aee6c52698d720f8cb2607e3b3409a516"><div class="ttname"><a href="classmodels_1_1bmi_1_1_abstract_c_lib_bmi_adapter.html#aee6c52698d720f8cb2607e3b3409a516">models::bmi::AbstractCLibBmiAdapter::dynamic_library_load</a></div><div class="ttdeci">void dynamic_library_load()</div><div class="ttdoc">Dynamically load and obtain this instance's handle to the shared library.</div><div class="ttdef"><b>Definition</b> AbstractCLibBmiAdapter.hpp:79</div></div>
<div class="ttc" id="aclassmodels_1_1bmi_1_1_abstract_c_lib_bmi_adapter_html_afac72323e2bdf05953f6858ea068972c"><div class="ttname"><a href="classmodels_1_1bmi_1_1_abstract_c_lib_bmi_adapter.html#afac72323e2bdf05953f6858ea068972c">models::bmi::AbstractCLibBmiAdapter::AbstractCLibBmiAdapter</a></div><div class="ttdeci">AbstractCLibBmiAdapter(const std::string &amp;type_name, std::string library_file_path, std::string bmi_init_config, std::string forcing_file_path, bool allow_exceed_end, bool has_fixed_time_step, std::string registration_func, utils::StreamHandler output)</div><div class="ttdoc">Main public constructor.</div><div class="ttdef"><b>Definition</b> AbstractCLibBmiAdapter.hpp:28</div></div>
<div class="ttc" id="aclassmodels_1_1bmi_1_1_bmi___adapter_html"><div class="ttname"><a href="classmodels_1_1bmi_1_1_bmi___adapter.html">models::bmi::Bmi_Adapter</a></div><div class="ttdoc">Abstract adapter interface for C++ classes to interact with the essential aspects of external models ...</div><div class="ttdef"><b>Definition</b> Bmi_Adapter.hpp:19</div></div>
<div class="ttc" id="aclassmodels_1_1bmi_1_1_bmi___adapter_html_a2698bc13d9ced362e18cb8cf0dab82d7"><div class="ttname"><a href="classmodels_1_1bmi_1_1_bmi___adapter.html#a2698bc13d9ced362e18cb8cf0dab82d7">models::bmi::Bmi_Adapter::init_exception_msg</a></div><div class="ttdeci">std::string init_exception_msg</div><div class="ttdoc">Message from an exception (if encountered) on the first attempt to initialize the backing model.</div><div class="ttdef"><b>Definition</b> Bmi_Adapter.hpp:235</div></div>
<div class="ttc" id="aclassmodels_1_1bmi_1_1_bmi___adapter_html_a32725cc98663e54694c90c8740e8e5dd"><div class="ttname"><a href="classmodels_1_1bmi_1_1_bmi___adapter.html#a32725cc98663e54694c90c8740e8e5dd">models::bmi::Bmi_Adapter::bmi_init_config</a></div><div class="ttdeci">std::string bmi_init_config</div><div class="ttdoc">Path (as a string) to the BMI config file for initializing the backing model (empty if none).</div><div class="ttdef"><b>Definition</b> Bmi_Adapter.hpp:224</div></div>
<div class="ttc" id="aclassmodels_1_1bmi_1_1_bmi___adapter_html_a6bfb2f398f00c3b44b1235d4758f0c91"><div class="ttname"><a href="classmodels_1_1bmi_1_1_bmi___adapter.html#a6bfb2f398f00c3b44b1235d4758f0c91">models::bmi::Bmi_Adapter::output</a></div><div class="ttdeci">utils::StreamHandler output</div><div class="ttdef"><b>Definition</b> Bmi_Adapter.hpp:241</div></div>
<div class="ttc" id="aclassmodels_1_1bmi_1_1_bmi___adapter_html_ac2c1d1c1e279212c200ad6a4be4864d6"><div class="ttname"><a href="classmodels_1_1bmi_1_1_bmi___adapter.html#ac2c1d1c1e279212c200ad6a4be4864d6">models::bmi::Bmi_Adapter::model_name</a></div><div class="ttdeci">std::string model_name</div><div class="ttdef"><b>Definition</b> Bmi_Adapter.hpp:240</div></div>
<div class="ttc" id="aclassmodels_1_1bmi_1_1_bmi___adapter_html_ae6d1be4a39ef76547004c3392b95f3e4"><div class="ttname"><a href="classmodels_1_1bmi_1_1_bmi___adapter.html#ae6d1be4a39ef76547004c3392b95f3e4">models::bmi::Bmi_Adapter::forcing_file_path</a></div><div class="ttdeci">std::string forcing_file_path</div><div class="ttdef"><b>Definition</b> Bmi_Adapter.hpp:233</div></div>
<div class="ttc" id="aclassmodels_1_1bmi_1_1_bmi___adapter_html_a2698bc13d9ced362e18cb8cf0dab82d7"><div class="ttname"><a href="classmodels_1_1bmi_1_1_bmi___adapter.html#a2698bc13d9ced362e18cb8cf0dab82d7">models::bmi::Bmi_Adapter::init_exception_msg</a></div><div class="ttdeci">std::string init_exception_msg</div><div class="ttdoc">Message from an exception (if encountered) on the first attempt to initialize the backing model.</div><div class="ttdef"><b>Definition</b> Bmi_Adapter.hpp:242</div></div>
<div class="ttc" id="aclassmodels_1_1bmi_1_1_bmi___adapter_html_a32725cc98663e54694c90c8740e8e5dd"><div class="ttname"><a href="classmodels_1_1bmi_1_1_bmi___adapter.html#a32725cc98663e54694c90c8740e8e5dd">models::bmi::Bmi_Adapter::bmi_init_config</a></div><div class="ttdeci">std::string bmi_init_config</div><div class="ttdoc">Path (as a string) to the BMI config file for initializing the backing model (empty if none).</div><div class="ttdef"><b>Definition</b> Bmi_Adapter.hpp:231</div></div>
<div class="ttc" id="aclassmodels_1_1bmi_1_1_bmi___adapter_html_a6bfb2f398f00c3b44b1235d4758f0c91"><div class="ttname"><a href="classmodels_1_1bmi_1_1_bmi___adapter.html#a6bfb2f398f00c3b44b1235d4758f0c91">models::bmi::Bmi_Adapter::output</a></div><div class="ttdeci">utils::StreamHandler output</div><div class="ttdef"><b>Definition</b> Bmi_Adapter.hpp:248</div></div>
<div class="ttc" id="aclassmodels_1_1bmi_1_1_bmi___adapter_html_ac2c1d1c1e279212c200ad6a4be4864d6"><div class="ttname"><a href="classmodels_1_1bmi_1_1_bmi___adapter.html#ac2c1d1c1e279212c200ad6a4be4864d6">models::bmi::Bmi_Adapter::model_name</a></div><div class="ttdeci">std::string model_name</div><div class="ttdef"><b>Definition</b> Bmi_Adapter.hpp:247</div></div>
<div class="ttc" id="aclassmodels_1_1bmi_1_1_bmi___adapter_html_ae6d1be4a39ef76547004c3392b95f3e4"><div class="ttname"><a href="classmodels_1_1bmi_1_1_bmi___adapter.html#ae6d1be4a39ef76547004c3392b95f3e4">models::bmi::Bmi_Adapter::forcing_file_path</a></div><div class="ttdeci">std::string forcing_file_path</div><div class="ttdef"><b>Definition</b> Bmi_Adapter.hpp:240</div></div>
<div class="ttc" id="aclassutils_1_1_file_checker_html_a574d8d1e1a399c0a7afea3212c2f88fb"><div class="ttname"><a href="classutils_1_1_file_checker.html#a574d8d1e1a399c0a7afea3212c2f88fb">utils::FileChecker::file_is_readable</a></div><div class="ttdeci">static bool file_is_readable(std::string path)</div><div class="ttdoc">Check whether the path provided points to an existing, readable file.</div><div class="ttdef"><b>Definition</b> FileChecker.h:90</div></div>
<div class="ttc" id="aclassutils_1_1_stream_handler_html"><div class="ttname"><a href="classutils_1_1_stream_handler.html">utils::StreamHandler</a></div><div class="ttdoc">This class provides a copyable interface to a std::ostream or std::ostream like object that may not s...</div><div class="ttdef"><b>Definition</b> StreamHandler.hpp:14</div></div>
<div class="ttc" id="aclassutils_1_1_stream_handler_html_a37b9e817a29d162b43066c3f60debe3f"><div class="ttname"><a href="classutils_1_1_stream_handler.html#a37b9e817a29d162b43066c3f60debe3f">utils::StreamHandler::put</a></div><div class="ttdeci">void put(const DataType &amp;val)</div><div class="ttdoc">Serialize data onto the stored stream.</div><div class="ttdef"><b>Definition</b> StreamHandler.hpp:59</div></div>
Expand All @@ -308,7 +308,7 @@
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="dir_d44c64559bbebec7f509842c48db8b23.html">include</a></li><li class="navelem"><a class="el" href="dir_7688c87f5c9cad4c135b176d94e89e38.html">bmi</a></li><li class="navelem"><b>AbstractCLibBmiAdapter.hpp</b></li>
<li class="footer">Generated on Fri Mar 22 2024 02:55:45 for NGen by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.8 </li>
<li class="footer">Generated on Mon Mar 25 2024 15:10:06 for NGen by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.8 </li>
</ul>
</div>
</body>
Expand Down
2 changes: 1 addition & 1 deletion _aorc_forcing_8hpp_source.html
Original file line number Diff line number Diff line change
Expand Up @@ -228,7 +228,7 @@
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="dir_d44c64559bbebec7f509842c48db8b23.html">include</a></li><li class="navelem"><a class="el" href="dir_1a34ade7a8ced74dfa5d1494ffac178f.html">forcing</a></li><li class="navelem"><b>AorcForcing.hpp</b></li>
<li class="footer">Generated on Fri Mar 22 2024 02:55:45 for NGen by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.8 </li>
<li class="footer">Generated on Mon Mar 25 2024 15:10:07 for NGen by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.8 </li>
</ul>
</div>
</body>
Expand Down
2 changes: 1 addition & 1 deletion _async_data_provider_8hpp_source.html
Original file line number Diff line number Diff line change
Expand Up @@ -130,7 +130,7 @@
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="dir_d44c64559bbebec7f509842c48db8b23.html">include</a></li><li class="navelem"><a class="el" href="dir_1a34ade7a8ced74dfa5d1494ffac178f.html">forcing</a></li><li class="navelem"><b>AsyncDataProvider.hpp</b></li>
<li class="footer">Generated on Fri Mar 22 2024 02:55:45 for NGen by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.8 </li>
<li class="footer">Generated on Mon Mar 25 2024 15:10:07 for NGen by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.8 </li>
</ul>
</div>
</body>
Expand Down
Loading

0 comments on commit 4b951bc

Please sign in to comment.