cml__eventmap_8h-source.html
来自「美国COPLEY驱动器,程序开发工具之一.」· HTML 代码 · 共 379 行 · 第 1/3 页
HTML
379 行
<!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: CML_EventMap.h Source File</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 Page</a> | <a class="qindex" href="hierarchy.html">Class Hierarchy</a> | <a class="qindex" href="classes.html">Alphabetical List</a> | <a class="qindex" href="annotated.html">Class List</a> | <a class="qindex" href="dirs.html">Directories</a> | <a class="qindex" href="files.html">File List</a> | <a class="qindex" href="functions.html">Class Members</a> | <a class="qindex" href="globals.html">File Members</a></div><div class="nav"><a class="el" href="dir_000001.html">inc</a></div><h1>CML_EventMap.h</h1><a href="CML__EventMap_8h.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">/************************************************************/</span><a name="l00002"></a>00002 <span class="comment">/* */</span><a name="l00003"></a>00003 <span class="comment">/* Copley Motion Libraries */</span><a name="l00004"></a>00004 <span class="comment">/* */</span><a name="l00005"></a>00005 <span class="comment">/* Author: Stephen Glow */</span><a name="l00006"></a>00006 <span class="comment">/* */</span><a name="l00007"></a>00007 <span class="comment">/* Copyright (c) 2002-2005 Copley Controls Corp. */</span><a name="l00008"></a>00008 <span class="comment">/* http://www.copleycontrols.com */</span><a name="l00009"></a>00009 <span class="comment">/* */</span><a name="l00010"></a>00010 <span class="comment">/************************************************************/</span><a name="l00011"></a>00011 <span class="comment"></span><a name="l00012"></a>00012 <span class="comment">/** \file</span><a name="l00013"></a>00013 <span class="comment">This file defines the Event Map class.</span><a name="l00014"></a>00014 <span class="comment">*/</span><a name="l00015"></a>00015 <a name="l00016"></a>00016 <span class="preprocessor">#ifndef _DEF_INC_EVENTMAP</span><a name="l00017"></a>00017 <span class="preprocessor"></span><span class="preprocessor">#define _DEF_INC_EVENTMAP</span><a name="l00018"></a>00018 <span class="preprocessor"></span><a name="l00019"></a>00019 <span class="preprocessor">#include "<a class="code" href="CML__Settings_8h.html">CML_Settings.h</a>"</span><a name="l00020"></a>00020 <span class="preprocessor">#include "<a class="code" href="CML__Threads_8h.html">CML_Threads.h</a>"</span><a name="l00021"></a>00021 <span class="preprocessor">#include "<a class="code" href="CML__Utils_8h.html">CML_Utils.h</a>"</span><a name="l00022"></a>00022 <a name="l00023"></a>00023 <a class="code" href="CML__Settings_8h.html#a11">CML_NAMESPACE_START</a>()<a name="l00024"></a>00024 <a name="l00025"></a>00025 <span class="comment">/***************************************************************************/</span><span class="comment"></span><a name="l00026"></a>00026 <span class="comment">/**</span><a name="l00027"></a>00027 <span class="comment">This class represents error conditions related to the Event object.</span><a name="l00028"></a>00028 <span class="comment">*/</span><a name="l00029"></a>00029 <span class="comment">/***************************************************************************/</span><a name="l00030"></a><a class="code" href="classEventError.html">00030</a> class <a class="code" href="classEventError.html">EventError</a>: public <a class="code" href="classError.html">Error</a><a name="l00031"></a>00031 {<a name="l00032"></a>00032 <span class="keyword">public</span>:<span class="comment"></span><a name="l00033"></a>00033 <span class="comment"> /// The event is already mapped to another object</span><a name="l00034"></a><a class="code" href="classEventError.html#s0">00034</a> <span class="comment"></span> <span class="keyword">static</span> <span class="keyword">const</span> <a class="code" href="classEventError.html">EventError</a> AlreadyOwned;<a name="l00035"></a>00035 <span class="comment"></span><a name="l00036"></a>00036 <span class="comment"> /// The event is not mapped to this object.</span><a name="l00037"></a><a class="code" href="classEventError.html#s1">00037</a> <span class="comment"></span> <span class="keyword">static</span> <span class="keyword">const</span> <a class="code" href="classEventError.html">EventError</a> NotMapped;<a name="l00038"></a>00038 <a name="l00039"></a>00039 <span class="keyword">protected</span>:<span class="comment"></span><a name="l00040"></a>00040 <span class="comment"> /// Standard protected constructor</span><a name="l00041"></a><a class="code" href="classEventError.html#b0">00041</a> <span class="comment"></span> <a class="code" href="classEventError.html">EventError</a>( <a class="code" href="CML__Utils_8h.html#a8">uint16</a> <span class="keywordtype">id</span>, <span class="keyword">const</span> <span class="keywordtype">char</span> *desc ): Error( id, desc ){}<a name="l00042"></a>00042 };<a name="l00043"></a>00043 <a name="l00044"></a>00044 <span class="comment">/***************************************************************************/</span><span class="comment"></span><a name="l00045"></a>00045 <span class="comment">/**</span><a name="l00046"></a>00046 <span class="comment">Events are a generic mechanism used to wait on some condition. They are</span><a name="l00047"></a>00047 <span class="comment">used in conjunction with the EventMap object.</span><a name="l00048"></a>00048 <span class="comment"></span><a name="l00049"></a>00049 <span class="comment">Every EventMap object has a 32-bit mask register which describes it's state.</span><a name="l00050"></a>00050 <span class="comment">Event objects may be attached to an EventMap to wait for any combination of</span><a name="l00051"></a>00051 <span class="comment">bits in the mask to become active.</span><a name="l00052"></a>00052 <span class="comment"></span><a name="l00053"></a>00053 <span class="comment">The base Event class is a virtual class, and therefore shouldn't be used</span><a name="l00054"></a>00054 <span class="comment">directy. It is extended by a number of sub-classes which are used to wait</span><a name="l00055"></a>00055 <span class="comment">for certain map bits to be set, cleared, etc.</span><a name="l00056"></a>00056 <span class="comment"></span><a name="l00057"></a>00057 <span class="comment">An Event object may only be assigned to one EventMap at a time. An attempt</span><a name="l00058"></a>00058 <span class="comment">to attach it to multiple EventMap objects will result in an error. Further, </span><a name="l00059"></a>00059 <span class="comment">Event objects are not thread safe. Only one thread should access a particular</span><a name="l00060"></a>00060 <span class="comment">Event object at a time. EventMap objects however are thread safe, so any </span><a name="l00061"></a>00061 <span class="comment">number of threads may attach their own Event objects to the same EventMap</span><a name="l00062"></a>00062 <span class="comment">object without issue.</span><a name="l00063"></a>00063 <span class="comment">*/</span><a name="l00064"></a>00064 <span class="comment">/***************************************************************************/</span><a name="l00065"></a><a class="code" href="classEvent.html">00065</a> <span class="keyword">class </span><a class="code" href="classEvent.html">Event</a><a name="l00066"></a>00066 {<a name="l00067"></a><a class="code" href="classEvent.html#n0">00067</a> <span class="keyword">friend</span> <span class="keyword">class </span><a class="code" href="classEventMap.html">EventMap</a>;<a name="l00068"></a>00068 <span class="comment"></span><a name="l00069"></a>00069 <span class="comment"> /// Pointer to the map that this event is assigned to</span><a name="l00070"></a>00070 <span class="comment"></span> <span class="keyword">class </span><a class="code" href="classEventMap.html">EventMap</a> *map;<a name="l00071"></a>00071 <a name="l00072"></a>00072 <a class="code" href="classEvent.html">Event</a> *prev, *next;<a name="l00073"></a>00073 <span class="comment"></span><a name="l00074"></a>00074 <span class="comment"> /// If a semaphore is attached to the Event, then the</span><a name="l00075"></a>00075 <span class="comment"> /// event will remove itself from the EventMap when it</span><a name="l00076"></a>00076 <span class="comment"> /// becomes true. If not, it will stay attached.</span><a name="l00077"></a>00077 <span class="comment"></span> <a class="code" href="classSemaphore.html">Semaphore</a> *semPtr;<a name="l00078"></a>00078 <span class="comment"></span><a name="l00079"></a>00079 <span class="comment"> /// Used for more complex event types</span><a name="l00080"></a>00080 <span class="comment"></span> <span class="keyword">class </span><a class="code" href="classEventMap.html">EventMap</a> *chainMap;<a name="l00081"></a>00081 <a class="code" href="CML__Utils_8h.html#a10">uint32</a> chainMask;<a name="l00082"></a>00082 <span class="comment"></span><a name="l00083"></a>00083 <span class="comment"> /// This is the most recent mask that cause the event to succeed</span><a name="l00084"></a>00084 <span class="comment"></span> <a class="code" href="CML__Utils_8h.html#a10">uint32</a> trueMask;<a name="l00085"></a>00085 <span class="comment"></span><a name="l00086"></a>00086 <span class="comment"> /// Called by the EventMap for all attached Events </span><a name="l00087"></a>00087 <span class="comment"> /// whenever the map's mask is updated.</span><a name="l00088"></a>00088 <span class="comment"></span> <span class="keywordtype">void</span> update( <a class="code" href="CML__Utils_8h.html#a10">uint32</a> newMask );<a name="l00089"></a>00089 <a name="l00090"></a>00090 <span class="keyword">protected</span>:<span class="comment"></span><a name="l00091"></a>00091 <span class="comment"> /// This is the value that the event is waiting for</span><a name="l00092"></a><a class="code" href="classEvent.html#p0">00092</a> <span class="comment"></span> <a class="code" href="CML__Utils_8h.html#a10">uint32</a> <a class="code" href="classEvent.html#p0">value</a>;<a name="l00093"></a>00093 <a name="l00094"></a>00094 <span class="keyword">public</span>:<a name="l00095"></a>00095 <a class="code" href="classEvent.html#a0">Event</a>( <a class="code" href="CML__Utils_8h.html#a10">uint32</a> val=0 );<a name="l00096"></a>00096 <span class="keyword">virtual</span> <a class="code" href="classEvent.html#a1">~Event</a>();<a name="l00097"></a>00097 <a name="l00098"></a>00098 <span class="keyword">const</span> <a class="code" href="classError.html">Error</a> *<a class="code" href="classEvent.html#a2">setValue</a>( <a class="code" href="CML__Utils_8h.html#a10">uint32</a> val );<a name="l00099"></a>00099 <a name="l00100"></a>00100 <span class="keywordtype">void</span> <a class="code" href="classEvent.html#a3">setChain</a>( <span class="keyword">class</span> <a class="code" href="classEventMap.html">EventMap</a> &map, <a class="code" href="CML__Utils_8h.html#a10">uint32</a> mask );<a name="l00101"></a>00101 <span class="keywordtype">void</span> <a class="code" href="classEvent.html#a4">delChain</a>( <span class="keywordtype">void</span> );<a name="l00102"></a>00102 <a name="l00103"></a>00103 <span class="comment">/***************************************************************************/</span><span class="comment"></span><a name="l00104"></a>00104 <span class="comment"> /**</span><a name="l00105"></a>00105 <span class="comment"> Return the value that this event will wait on.</span><a name="l00106"></a>00106 <span class="comment"> @return The event value</span><a name="l00107"></a>00107 <span class="comment"> */</span><a name="l00108"></a>00108 <span class="comment">/***************************************************************************/</span><a name="l00109"></a><a class="code" href="classEvent.html#a5">00109</a> <a class="code" href="CML__Utils_8h.html#a10">uint32</a> <a class="code" href="classEvent.html#a5">getValue</a>( <span class="keywordtype">void</span> ){ <span class="keywordflow">return</span> <a class="code" href="classEvent.html#p0">value</a>; }<a name="l00110"></a>00110 <a name="l00111"></a>00111 <span class="comment">/***************************************************************************/</span><span class="comment"></span><a name="l00112"></a>00112 <span class="comment"> /**</span><a name="l00113"></a>00113 <span class="comment"> Return the most recent mask value that caused the event to succeed.</span><a name="l00114"></a>00114 <span class="comment"> After a successful Wait, this can be used to return the mask that </span><a name="l00115"></a>00115 <span class="comment"> caused the successful match.</span><a name="l00116"></a>00116 <span class="comment"> */</span><a name="l00117"></a>00117 <span class="comment">/***************************************************************************/</span><a name="l00118"></a><a class="code" href="classEvent.html#a6">00118</a> <a class="code" href="CML__Utils_8h.html#a10">uint32</a> <a class="code" href="classEvent.html#a6">getMask</a>( <span class="keywordtype">void</span> ){ <span class="keywordflow">return</span> trueMask; }⌨️ 快捷键说明
复制代码Ctrl + C
搜索代码Ctrl + F
全屏模式F11
增大字号Ctrl + =
减小字号Ctrl + -
显示快捷键?