SHS/pip
4
3
Fork 0
Code Issues 67 Pull Requests 1 Actions Releases Wiki Activity

git-svn-id: svn://db.shs.com.ru/pip@579 12ceb7fc-bf1f-11e4-8940-5bc7170c53b5

Browse Source
This commit is contained in:
Пелипенко Иван
2017-12-08 14:29:50 +00:00
parent 603e19ae18
commit 99f3a53eac
593 changed files with 5078 additions and 3276 deletions
Download Patch File Download Diff File Expand all files Collapse all files

52
doc/html/class_p_i_connection.html
View File

@@ -26,7 +26,7 @@
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">PIP
&#160;<span id="projectnumber">1.0.0_rc3</span>
&#160;<span id="projectnumber">1.4.0</span>
</div>
<div id="projectbrief">Platform-Independent Primitives</div>
</td>
@@ -217,16 +217,16 @@ void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="clas
<a class="el" href="class_p_i_vector.html">PIVector</a>&lt; PIPair&lt; <a class="el" href="class_p_i_string.html">PIString</a>, <a class="el" href="class_p_i_string.html">PIString</a> &gt; &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_p_i_connection.html#a4f3e5f5663a9c421f62929181a620c77">channels</a> () const</td></tr>
<tr class="memdesc:a4f3e5f5663a9c421f62929181a620c77"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns all channels of this connection as full pathes or filter names pair array (from, to) <br /></td></tr>
<tr class="separator:a4f3e5f5663a9c421f62929181a620c77"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a51c44629c4a2eb7194bfabf16e8c1f5a"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_p_i_connection.html#a51c44629c4a2eb7194bfabf16e8c1f5a">addSender</a> (const <a class="el" href="class_p_i_string.html">PIString</a> &amp;<a class="el" href="class_p_i_object.html#a5c3600479f3e919bbd4f905b7fedc275">name</a>, const <a class="el" href="class_p_i_string.html">PIString</a> &amp;full_path, float frequency, bool <a class="el" href="class_p_i_connection.html#a296ce68f2f85085bf4ecfb71580587c4">start</a>=false)</td></tr>
<tr class="memdesc:a51c44629c4a2eb7194bfabf16e8c1f5a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Add to connection sender with name "name" device with full path "full_path". <a href="#a51c44629c4a2eb7194bfabf16e8c1f5a">More...</a><br /></td></tr>
<tr class="separator:a51c44629c4a2eb7194bfabf16e8c1f5a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae5e071ebb9948197f2103a579bf72c17"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_p_i_connection.html#ae5e071ebb9948197f2103a579bf72c17">addSender</a> (const <a class="el" href="class_p_i_string.html">PIString</a> &amp;<a class="el" href="class_p_i_object.html#a5c3600479f3e919bbd4f905b7fedc275">name</a>, const <a class="el" href="class_p_i_string.html">PIString</a> &amp;full_path_name, float frequency, bool <a class="el" href="class_p_i_connection.html#a296ce68f2f85085bf4ecfb71580587c4">start</a>=false)</td></tr>
<tr class="memdesc:ae5e071ebb9948197f2103a579bf72c17"><td class="mdescLeft">&#160;</td><td class="mdescRight">Add to connection sender with name "name" device with full path "full_path". <a href="#ae5e071ebb9948197f2103a579bf72c17">More...</a><br /></td></tr>
<tr class="separator:ae5e071ebb9948197f2103a579bf72c17"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:adbfdd3671eb66e4967312b411a757697"><td class="memItemLeft" align="right" valign="top"><a id="adbfdd3671eb66e4967312b411a757697"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_p_i_connection.html#adbfdd3671eb66e4967312b411a757697">addSender</a> (const <a class="el" href="class_p_i_string.html">PIString</a> &amp;<a class="el" href="class_p_i_object.html#a5c3600479f3e919bbd4f905b7fedc275">name</a>, const <a class="el" href="class_p_i_i_o_device.html">PIIODevice</a> *dev, float frequency, bool <a class="el" href="class_p_i_connection.html#a296ce68f2f85085bf4ecfb71580587c4">start</a>=false)</td></tr>
<tr class="memdesc:adbfdd3671eb66e4967312b411a757697"><td class="mdescLeft">&#160;</td><td class="mdescRight">Add to connection sender with name "name" device "dev". <br /></td></tr>
<tr class="separator:adbfdd3671eb66e4967312b411a757697"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0f502ebce46f41bf58975652bac7346c"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_p_i_connection.html#a0f502ebce46f41bf58975652bac7346c">removeSender</a> (const <a class="el" href="class_p_i_string.html">PIString</a> &amp;<a class="el" href="class_p_i_object.html#a5c3600479f3e919bbd4f905b7fedc275">name</a>, const <a class="el" href="class_p_i_string.html">PIString</a> &amp;full_path)</td></tr>
<tr class="memdesc:a0f502ebce46f41bf58975652bac7346c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Remove from sender with name "name" device with full path "full_path_name". <a href="#a0f502ebce46f41bf58975652bac7346c">More...</a><br /></td></tr>
<tr class="separator:a0f502ebce46f41bf58975652bac7346c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae9fb7eeb79f40c55060071ee82452963"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_p_i_connection.html#ae9fb7eeb79f40c55060071ee82452963">removeSender</a> (const <a class="el" href="class_p_i_string.html">PIString</a> &amp;<a class="el" href="class_p_i_object.html#a5c3600479f3e919bbd4f905b7fedc275">name</a>, const <a class="el" href="class_p_i_string.html">PIString</a> &amp;full_path_name)</td></tr>
<tr class="memdesc:ae9fb7eeb79f40c55060071ee82452963"><td class="mdescLeft">&#160;</td><td class="mdescRight">Remove from sender with name "name" device with full path "full_path_name". <a href="#ae9fb7eeb79f40c55060071ee82452963">More...</a><br /></td></tr>
<tr class="separator:ae9fb7eeb79f40c55060071ee82452963"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6e94e0174cecb9a57571be67ead71381"><td class="memItemLeft" align="right" valign="top"><a id="a6e94e0174cecb9a57571be67ead71381"></a>
bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_p_i_connection.html#a6e94e0174cecb9a57571be67ead71381">removeSender</a> (const <a class="el" href="class_p_i_string.html">PIString</a> &amp;<a class="el" href="class_p_i_object.html#a5c3600479f3e919bbd4f905b7fedc275">name</a>, const <a class="el" href="class_p_i_i_o_device.html">PIIODevice</a> *dev)</td></tr>
<tr class="memdesc:a6e94e0174cecb9a57571be67ead71381"><td class="mdescLeft">&#160;</td><td class="mdescRight">Remove from sender with name "name" device "dev". <br /></td></tr>
@@ -255,10 +255,10 @@ float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="cla
void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_p_i_connection.html#a0c7c309e54c2c09a779c25843dd13efd">removeAllSenders</a> ()</td></tr>
<tr class="memdesc:a0c7c309e54c2c09a779c25843dd13efd"><td class="mdescLeft">&#160;</td><td class="mdescRight">Remove from connection all senders. <br /></td></tr>
<tr class="separator:a0c7c309e54c2c09a779c25843dd13efd"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0172eca55562a296daa6e971d879443d"><td class="memItemLeft" align="right" valign="top"><a id="a0172eca55562a296daa6e971d879443d"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_p_i_connection.html#a0172eca55562a296daa6e971d879443d">startThreadedRead</a> (const <a class="el" href="class_p_i_string.html">PIString</a> &amp;full_path)</td></tr>
<tr class="memdesc:a0172eca55562a296daa6e971d879443d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Start read thread of device with full path "full_path". <br /></td></tr>
<tr class="separator:a0172eca55562a296daa6e971d879443d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa509a786b22ea52e3ada9dbcd74e9502"><td class="memItemLeft" align="right" valign="top"><a id="aa509a786b22ea52e3ada9dbcd74e9502"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_p_i_connection.html#aa509a786b22ea52e3ada9dbcd74e9502">startThreadedRead</a> (const <a class="el" href="class_p_i_string.html">PIString</a> &amp;full_path_name)</td></tr>
<tr class="memdesc:aa509a786b22ea52e3ada9dbcd74e9502"><td class="mdescLeft">&#160;</td><td class="mdescRight">Start read thread of device with full path "full_path". <br /></td></tr>
<tr class="separator:aa509a786b22ea52e3ada9dbcd74e9502"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:acb0bfcc3c1e36d1d9881e31a331e2d59"><td class="memItemLeft" align="right" valign="top"><a id="acb0bfcc3c1e36d1d9881e31a331e2d59"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_p_i_connection.html#acb0bfcc3c1e36d1d9881e31a331e2d59">startThreadedRead</a> (const <a class="el" href="class_p_i_i_o_device.html">PIIODevice</a> *dev)</td></tr>
<tr class="memdesc:acb0bfcc3c1e36d1d9881e31a331e2d59"><td class="mdescLeft">&#160;</td><td class="mdescRight">Start read thread of device "dev". <br /></td></tr>
@@ -279,10 +279,10 @@ void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="clas
void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_p_i_connection.html#a296ce68f2f85085bf4ecfb71580587c4">start</a> ()</td></tr>
<tr class="memdesc:a296ce68f2f85085bf4ecfb71580587c4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Start all read threads and senders. <br /></td></tr>
<tr class="separator:a296ce68f2f85085bf4ecfb71580587c4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a57f58250839c50d221d32f8d1fb62737"><td class="memItemLeft" align="right" valign="top"><a id="a57f58250839c50d221d32f8d1fb62737"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_p_i_connection.html#a57f58250839c50d221d32f8d1fb62737">stopThreadedRead</a> (const <a class="el" href="class_p_i_string.html">PIString</a> &amp;full_path)</td></tr>
<tr class="memdesc:a57f58250839c50d221d32f8d1fb62737"><td class="mdescLeft">&#160;</td><td class="mdescRight">Stop read thread of device with full path "full_path". <br /></td></tr>
<tr class="separator:a57f58250839c50d221d32f8d1fb62737"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a78184d20927ca25802e1a2cd07aadb9c"><td class="memItemLeft" align="right" valign="top"><a id="a78184d20927ca25802e1a2cd07aadb9c"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_p_i_connection.html#a78184d20927ca25802e1a2cd07aadb9c">stopThreadedRead</a> (const <a class="el" href="class_p_i_string.html">PIString</a> &amp;full_path_name)</td></tr>
<tr class="memdesc:a78184d20927ca25802e1a2cd07aadb9c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Stop read thread of device with full path "full_path". <br /></td></tr>
<tr class="separator:a78184d20927ca25802e1a2cd07aadb9c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5ca12246273a1871fe6c53d535f7ab7f"><td class="memItemLeft" align="right" valign="top"><a id="a5ca12246273a1871fe6c53d535f7ab7f"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_p_i_connection.html#a5ca12246273a1871fe6c53d535f7ab7f">stopThreadedRead</a> (const <a class="el" href="class_p_i_i_o_device.html">PIIODevice</a> *dev)</td></tr>
<tr class="memdesc:a5ca12246273a1871fe6c53d535f7ab7f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Stop read thread of device "dev". <br /></td></tr>
@@ -648,7 +648,7 @@ Synopsis</h1>
</div>
<h1><a class="anchor" id="PIConnection_pool"></a>
Device pool concept</h1>
<p>Device pool is static object, single for each application, which contains unique devices. Each PIConnection works with real devices through Device pool. Each device has assosiated thread for read and it can be started or stopped with PIConnection functions <em><a class="el" href="class_p_i_connection.html#a0172eca55562a296daa6e971d879443d" title="Start read thread of device with full path &quot;full_path&quot;. ">startThreadedRead()</a></em> and <em><a class="el" href="class_p_i_connection.html#a57f58250839c50d221d32f8d1fb62737" title="Stop read thread of device with full path &quot;full_path&quot;. ">stopThreadedRead()</a></em>.</p>
<p>Device pool is static object, single for each application, which contains unique devices. Each PIConnection works with real devices through Device pool. Each device has assosiated thread for read and it can be started or stopped with PIConnection functions <em><a class="el" href="class_p_i_connection.html#aa509a786b22ea52e3ada9dbcd74e9502" title="Start read thread of device with full path &quot;full_path&quot;. ">startThreadedRead()</a></em> and <em><a class="el" href="class_p_i_connection.html#a78184d20927ca25802e1a2cd07aadb9c" title="Stop read thread of device with full path &quot;full_path&quot;. ">stopThreadedRead()</a></em>.</p>
<h1><a class="anchor" id="PIConnection_filters"></a>
Filters</h1>
<p>PIConnection filter is a <a class="el" href="class_p_i_packet_extractor.html" title="Packets extractor. ">PIPacketExtractor</a> and assosiated array of devices or other filters. When read thread is successfully read from device this data can be passed to one or more filters. Each filter has name and filter names should be unique. You can use this name for access to PIPacketExtractor* with function <em><a class="el" href="class_p_i_connection.html#aa9ecb3a50d00862739c9b23d75dc1656" title="Returns PIPacketExtractor * assosiated with filter &quot;name&quot; or null if there is no such filter...">filter()</a></em>, or get array of assosiated devices and filters with function <em><a class="el" href="class_p_i_connection.html#abe798d9a67f93f3b5fd964ff2818ddb4" title="Returns all devices bounded to filter &quot;name&quot;. ">filterBoundedDevices()</a></em>. One filter can receive data from several sources, and can be bounded to several filters. </p><div class="image">
@@ -659,7 +659,7 @@ Diagnostics</h1>
<p>PIConnection create <a class="el" href="class_p_i_diagnostics.html" title="Connection quality diagnostics. ">PIDiagnostics</a> for each device or filter. You can access to these objects with functions <em><a class="el" href="class_p_i_connection.html#a4fca7072d3d1ef4dac394afded0ac148" title="Returns PIDiagnostics * assosiated with device with full path &quot;full_path_name&quot;, name &quot;full_path_name&quot;...">diagnostic()</a></em>.</p>
<h1><a class="anchor" id="PIConnection_sender"></a>
Senders</h1>
<p>PIConnection can send data to devices with named timers ("senders"). You can create sender or add device to sender with function <em><a class="el" href="class_p_i_connection.html#a51c44629c4a2eb7194bfabf16e8c1f5a" title="Add to connection sender with name &quot;name&quot; device with full path &quot;full_path&quot;. ">addSender()</a></em>. Each sender has internal timer and every tick execute virtual function <em><a class="el" href="class_p_i_connection.html#a023551841a2209d5ada16c376feb91f9" title="You should returns data for sender &quot;sender_name&quot;. ">senderData()</a></em>. Returns value of this function sended to bounded devices. You can assign fixed send data to sender with function <em><a class="el" href="class_p_i_connection.html#aa547b4a4e64e9adf0c7c45171160bded" title="Set sender &quot;name&quot; fixed send data &quot;data&quot;, returns if sender exists. ">setSenderFixedData()</a></em>. In this case sender will NOT execute <em><a class="el" href="class_p_i_connection.html#a023551841a2209d5ada16c376feb91f9" title="You should returns data for sender &quot;sender_name&quot;. ">senderData()</a></em>, but send assigned data. </p><div class="image">
<p>PIConnection can send data to devices with named timers ("senders"). You can create sender or add device to sender with function <em><a class="el" href="class_p_i_connection.html#ae5e071ebb9948197f2103a579bf72c17" title="Add to connection sender with name &quot;name&quot; device with full path &quot;full_path&quot;. ">addSender()</a></em>. Each sender has internal timer and every tick execute virtual function <em><a class="el" href="class_p_i_connection.html#a023551841a2209d5ada16c376feb91f9" title="You should returns data for sender &quot;sender_name&quot;. ">senderData()</a></em>. Returns value of this function sended to bounded devices. You can assign fixed send data to sender with function <em><a class="el" href="class_p_i_connection.html#aa547b4a4e64e9adf0c7c45171160bded" title="Set sender &quot;name&quot; fixed send data &quot;data&quot;, returns if sender exists. ">setSenderFixedData()</a></em>. In this case sender will NOT execute <em><a class="el" href="class_p_i_connection.html#a023551841a2209d5ada16c376feb91f9" title="You should returns data for sender &quot;sender_name&quot;. ">senderData()</a></em>, but send assigned data. </p><div class="image">
<img src="piconnection_senders.png" alt="piconnection_senders.png"/>
</div>
<h1><a class="anchor" id="PIConnection_config"></a>
@@ -764,7 +764,7 @@ Configuration</h1>
</div><div class="memdoc">
<p>Add device with full path "full_path", open mode "mode" to Device pool and connection. </p>
<p>Returns pointer to device or null if device can not be created. If "start" is true, read thread is started immediately. Else, you can start read thread with functions <em><a class="el" href="class_p_i_connection.html#a0172eca55562a296daa6e971d879443d" title="Start read thread of device with full path &quot;full_path&quot;. ">startThreadedRead()</a></em> or <em><a class="el" href="class_p_i_connection.html#aa0319a04d2b0a72809347b556fbde478" title="Start read threads of all Device pool device. ">startAllThreadedReads()</a></em>. By default, read thread doesn`t start </p>
<p>Returns pointer to device or null if device can not be created. If "start" is true, read thread is started immediately. Else, you can start read thread with functions <em><a class="el" href="class_p_i_connection.html#aa509a786b22ea52e3ada9dbcd74e9502" title="Start read thread of device with full path &quot;full_path&quot;. ">startThreadedRead()</a></em> or <em><a class="el" href="class_p_i_connection.html#aa0319a04d2b0a72809347b556fbde478" title="Start read threads of all Device pool device. ">startAllThreadedReads()</a></em>. By default, read thread doesn`t start </p>
</div>
</div>
@@ -905,7 +905,7 @@ Configuration</h1>
</div><div class="memdoc">
<p>Add to connection channel from "name_from" to "name_to". </p>
<p>"name_from" and "name_to" can be full pathes of devices or filter names. Returns <b>false</b> if there if no such device or filter, else create channel and returns <b>true</b> </p>
<p>"name_from" and "name_to" can be full pathes of devices or device names or filter names. Returns <b>false</b> if there if no such device or filter, else create channel and returns <b>true</b> </p>
</div>
</div>
@@ -961,8 +961,8 @@ Configuration</h1>
</div>
</div>
<a id="a51c44629c4a2eb7194bfabf16e8c1f5a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a51c44629c4a2eb7194bfabf16e8c1f5a">&#9670;&nbsp;</a></span>addSender()</h2>
<a id="ae5e071ebb9948197f2103a579bf72c17"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae5e071ebb9948197f2103a579bf72c17">&#9670;&nbsp;</a></span>addSender()</h2>
<div class="memitem">
<div class="memproto">
@@ -977,7 +977,7 @@ Configuration</h1>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="class_p_i_string.html">PIString</a> &amp;&#160;</td>
<td class="paramname"><em>full_path</em>, </td>
<td class="paramname"><em>full_path_name</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
@@ -1005,8 +1005,8 @@ Configuration</h1>
</div>
</div>
<a id="a0f502ebce46f41bf58975652bac7346c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0f502ebce46f41bf58975652bac7346c">&#9670;&nbsp;</a></span>removeSender()</h2>
<a id="ae9fb7eeb79f40c55060071ee82452963"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae9fb7eeb79f40c55060071ee82452963">&#9670;&nbsp;</a></span>removeSender()</h2>
<div class="memitem">
<div class="memproto">
@@ -1021,7 +1021,7 @@ Configuration</h1>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="class_p_i_string.html">PIString</a> &amp;&#160;</td>
<td class="paramname"><em>full_path</em>&#160;</td>
<td class="paramname"><em>full_path_name</em>&#160;</td>
</tr>
<tr>
<td></td>
@@ -1042,7 +1042,7 @@ Configuration</h1>
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="class_p_i_connection.html">PIConnection</a></li>
<li class="footer">Generated on Tue May 23 2017 11:20:44 for PIP by
<li class="footer">Generated on Fri Dec 8 2017 16:36:05 for PIP by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.13 </li>
</ul>