classevent.html

来自「美国COPLEY驱动器,程序开发工具之一.」· HTML 代码 · 共 424 行 · 第 1/2 页

        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Return the value that this event will wait on. 
<p>
<dl compact><dt><b>Returns:</b></dt><dd>The event value</dd></dl>

<p>
Definition at line <a class="el" href="CML__EventMap_8h-source.html#l00109">109</a> of file <a class="el" href="CML__EventMap_8h-source.html">CML_EventMap.h</a>.    </td>
  </tr>
</table>
<a class="anchor" name="a8"></a><!-- doxytag: member="Event::isTrue" ref="a8" args="(uint32 mask)" --><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">virtual bool isTrue           </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top"><a class="el" href="CML__Utils_8h.html#a10">uint32</a>&nbsp;</td>
          <td class="mdname1" valign="top" nowrap> <em>mask</em>          </td>
          <td class="md" valign="top">&nbsp;)&nbsp;</td>
          <td class="md" nowrap><code> [inline, virtual]</code></td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Test the event to see if it's condition is true. 
<p>
This method should be implemented in the sub-class to define the type of event matching used. The base class always returns false.<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>mask</em>&nbsp;</td><td>The <a class="el" href="classEventMap.html">EventMap</a> mask compare to. </td></tr>
  </table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>true if the event is satisfied, false if not.</dd></dl>

<p>
Reimplemented in <a class="el" href="classEventAny.html#a1">EventAny</a>, <a class="el" href="classEventAnyClear.html#a1">EventAnyClear</a>, <a class="el" href="classEventAll.html#a1">EventAll</a>, and <a class="el" href="classEventNone.html#a1">EventNone</a>.
<p>
Definition at line <a class="el" href="CML__EventMap_8h-source.html#l00132">132</a> of file <a class="el" href="CML__EventMap_8h-source.html">CML_EventMap.h</a>.    </td>
  </tr>
</table>
<a class="anchor" name="a3"></a><!-- doxytag: member="Event::setChain" ref="a3" args="(class EventMap &amp;map, uint32 mask)" --><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">void setChain           </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top">class <a class="el" href="classEventMap.html">EventMap</a> &amp;&nbsp;</td>
          <td class="mdname" nowrap> <em>map</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>mask</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>
Setup event chaining. 
<p>
Each time the event is updated, it will either set or clear the bits specified by mask in the referenced <a class="el" href="classEventMap.html">EventMap</a> object. The bits will be set if the update causes the event to be true, and cleared otherwise.<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>map</em>&nbsp;</td><td>The map to chain. </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>mask</em>&nbsp;</td><td>The bit(s) to set/clear in the chained map based on the state of this event.</td></tr>
  </table>
</dl>

<p>
Definition at line <a class="el" href="EventMap_8cpp-source.html#l00142">142</a> of file <a class="el" href="EventMap_8cpp-source.html">EventMap.cpp</a>.    </td>
  </tr>
</table>
<a class="anchor" name="a2"></a><!-- doxytag: member="Event::setValue" ref="a2" args="(uint32 val)" --><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> * setValue           </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top"><a class="el" href="CML__Utils_8h.html#a10">uint32</a>&nbsp;</td>
          <td class="mdname1" valign="top" nowrap> <em>val</em>          </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>
Change the value that the event will wait for. 
<p>
The event's value can not be changed while it is attached to an <a class="el" href="classEventMap.html">EventMap</a> object. If this is attempted, then &amp;<a class="el" href="classEventError.html#s0">EventError::AlreadyOwned</a> will be returned.<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>val</em>&nbsp;</td><td>The new event value </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>
Definition at line <a class="el" href="EventMap_8cpp-source.html#l00062">62</a> of file <a class="el" href="EventMap_8cpp-source.html">EventMap.cpp</a>.    </td>
  </tr>
</table>
<a class="anchor" name="a7"></a><!-- doxytag: member="Event::Wait" ref="a7" args="(EventMap &amp;m, int32 timeout)" --><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> * Wait           </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top"><a class="el" href="classEventMap.html">EventMap</a> &amp;&nbsp;</td>
          <td class="mdname" nowrap> <em>m</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#a9">int32</a>&nbsp;</td>
          <td class="mdname" nowrap> <em>timeout</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>
Wait on an event. 
<p>
This function causes the calling thread to pend until the event is true, or the timeout expires.<p>
Note that the event should not be owned by any event map when this is called.<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>m</em>&nbsp;</td><td>The event map that this event should watch.</td></tr>
    <tr><td valign="top"></td><td valign="top"><em>timeout</em>&nbsp;</td><td>The maximum amount of time to wait (milliseconds). If &lt; 0, then the task will wait forever.</td></tr>
  </table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>A pointer to an error object on failure, or NULL on success.</dd></dl>

<p>
Definition at line <a class="el" href="EventMap_8cpp-source.html#l00111">111</a> of file <a class="el" href="EventMap_8cpp-source.html">EventMap.cpp</a>.    </td>
  </tr>
</table>
<hr>The documentation for this class was generated from the following files:<ul>
<li><a class="el" href="CML__EventMap_8h-source.html">CML_EventMap.h</a><li><a class="el" href="EventMap_8cpp-source.html">EventMap.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>