uni-days/sea_transport_project
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
sea_transport_project/sea_transport/documentation/html/classapparatus.html
Andrew nuark G 868823ad1a Generated autodoc with doxygen
2021-01-10 21:57:01 +07:00

237 lines
14 KiB
HTML
Raw Permalink Blame History

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://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.9.0"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>seaTransport: apparatus 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="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>
<link href="doxygen.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">seaTransport
&#160;<span id="projectnumber">1.0.0</span>
</div>
<div id="projectbrief">Реализация Информационной системы &quot;Морской транспорт&quot;</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.0 -->
<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','.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
<!-- 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><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pub-static-methods">Static Public Member Functions</a> &#124;
<a href="classapparatus-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">apparatus Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Main system class.
<a href="classapparatus.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="apparatus_8h_source.html">apparatus.h</a>&gt;</code></p>
<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:a263622e0ffe5ca1e0af37c365846244b"><td class="memItemLeft" align="right" valign="top"><a id="a263622e0ffe5ca1e0af37c365846244b"></a>
&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classapparatus.html#a263622e0ffe5ca1e0af37c365846244b">apparatus</a> ()</td></tr>
<tr class="memdesc:a263622e0ffe5ca1e0af37c365846244b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Construct a new apparatus object. <br /></td></tr>
<tr class="separator:a263622e0ffe5ca1e0af37c365846244b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1faf328583d34e7ce1ddfab1cdbc3774"><td class="memItemLeft" align="right" valign="top"><a id="a1faf328583d34e7ce1ddfab1cdbc3774"></a>
&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classapparatus.html#a1faf328583d34e7ce1ddfab1cdbc3774">~apparatus</a> ()</td></tr>
<tr class="memdesc:a1faf328583d34e7ce1ddfab1cdbc3774"><td class="mdescLeft">&#160;</td><td class="mdescRight">Destroy the apparatus object. <br /></td></tr>
<tr class="separator:a1faf328583d34e7ce1ddfab1cdbc3774"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1eeb2bfdd2f264e3b097a6bd97cef059"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classauth__system.html">auth_system</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classapparatus.html#a1eeb2bfdd2f264e3b097a6bd97cef059">get_auth_subsystem</a> ()</td></tr>
<tr class="memdesc:a1eeb2bfdd2f264e3b097a6bd97cef059"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the auth subsystem object. <a href="classapparatus.html#a1eeb2bfdd2f264e3b097a6bd97cef059">More...</a><br /></td></tr>
<tr class="separator:a1eeb2bfdd2f264e3b097a6bd97cef059"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a43ddec7a820e1657b9dfc84bae96b4a2"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classobject__system.html">object_system</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classapparatus.html#a43ddec7a820e1657b9dfc84bae96b4a2">get_object_subsystem</a> ()</td></tr>
<tr class="memdesc:a43ddec7a820e1657b9dfc84bae96b4a2"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the object subsystem object. <a href="classapparatus.html#a43ddec7a820e1657b9dfc84bae96b4a2">More...</a><br /></td></tr>
<tr class="separator:a43ddec7a820e1657b9dfc84bae96b4a2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4f2165b5ee28137a1e52c5eca96260c4"><td class="memItemLeft" align="right" valign="top"><a id="a4f2165b5ee28137a1e52c5eca96260c4"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classapparatus.html#a4f2165b5ee28137a1e52c5eca96260c4">save</a> ()</td></tr>
<tr class="memdesc:a4f2165b5ee28137a1e52c5eca96260c4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Saves system data to disk. <br /></td></tr>
<tr class="separator:a4f2165b5ee28137a1e52c5eca96260c4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a222bf907ab6b7ead5bce6e6d600a68ae"><td class="memItemLeft" align="right" valign="top"><a id="a222bf907ab6b7ead5bce6e6d600a68ae"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classapparatus.html#a222bf907ab6b7ead5bce6e6d600a68ae">load</a> ()</td></tr>
<tr class="memdesc:a222bf907ab6b7ead5bce6e6d600a68ae"><td class="mdescLeft">&#160;</td><td class="mdescRight">Loads system data from disk. <br /></td></tr>
<tr class="separator:a222bf907ab6b7ead5bce6e6d600a68ae"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a>
Static Public Member Functions</h2></td></tr>
<tr class="memitem:a1ab89c34a99cd7208b8d50f2ac9b65ed"><td class="memItemLeft" align="right" valign="top">static bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classapparatus.html#a1ab89c34a99cd7208b8d50f2ac9b65ed">is_first_run</a> ()</td></tr>
<tr class="memdesc:a1ab89c34a99cd7208b8d50f2ac9b65ed"><td class="mdescLeft">&#160;</td><td class="mdescRight">Checks if it is first run. <a href="classapparatus.html#a1ab89c34a99cd7208b8d50f2ac9b65ed">More...</a><br /></td></tr>
<tr class="separator:a1ab89c34a99cd7208b8d50f2ac9b65ed"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab53ff8bcd9db3218cbc9abba306d88a5"><td class="memItemLeft" align="right" valign="top"><a id="ab53ff8bcd9db3218cbc9abba306d88a5"></a>
static void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classapparatus.html#ab53ff8bcd9db3218cbc9abba306d88a5">generate_lock_file</a> ()</td></tr>
<tr class="memdesc:ab53ff8bcd9db3218cbc9abba306d88a5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Generates lock file after initialization. <br /></td></tr>
<tr class="separator:ab53ff8bcd9db3218cbc9abba306d88a5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad7c39d2c2b5d1d866a78e27217f2acb0"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classapparatus.html">apparatus</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classapparatus.html#ad7c39d2c2b5d1d866a78e27217f2acb0">instance</a> ()</td></tr>
<tr class="memdesc:ad7c39d2c2b5d1d866a78e27217f2acb0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get ther main system object. <a href="classapparatus.html#ad7c39d2c2b5d1d866a78e27217f2acb0">More...</a><br /></td></tr>
<tr class="separator:ad7c39d2c2b5d1d866a78e27217f2acb0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a20aecf13e75ff8fa056132c0ddbbc312"><td class="memItemLeft" align="right" valign="top"><a id="a20aecf13e75ff8fa056132c0ddbbc312"></a>
static void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classapparatus.html#a20aecf13e75ff8fa056132c0ddbbc312">init</a> ()</td></tr>
<tr class="memdesc:a20aecf13e75ff8fa056132c0ddbbc312"><td class="mdescLeft">&#160;</td><td class="mdescRight">Initializes system on start. <br /></td></tr>
<tr class="separator:a20aecf13e75ff8fa056132c0ddbbc312"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a33f56a4305c796a07f1783fa56d4bd8b"><td class="memItemLeft" align="right" valign="top"><a id="a33f56a4305c796a07f1783fa56d4bd8b"></a>
static void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classapparatus.html#a33f56a4305c796a07f1783fa56d4bd8b">shutdown</a> ()</td></tr>
<tr class="memdesc:a33f56a4305c796a07f1783fa56d4bd8b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Shuts system down in the end. <br /></td></tr>
<tr class="separator:a33f56a4305c796a07f1783fa56d4bd8b"><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>Main system class. </p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a id="a1eeb2bfdd2f264e3b097a6bd97cef059"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1eeb2bfdd2f264e3b097a6bd97cef059">&#9670;&nbsp;</a></span>get_auth_subsystem()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classauth__system.html">auth_system</a> * apparatus::get_auth_subsystem </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the auth subsystem object. </p>
<dl class="section return"><dt>Returns</dt><dd>auth_system* </dd></dl>
</div>
</div>
<a id="a43ddec7a820e1657b9dfc84bae96b4a2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a43ddec7a820e1657b9dfc84bae96b4a2">&#9670;&nbsp;</a></span>get_object_subsystem()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classobject__system.html">object_system</a> * apparatus::get_object_subsystem </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the object subsystem object. </p>
<dl class="section return"><dt>Returns</dt><dd>object_system* </dd></dl>
</div>
</div>
<a id="ad7c39d2c2b5d1d866a78e27217f2acb0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad7c39d2c2b5d1d866a78e27217f2acb0">&#9670;&nbsp;</a></span>instance()</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="classapparatus.html">apparatus</a> * apparatus::instance </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Get ther main system object. </p>
<dl class="section return"><dt>Returns</dt><dd>apparatus* </dd></dl>
</div>
</div>
<a id="a1ab89c34a99cd7208b8d50f2ac9b65ed"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1ab89c34a99cd7208b8d50f2ac9b65ed">&#9670;&nbsp;</a></span>is_first_run()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool apparatus::is_first_run </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Checks if it is first run. </p>
<dl class="section return"><dt>Returns</dt><dd>true </dd>
<dd>
false </dd></dl>
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li>system/<a class="el" href="apparatus_8h_source.html">apparatus.h</a></li>
<li>system/apparatus.cpp</li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.0
</small></address>
</body>
</html>
Reference in a new issue View git blame Copy permalink