classreceiver.html

美国COPLEY驱动器,程序开发工具之一.

          <td class="md" valign="top">&nbsp;)&nbsp;</td>
          <td class="md" nowrap><code> [inline]</code></td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Return a reference to the <a class="el" href="classCanOpen.html">CanOpen</a> object associated with this receiver. 
<p>
<dl compact><dt><b>Returns:</b></dt><dd>The <a class="el" href="classCanOpen.html">CanOpen</a> object </dd></dl>

<p>
Definition at line <a class="el" href="CML__CanOpen_8h-source.html#l00236">236</a> of file <a class="el" href="CML__CanOpen_8h-source.html">CML_CanOpen.h</a>.    </td>
  </tr>
</table>
<a class="anchor" name="a6"></a><!-- doxytag: member="Receiver::getRecvID" ref="a6" args="(void)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
  <tr>
    <td class="mdRow">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top"><a class="el" href="CML__Utils_8h.html#a10">uint32</a> getRecvID           </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top">void&nbsp;</td>
          <td class="mdname1" valign="top" nowrap>          </td>
          <td class="md" valign="top">&nbsp;)&nbsp;</td>
          <td class="md" nowrap></td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Return the receive COB ID associated with this CANopen message receiver. 
<p>
<dl compact><dt><b>Returns:</b></dt><dd>The receive COB ID.</dd></dl>

<p>
Definition at line <a class="el" href="CanOpen_8cpp-source.html#l00411">411</a> of file <a class="el" href="CanOpen_8cpp-source.html">CanOpen.cpp</a>.    </td>
  </tr>
</table>
<a class="anchor" name="a3"></a><!-- doxytag: member="Receiver::Init" ref="a3" args="(CanOpen &amp;canOpen, uint32 id)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
  <tr>
    <td class="mdRow">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top">const <a class="el" href="classError.html">Error</a> * Init           </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top"><a class="el" href="classCanOpen.html">CanOpen</a> &amp;&nbsp;</td>
          <td class="mdname" nowrap> <em>canOpen</em>, </td>
        </tr>
        <tr>
          <td class="md" nowrap align="right"></td>
          <td class="md"></td>
          <td class="md" nowrap><a class="el" href="CML__Utils_8h.html#a10">uint32</a>&nbsp;</td>
          <td class="mdname" nowrap> <em>id</em></td>
        </tr>
        <tr>
          <td class="md"></td>
          <td class="md">)&nbsp;</td>
          <td class="md" colspan="2"></td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Initialize the CANopen receiver object. 
<p>
This function should be called before the receiver is used in any way. It can only be called once. <dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>canOpen</em>&nbsp;</td><td>Reference to the CANopen network object that this receiver is associated with. </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>id</em>&nbsp;</td><td>COB ID of the receive message </td></tr>
  </table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>A pointer to an error object, or NULL on success.</dd></dl>

<p>
Reimplemented in <a class="el" href="classTPDO.html#a3">TPDO</a>.
<p>
Definition at line <a class="el" href="CanOpen_8cpp-source.html#l00351">351</a> of file <a class="el" href="CanOpen_8cpp-source.html">CanOpen.cpp</a>.    </td>
  </tr>
</table>
<a class="anchor" name="a10"></a><!-- doxytag: member="Receiver::IsInitialized" ref="a10" args="(void)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
  <tr>
    <td class="mdRow">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top">bool IsInitialized           </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top">void&nbsp;</td>
          <td class="mdname1" valign="top" nowrap>          </td>
          <td class="md" valign="top">&nbsp;)&nbsp;</td>
          <td class="md" nowrap><code> [inline]</code></td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Return true if this receiver has been initialized. 
<p>
<dl compact><dt><b>Returns:</b></dt><dd>True if initialized </dd></dl>

<p>
Definition at line <a class="el" href="CML__CanOpen_8h-source.html#l00242">242</a> of file <a class="el" href="CML__CanOpen_8h-source.html">CML_CanOpen.h</a>.    </td>
  </tr>
</table>
<a class="anchor" name="a5"></a><!-- doxytag: member="Receiver::NewFrame" ref="a5" args="(CanFrame &amp;frame)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
  <tr>
    <td class="mdRow">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top">int NewFrame           </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top"><a class="el" href="structCanFrame.html">CanFrame</a> &amp;&nbsp;</td>
          <td class="mdname1" valign="top" nowrap> <em>frame</em>          </td>
          <td class="md" valign="top">&nbsp;)&nbsp;</td>
          <td class="md" nowrap><code> [virtual]</code></td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Process a new received CAN bus frame. 
<p>
This virtual function is called by the CANopen read thread every time a CAN frame is received over the network with an ID matching the receivers ID if the receiver is enabled.<p>
Note that this function is called from the CANopen receive thread. No other receive frames will be processed until this function returns.<p>
Also note that the map object used to associate message IDs with receive objects is locked when this function is called. The locking is required to prevent a race condition that could occur when a receive object is disabled and it's memory is deallocated. Since the map is locked, it's illegal to Enable() or Disable() any receive object from within this function.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>frame</em>&nbsp;</td><td>The CAN frame to be processed. Note that the memory holding the frame structure may be reused after the call returns. If the frame contents are to be used after the return the a copy of the frame should be made.</td></tr>
  </table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>non-zero if the frame was handled, zero if the frame type was unknown.</dd></dl>

<p>
Reimplemented in <a class="el" href="classLSS.html#b2">LSS</a>, <a class="el" href="classNode.html#a39">Node</a>, <a class="el" href="classTPDO.html#a9">TPDO</a>, and <a class="el" href="classSDO.html#a26">SDO</a>.
<p>
Definition at line <a class="el" href="CanOpen_8cpp-source.html#l00400">400</a> of file <a class="el" href="CanOpen_8cpp-source.html">CanOpen.cpp</a>.    </td>
  </tr>
</table>
<a class="anchor" name="a4"></a><!-- doxytag: member="Receiver::UnInit" ref="a4" args="(void)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
  <tr>
    <td class="mdRow">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top">const <a class="el" href="classError.html">Error</a> * UnInit           </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top">void&nbsp;</td>
          <td class="mdname1" valign="top" nowrap>          </td>
          <td class="md" valign="top">&nbsp;)&nbsp;</td>
          <td class="md" nowrap></td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Un-initialize a CANopen receiver. 
<p>
This returns the receiver object to it's uninitialized state. <dl compact><dt><b>Returns:</b></dt><dd>A pointer to an error object, or NULL on success.</dd></dl>

<p>
Reimplemented in <a class="el" href="classNode.html#a7">Node</a>.
<p>
Definition at line <a class="el" href="CanOpen_8cpp-source.html#l00370">370</a> of file <a class="el" href="CanOpen_8cpp-source.html">CanOpen.cpp</a>.    </td>
  </tr>
</table>
<hr>The documentation for this class was generated from the following files:<ul>
<li><a class="el" href="CML__CanOpen_8h-source.html">CML_CanOpen.h</a><li><a class="el" href="CanOpen_8cpp-source.html">CanOpen.cpp</a></ul>
<hr>
<address style="align: right;">
<small>Copley Motion Library, Copyright (c) 2002-2003
<a href="http://www.copleycontrols.com">
<img src="CCC_logo.gif" alt="Copley Controls Corp." align="middle" border=0 ></a>
</small>
</address>
</body>
</html>