QuasarApp/Patronum
4
0
Fork 0
mirror of https://github.com/QuasarApp/Patronum.git synced 2025-05-08 13:09:33 +00:00
Code Issues Projects Releases Wiki Activity
Patronum/doc/doxygen/html/classPatronum_1_1Service.html
EndrII fae9791114 added doxygen docs
2020-04-18 22:43:33 +03:00

324 lines
16 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.13"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Patronum: Patronum::Service&lt; Application &gt; Class Template 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>
<script type="text/javascript">
$(document).ready(initResizable);
</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">Patronum
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.13 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
</script>
<div id="main-nav"></div>
</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">
$(document).ready(function(){initNavTree('classPatronum_1_1Service.html','');});
</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-methods">Protected Member Functions</a> &#124;
<a href="classPatronum_1_1Service-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">Patronum::Service&lt; Application &gt; Class Template Reference</div> </div>
</div><!--header-->
<div class="contents">
<p><code>#include &lt;<a class="el" href="service_8h_source.html">service.h</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for Patronum::Service&lt; Application &gt;:</div>
<div class="dyncontent">
<div class="center"><img src="classPatronum_1_1Service__inherit__graph.png" border="0" usemap="#Patronum_1_1Service_3_01Application_01_4_inherit__map" alt="Inheritance graph"/></div>
<map name="Patronum_1_1Service_3_01Application_01_4_inherit__map" id="Patronum_1_1Service_3_01Application_01_4_inherit__map">
<area shape="rect" id="node3" href="classPatronum_1_1IService.html" title="{Patronum::IService\n||+ IService()\l+ handleReceve()\l+ supportedFeatures()\l}" alt="" coords="198,5,349,112"/>
</map>
</div>
<div class="dynheader">
Collaboration diagram for Patronum::Service&lt; Application &gt;:</div>
<div class="dyncontent">
<div class="center"><img src="classPatronum_1_1Service__coll__graph.png" border="0" usemap="#Patronum_1_1Service_3_01Application_01_4_coll__map" alt="Collaboration graph"/></div>
<map name="Patronum_1_1Service_3_01Application_01_4_coll__map" id="Patronum_1_1Service_3_01Application_01_4_coll__map">
<area shape="rect" id="node3" href="classPatronum_1_1IService.html" title="{Patronum::IService\n||+ IService()\l+ handleReceve()\l+ supportedFeatures()\l}" alt="" coords="198,5,349,112"/>
</map>
</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:af89797d8f7722a4d74569f87e8024dee"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPatronum_1_1Service.html#af89797d8f7722a4d74569f87e8024dee">Service</a> (int argc, char **argv, const QString &amp;name)</td></tr>
<tr class="memdesc:af89797d8f7722a4d74569f87e8024dee"><td class="mdescLeft">&#160;</td><td class="mdescRight"><a class="el" href="classPatronum_1_1Service.html">Service</a>. <a href="#af89797d8f7722a4d74569f87e8024dee">More...</a><br /></td></tr>
<tr class="separator:af89797d8f7722a4d74569f87e8024dee"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-methods"></a>
Protected Member Functions</h2></td></tr>
<tr class="memitem:a3bf0efb5bb2cea8eeb612660a78f67dd"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPatronum_1_1Service.html#a3bf0efb5bb2cea8eeb612660a78f67dd">handleReceve</a> (const QList&lt; <a class="el" href="classPatronum_1_1Feature.html">Feature</a> &gt; &amp;data)</td></tr>
<tr class="memdesc:a3bf0efb5bb2cea8eeb612660a78f67dd"><td class="mdescLeft">&#160;</td><td class="mdescRight">handleReceve - this method invoce when service receive new command from terminal of controller of this service <a href="#a3bf0efb5bb2cea8eeb612660a78f67dd">More...</a><br /></td></tr>
<tr class="separator:a3bf0efb5bb2cea8eeb612660a78f67dd"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a764bcbb8e6bffd52a5b593e0ec2fdd6f"><td class="memItemLeft" align="right" valign="top">QList&lt; <a class="el" href="classPatronum_1_1Feature.html">Feature</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPatronum_1_1Service.html#a764bcbb8e6bffd52a5b593e0ec2fdd6f">supportedFeatures</a> ()</td></tr>
<tr class="memdesc:a764bcbb8e6bffd52a5b593e0ec2fdd6f"><td class="mdescLeft">&#160;</td><td class="mdescRight">supportedFeatures <a href="#a764bcbb8e6bffd52a5b593e0ec2fdd6f">More...</a><br /></td></tr>
<tr class="separator:a764bcbb8e6bffd52a5b593e0ec2fdd6f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3da4ec3cf54cd0de4c418112dfd78390"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPatronum_1_1Service.html#a3da4ec3cf54cd0de4c418112dfd78390">sendResuylt</a> (const QVariantMap &amp;result)</td></tr>
<tr class="memdesc:a3da4ec3cf54cd0de4c418112dfd78390"><td class="mdescLeft">&#160;</td><td class="mdescRight">sendResuylt - call this method for send responce from service to tour controller <a href="#a3da4ec3cf54cd0de4c418112dfd78390">More...</a><br /></td></tr>
<tr class="separator:a3da4ec3cf54cd0de4c418112dfd78390"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pro_methods_classPatronum_1_1IService"><td colspan="2" onclick="javascript:toggleInherit('pro_methods_classPatronum_1_1IService')"><img src="closed.png" alt="-"/>&#160;Protected Member Functions inherited from <a class="el" href="classPatronum_1_1IService.html">Patronum::IService</a></td></tr>
<tr class="memitem:a7a6f82fbb766ef70bfbe19a2172cc671 inherit pro_methods_classPatronum_1_1IService"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPatronum_1_1IService.html#a7a6f82fbb766ef70bfbe19a2172cc671">IService</a> ()</td></tr>
<tr class="separator:a7a6f82fbb766ef70bfbe19a2172cc671 inherit pro_methods_classPatronum_1_1IService"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><h3>template&lt;class Application&gt;<br />
class Patronum::Service&lt; Application &gt;</h3>
<p><a class="el" href="classPatronum_1_1Service.html">Service</a> - How to use just inherit from the <a class="el" href="classPatronum_1_1Service.html">Service</a> class and override the methods you need. </p>
<p class="definition">Definition at line <a class="el" href="service_8h_source.html#l00019">19</a> of file <a class="el" href="service_8h_source.html">service.h</a>.</p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="af89797d8f7722a4d74569f87e8024dee"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af89797d8f7722a4d74569f87e8024dee">&#9670;&nbsp;</a></span>Service()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class Application &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classPatronum_1_1Service.html">Patronum::Service</a>&lt; Application &gt;::<a class="el" href="classPatronum_1_1Service.html">Service</a> </td>
<td>(</td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>argc</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">char **&#160;</td>
<td class="paramname"><em>argv</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const QString &amp;&#160;</td>
<td class="paramname"><em>name</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p><a class="el" href="classPatronum_1_1Service.html">Service</a>. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">argc</td><td>- count params </td></tr>
<tr><td class="paramname">argv</td><td>- test of arguments </td></tr>
<tr><td class="paramname">name</td><td>- name of your service </td></tr>
</table>
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="service_8h_source.html#l00028">28</a> of file <a class="el" href="service_8h_source.html">service.h</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a3bf0efb5bb2cea8eeb612660a78f67dd"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3bf0efb5bb2cea8eeb612660a78f67dd">&#9670;&nbsp;</a></span>handleReceve()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class Application &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="classPatronum_1_1Service.html">Patronum::Service</a>&lt; Application &gt;::handleReceve </td>
<td>(</td>
<td class="paramtype">const QList&lt; <a class="el" href="classPatronum_1_1Feature.html">Feature</a> &gt; &amp;&#160;</td>
<td class="paramname"><em>data</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">protected</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>handleReceve - this method invoce when service receive new command from terminal of controller of this service </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">data</td><td>- is list of commands from controller </td></tr>
</table>
</dd>
</dl>
<p>Implements <a class="el" href="classPatronum_1_1IService.html#a201b71aaedba3c80dcd5c7f019951bda">Patronum::IService</a>.</p>
<p class="definition">Definition at line <a class="el" href="service_8h_source.html#l00039">39</a> of file <a class="el" href="service_8h_source.html">service.h</a>.</p>
</div>
</div>
<a id="a3da4ec3cf54cd0de4c418112dfd78390"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3da4ec3cf54cd0de4c418112dfd78390">&#9670;&nbsp;</a></span>sendResuylt()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class Application &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool <a class="el" href="classPatronum_1_1Service.html">Patronum::Service</a>&lt; Application &gt;::sendResuylt </td>
<td>(</td>
<td class="paramtype">const QVariantMap &amp;&#160;</td>
<td class="paramname"><em>result</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">protected</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>sendResuylt - call this method for send responce from service to tour controller </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">result</td><td></td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>true if data sendet is seccusseful </dd></dl>
<p class="definition">Definition at line <a class="el" href="service_8h_source.html#l00056">56</a> of file <a class="el" href="service_8h_source.html">service.h</a>.</p>
</div>
</div>
<a id="a764bcbb8e6bffd52a5b593e0ec2fdd6f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a764bcbb8e6bffd52a5b593e0ec2fdd6f">&#9670;&nbsp;</a></span>supportedFeatures()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class Application &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">QList&lt;<a class="el" href="classPatronum_1_1Feature.html">Feature</a>&gt; <a class="el" href="classPatronum_1_1Service.html">Patronum::Service</a>&lt; Application &gt;::supportedFeatures </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">protected</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>supportedFeatures </p>
<dl class="section return"><dt>Returns</dt><dd>list of supported features of this service. override this method for correctly work of your pair (service and controller) </dd></dl>
<p>Implements <a class="el" href="classPatronum_1_1IService.html#a25d2a342b67fa3df540a2284e87b30b5">Patronum::IService</a>.</p>
<p class="definition">Definition at line <a class="el" href="service_8h_source.html#l00047">47</a> of file <a class="el" href="service_8h_source.html">service.h</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>Patronum/src/<a class="el" href="service_8h_source.html">service.h</a></li>
</ul>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="namespacePatronum.html">Patronum</a></li><li class="navelem"><a class="el" href="classPatronum_1_1Service.html">Service</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.13 </li>
</ul>
</div>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink