classeventmap.html

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

HTML
365
字号
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"><html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"><title>Copley Motion Library: EventMap Class Reference</title><link href="doxygen.css" rel="stylesheet" type="text/css"></head><body><!-- Generated by Doxygen 1.4.4 --><div class="qindex"><a class="qindex" href="main.html">Main&nbsp;Page</a> | <a class="qindex" href="hierarchy.html">Class&nbsp;Hierarchy</a> | <a class="qindex" href="classes.html">Alphabetical&nbsp;List</a> | <a class="qindex" href="annotated.html">Class&nbsp;List</a> | <a class="qindex" href="dirs.html">Directories</a> | <a class="qindex" href="files.html">File&nbsp;List</a> | <a class="qindex" href="functions.html">Class&nbsp;Members</a> | <a class="qindex" href="globals.html">File&nbsp;Members</a></div><h1>EventMap Class Reference</h1><!-- doxytag: class="EventMap" --><a href="classEventMap-members.html">List of all members.</a><hr><a name="_details"></a><h2>Detailed Description</h2>An event map is a mechanism that allows one or more threads to wait on some pre-defined event, or group of events. <p>For a particular event map, there are one or more events that are grouped with that map. Any number of threads may pend on the state of these events.<p><p>Definition at line <a class="el" href="CML__EventMap_8h-source.html#l00267">267</a> of file <a class="el" href="CML__EventMap_8h-source.html">CML_EventMap.h</a>.<table border="0" cellpadding="0" cellspacing="0"><tr><td></td></tr><tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a0"></a><!-- doxytag: member="EventMap::EventMap" ref="a0" args="()" -->&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classEventMap.html#a0">EventMap</a> ()</td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classEventMap.html#a1">~EventMap</a> (void)</td></tr><tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight"><a class="el" href="classEvent.html">Event</a> map destructor.  <a href="#a1"></a><br></td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top">const <a class="el" href="classError.html">Error</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classEventMap.html#a2">Add</a> (<a class="el" href="classEvent.html">Event</a> *e)</td></tr><tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Add the passed event to the list of events pending on this map.  <a href="#a2"></a><br></td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top">const <a class="el" href="classError.html">Error</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classEventMap.html#a3">Remove</a> (<a class="el" href="classEvent.html">Event</a> *e)</td></tr><tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Remove the passed event from the list of events pending on this map.  <a href="#a3"></a><br></td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="CML__Utils_8h.html#a10">uint32</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classEventMap.html#a4">getMask</a> (void)</td></tr><tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the current value of the mask for this event map.  <a href="#a4"></a><br></td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classEventMap.html#a5">setMask</a> (<a class="el" href="CML__Utils_8h.html#a10">uint32</a> mask)</td></tr><tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Update the event mask.  <a href="#a5"></a><br></td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classEventMap.html#a6">setBits</a> (<a class="el" href="CML__Utils_8h.html#a10">uint32</a> bits)</td></tr><tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set bits in the event mask.  <a href="#a6"></a><br></td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classEventMap.html#a7">clrBits</a> (<a class="el" href="CML__Utils_8h.html#a10">uint32</a> bits)</td></tr><tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Clear bits in the event mask.  <a href="#a7"></a><br></td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classEventMap.html#a8">changeBits</a> (<a class="el" href="CML__Utils_8h.html#a10">uint32</a> bits, <a class="el" href="CML__Utils_8h.html#a10">uint32</a> value)</td></tr><tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Change the value of specified bits in the mask for this event.  <a href="#a8"></a><br></td></tr><tr><td colspan="2"><br><h2>Friends</h2></td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="n0"></a><!-- doxytag: member="EventMap::Event" ref="n0" args="" -->class&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classEventMap.html#n0">Event</a></td></tr></table><hr><h2>Constructor &amp; Destructor Documentation</h2><a class="anchor" name="a1"></a><!-- doxytag: member="EventMap::~EventMap" ref="a1" 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="classEventMap.html">EventMap</a>           </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><a class="el" href="classEvent.html">Event</a> map destructor. <p>Removes any attached events Note that it is an error to destroy an EventMap if it is currently pointed to by any events using 'setChain'. Make sure to remove any such chaining before the event map is destroyed.<p>Definition at line <a class="el" href="EventMap_8cpp-source.html#l00167">167</a> of file <a class="el" href="EventMap_8cpp-source.html">EventMap.cpp</a>.    </td>  </tr></table><hr><h2>Member Function Documentation</h2><a class="anchor" name="a2"></a><!-- doxytag: member="EventMap::Add" ref="a2" args="(Event *e)" --><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> * Add           </td>          <td class="md" valign="top">(&nbsp;</td>          <td class="md" nowrap valign="top"><a class="el" href="classEvent.html">Event</a> *&nbsp;</td>          <td class="mdname1" valign="top" nowrap> <em>e</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>Add the passed event to the list of events pending on this map. <p>If the event is already mapped to a map (this one or another) then this function will return &amp;<a class="el" href="classEventError.html#s0">EventError::AlreadyOwned</a>.<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>e</em>&nbsp;</td><td>Points to the event to add </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#l00182">182</a> of file <a class="el" href="EventMap_8cpp-source.html">EventMap.cpp</a>.    </td>  </tr></table><a class="anchor" name="a8"></a><!-- doxytag: member="EventMap::changeBits" ref="a8" args="(uint32 bits, uint32 value)" --><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 changeBits           </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="mdname" nowrap> <em>bits</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>value</em></td>        </tr>        <tr>          <td class="md"></td>          <td class="md">)&nbsp;</td>          <td class="md" colspan="2"><code> [inline]</code></td>        </tr>      </table>    </td>  </tr></table><table cellspacing="5" cellpadding="0" border="0">  <tr>    <td>      &nbsp;    </td>    <td><p>Change the value of specified bits in the mask for this event. <p>The bits to change are identified by one parameter, and the new value for these bits is specified in the other parameter. <dl compact><dt><b>Parameters:</b></dt><dd>  <table border="0" cellspacing="2" cellpadding="0">    <tr><td valign="top"></td><td valign="top"><em>bits</em>&nbsp;</td><td>Identifies which bits in the mask to change. Only those bits which are set in this parameter will be effected in the event mask. </td></tr>    <tr><td valign="top"></td><td valign="top"><em>value</em>&nbsp;</td><td>The new value for the bits identified in the first parameter.</td></tr>  </table></dl><p>Definition at line <a class="el" href="CML__EventMap_8h-source.html#l00337">337</a> of file <a class="el" href="CML__EventMap_8h-source.html">CML_EventMap.h</a>.    </td>  </tr></table><a class="anchor" name="a7"></a><!-- doxytag: member="EventMap::clrBits" ref="a7" args="(uint32 bits)" --><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 clrBits           </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>bits</em>          </td>          <td class="md" valign="top">&nbsp;)&nbsp;</td>          <td class="md" nowrap><code> [inline]</code></td>        </tr>      </table>

⌨️ 快捷键说明

复制代码Ctrl + C
搜索代码Ctrl + F
全屏模式F11
增大字号Ctrl + =
减小字号Ctrl + -
显示快捷键?