Sophie

Sophie

distrib > Fedora > 15 > i386 > by-pkgid > c72d609d39bfe5656f218382a504969f > files > 319

libkni3-doc-3.9.2-13.fc15.i686.rpm

<!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"/>
<title>KatanaNativeInterface: KNI::kmlFactory Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript">
$(document).ready(initResizable);
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.7.3 -->
<div id="top">
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td style="padding-left: 0.5em;">
   <div id="projectname">KatanaNativeInterface&#160;<span id="projectnumber">$VERSION$</span></div>
  </td>
 </tr>
 </tbody>
</table>
</div>
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
      <li><a href="modules.html"><span>Modules</span></a></li>
      <li><a href="namespaces.html"><span>Namespaces</span></a></li>
      <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
      <li><a href="files.html"><span>Files</span></a></li>
      <li><a href="dirs.html"><span>Directories</span></a></li>
    </ul>
  </div>
  <div id="navrow2" class="tabs2">
    <ul class="tablist">
      <li><a href="annotated.html"><span>Class&#160;List</span></a></li>
      <li><a href="classes.html"><span>Class&#160;Index</span></a></li>
      <li><a href="inherits.html"><span>Class&#160;Hierarchy</span></a></li>
      <li><a href="functions.html"><span>Class&#160;Members</span></a></li>
    </ul>
  </div>
</div>
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
  initNavTree('classKNI_1_1kmlFactory.html','');
</script>
<div id="doc-content">
<div class="header">
  <div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pri-methods">Private Member Functions</a> &#124;
<a href="#pri-attribs">Private Attributes</a>  </div>
  <div class="headertitle">
<h1>KNI::kmlFactory Class Reference</h1>  </div>
</div>
<div class="contents">
<!-- doxytag: class="KNI::kmlFactory" -->
<p>This class is for internal use only It may change at any time It shields the configuration file parsing.  
<a href="#_details">More...</a></p>

<p><code>#include &lt;<a class="el" href="kmlFactories_8h_source.html">kmlFactories.h</a>&gt;</code></p>
<div class="dynheader">
Collaboration diagram for KNI::kmlFactory:</div>
<div class="dyncontent">
<div class="center"><img src="classKNI_1_1kmlFactory__coll__graph.png" border="0" usemap="#KNI_1_1kmlFactory_coll__map" alt="Collaboration graph"/></div>
<map name="KNI_1_1kmlFactory_coll__map" id="KNI_1_1kmlFactory_coll__map">
<area shape="rect" id="node2" title="STL class." alt="" coords="49,549,143,635"/><area shape="rect" id="node4" title="STL class." alt="" coords="5,413,187,499"/><area shape="rect" id="node6" title="STL class." alt="" coords="5,277,187,363"/><area shape="rect" id="node8" title="STL class." alt="" coords="19,141,173,227"/><area shape="rect" id="node10" title="STL class." alt="" coords="47,5,145,91"/></map>
<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>

<p><a href="classKNI_1_1kmlFactory-members.html">List of all members.</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classKNI_1_1kmlFactory.html#aea522b76d2ccefae4d5df52a0a7c15c6">kmlFactory</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classKNI_1_1kmlFactory.html#aa1de274f0ea50ea0d7429ad616ff024c">openFile</a> (const char *filepath)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="structTKatGNL.html">TKatGNL</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classKNI_1_1kmlFactory.html#a7b7028a4ca954bee477b5ba4012483c4">getGNL</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="structTKatMOT.html">TKatMOT</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classKNI_1_1kmlFactory.html#a0b4502b9cf398ed00dee86eef8a6e7a1">getMOT</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="structTKatSCT.html">TKatSCT</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classKNI_1_1kmlFactory.html#aefd1c7cfd90776b2b6b70143d82d414a">getSCT</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="structTKatEFF.html">TKatEFF</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classKNI_1_1kmlFactory.html#aa1c0cb222a7776f6365c922de62932b2">getEFF</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="structTMotDesc.html">TMotDesc</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classKNI_1_1kmlFactory.html#a285754d64fd1d8df370b1bd538f38596">getMotDesc</a> (short count)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="structTSctDesc.html">TSctDesc</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classKNI_1_1kmlFactory.html#a41aa6a1828a808138f027ec7f883ef5e">getSctDesc</a> (short count)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="structTMotCLB.html">TMotCLB</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classKNI_1_1kmlFactory.html#a412bc20d60cc3628b79fb5d9f569ceb3">getMotCLB</a> (short number)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="structTMotSCP.html">TMotSCP</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classKNI_1_1kmlFactory.html#add082fc6cd68237efdf03dfcdd1b07b1">getMotSCP</a> (short number)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="structTMotDYL.html">TMotDYL</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classKNI_1_1kmlFactory.html#aed7e4bc53aef3cc858b4e66bb6455e13">getMotDYL</a> (short number)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classKNI_1_1kmlFactory.html#afc0bd7c7b20eb9d9a9c1613a36d4076b">getType</a> ()</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">returns the Katana type  <a href="#afc0bd7c7b20eb9d9a9c1613a36d4076b"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="structTMotInit.html">TMotInit</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classKNI_1_1kmlFactory.html#ac3391e5bb2dbb96d2326a744233dacfa">getMotInit</a> (short number)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classKNI_1_1kmlFactory.html#a927687898585f907d1c2838d06d300b3">getGripperParameters</a> (bool &amp;isPresent, int &amp;openEncoders, int &amp;closeEncoders)</td></tr>
<tr><td colspan="2"><h2><a name="pri-methods"></a>
Private Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classKNI_1_1kmlFactory.html#a35d34d837bc1d2d7ffaca9ff9ad0655b">_readEntry</a> (char *dest, int destsz, const char *section, const char *subsection, const char *entry)</td></tr>
<tr><td colspan="2"><h2><a name="pri-attribs"></a>
Private Attributes</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">std::ifstream&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classKNI_1_1kmlFactory.html#a5124c47a5835b13adce7917110ce8a54">_configfile</a></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>This class is for internal use only It may change at any time It shields the configuration file parsing. </p>

<p>Definition at line <a class="el" href="kmlFactories_8h_source.html#l00075">75</a> of file <a class="el" href="kmlFactories_8h_source.html">kmlFactories.h</a>.</p>
</div><hr/><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="aea522b76d2ccefae4d5df52a0a7c15c6"></a><!-- doxytag: member="KNI::kmlFactory::kmlFactory" ref="aea522b76d2ccefae4d5df52a0a7c15c6" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">KNI::kmlFactory::kmlFactory </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a35d34d837bc1d2d7ffaca9ff9ad0655b"></a><!-- doxytag: member="KNI::kmlFactory::_readEntry" ref="a35d34d837bc1d2d7ffaca9ff9ad0655b" args="(char *dest, int destsz, const char *section, const char *subsection, const char *entry)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void KNI::kmlFactory::_readEntry </td>
          <td>(</td>
          <td class="paramtype">char *&#160;</td>
          <td class="paramname"><em>dest</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">int&#160;</td>
          <td class="paramname"><em>destsz</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const char *&#160;</td>
          <td class="paramname"><em>section</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const char *&#160;</td>
          <td class="paramname"><em>subsection</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const char *&#160;</td>
          <td class="paramname"><em>entry</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td><code> [private]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

</div>
</div>
<a class="anchor" id="aa1c0cb222a7776f6365c922de62932b2"></a><!-- doxytag: member="KNI::kmlFactory::getEFF" ref="aa1c0cb222a7776f6365c922de62932b2" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="structTKatEFF.html">TKatEFF</a> KNI::kmlFactory::getEFF </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

</div>
</div>
<a class="anchor" id="a7b7028a4ca954bee477b5ba4012483c4"></a><!-- doxytag: member="KNI::kmlFactory::getGNL" ref="a7b7028a4ca954bee477b5ba4012483c4" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="structTKatGNL.html">TKatGNL</a> KNI::kmlFactory::getGNL </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

</div>
</div>
<a class="anchor" id="a927687898585f907d1c2838d06d300b3"></a><!-- doxytag: member="KNI::kmlFactory::getGripperParameters" ref="a927687898585f907d1c2838d06d300b3" args="(bool &amp;isPresent, int &amp;openEncoders, int &amp;closeEncoders)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void KNI::kmlFactory::getGripperParameters </td>
          <td>(</td>
          <td class="paramtype">bool &amp;&#160;</td>
          <td class="paramname"><em>isPresent</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">int &amp;&#160;</td>
          <td class="paramname"><em>openEncoders</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">int &amp;&#160;</td>
          <td class="paramname"><em>closeEncoders</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

</div>
</div>
<a class="anchor" id="a0b4502b9cf398ed00dee86eef8a6e7a1"></a><!-- doxytag: member="KNI::kmlFactory::getMOT" ref="a0b4502b9cf398ed00dee86eef8a6e7a1" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="structTKatMOT.html">TKatMOT</a> KNI::kmlFactory::getMOT </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

</div>
</div>
<a class="anchor" id="a412bc20d60cc3628b79fb5d9f569ceb3"></a><!-- doxytag: member="KNI::kmlFactory::getMotCLB" ref="a412bc20d60cc3628b79fb5d9f569ceb3" args="(short number)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="structTMotCLB.html">TMotCLB</a> KNI::kmlFactory::getMotCLB </td>
          <td>(</td>
          <td class="paramtype">short&#160;</td>
          <td class="paramname"><em>number</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

</div>
</div>
<a class="anchor" id="a285754d64fd1d8df370b1bd538f38596"></a><!-- doxytag: member="KNI::kmlFactory::getMotDesc" ref="a285754d64fd1d8df370b1bd538f38596" args="(short count)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="structTMotDesc.html">TMotDesc</a>* KNI::kmlFactory::getMotDesc </td>
          <td>(</td>
          <td class="paramtype">short&#160;</td>
          <td class="paramname"><em>count</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

</div>
</div>
<a class="anchor" id="aed7e4bc53aef3cc858b4e66bb6455e13"></a><!-- doxytag: member="KNI::kmlFactory::getMotDYL" ref="aed7e4bc53aef3cc858b4e66bb6455e13" args="(short number)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="structTMotDYL.html">TMotDYL</a> KNI::kmlFactory::getMotDYL </td>
          <td>(</td>
          <td class="paramtype">short&#160;</td>
          <td class="paramname"><em>number</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

</div>
</div>
<a class="anchor" id="ac3391e5bb2dbb96d2326a744233dacfa"></a><!-- doxytag: member="KNI::kmlFactory::getMotInit" ref="ac3391e5bb2dbb96d2326a744233dacfa" args="(short number)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="structTMotInit.html">TMotInit</a> KNI::kmlFactory::getMotInit </td>
          <td>(</td>
          <td class="paramtype">short&#160;</td>
          <td class="paramname"><em>number</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

</div>
</div>
<a class="anchor" id="add082fc6cd68237efdf03dfcdd1b07b1"></a><!-- doxytag: member="KNI::kmlFactory::getMotSCP" ref="add082fc6cd68237efdf03dfcdd1b07b1" args="(short number)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="structTMotSCP.html">TMotSCP</a> KNI::kmlFactory::getMotSCP </td>
          <td>(</td>
          <td class="paramtype">short&#160;</td>
          <td class="paramname"><em>number</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

</div>
</div>
<a class="anchor" id="aefd1c7cfd90776b2b6b70143d82d414a"></a><!-- doxytag: member="KNI::kmlFactory::getSCT" ref="aefd1c7cfd90776b2b6b70143d82d414a" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="structTKatSCT.html">TKatSCT</a> KNI::kmlFactory::getSCT </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

</div>
</div>
<a class="anchor" id="a41aa6a1828a808138f027ec7f883ef5e"></a><!-- doxytag: member="KNI::kmlFactory::getSctDesc" ref="a41aa6a1828a808138f027ec7f883ef5e" args="(short count)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="structTSctDesc.html">TSctDesc</a>* KNI::kmlFactory::getSctDesc </td>
          <td>(</td>
          <td class="paramtype">short&#160;</td>
          <td class="paramname"><em>count</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

</div>
</div>
<a class="anchor" id="afc0bd7c7b20eb9d9a9c1613a36d4076b"></a><!-- doxytag: member="KNI::kmlFactory::getType" ref="afc0bd7c7b20eb9d9a9c1613a36d4076b" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int KNI::kmlFactory::getType </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>returns the Katana type </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>300 for Katana300, 400 for Katana400 </dd></dl>

</div>
</div>
<a class="anchor" id="aa1de274f0ea50ea0d7429ad616ff024c"></a><!-- doxytag: member="KNI::kmlFactory::openFile" ref="aa1de274f0ea50ea0d7429ad616ff024c" args="(const char *filepath)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bool KNI::kmlFactory::openFile </td>
          <td>(</td>
          <td class="paramtype">const char *&#160;</td>
          <td class="paramname"><em>filepath</em></td><td>)</td>
          <td><code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Definition at line <a class="el" href="kmlFactories_8h_source.html#l00083">83</a> of file <a class="el" href="kmlFactories_8h_source.html">kmlFactories.h</a>.</p>

</div>
</div>
<hr/><h2>Member Data Documentation</h2>
<a class="anchor" id="a5124c47a5835b13adce7917110ce8a54"></a><!-- doxytag: member="KNI::kmlFactory::_configfile" ref="a5124c47a5835b13adce7917110ce8a54" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">std::ifstream <a class="el" href="classKNI_1_1kmlFactory.html#a5124c47a5835b13adce7917110ce8a54">KNI::kmlFactory::_configfile</a><code> [private]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Definition at line <a class="el" href="kmlFactories_8h_source.html#l00077">77</a> of file <a class="el" href="kmlFactories_8h_source.html">kmlFactories.h</a>.</p>

</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>include/KNI/<a class="el" href="kmlFactories_8h_source.html">kmlFactories.h</a></li>
</ul>
</div>
</div>
  <div id="nav-path" class="navpath">
    <ul>
      <li class="navelem"><a class="el" href="namespaceKNI.html">KNI</a>      </li>
      <li class="navelem"><a class="el" href="classKNI_1_1kmlFactory.html">kmlFactory</a>      </li>
      <li class="footer">Generated on Tue Feb 8 2011 for KatanaNativeInterface by&#160;
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.3 </li>
    </ul>
  </div>

</body>
</html>