📄 eventmap_8cpp-source.html
字号:
<!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.cpp 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_000000.html">c</a></div><h1>EventMap.cpp</h1><a href="EventMap_8cpp.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 contains the implementation of the EventMap class.</span><a name="l00014"></a>00014 <span class="comment">*/</span><a name="l00015"></a>00015 <a name="l00016"></a>00016 <span class="preprocessor">#include "<a class="code" href="CML_8h.html">CML.h</a>"</span><a name="l00017"></a>00017 <a name="l00018"></a>00018 <a class="code" href="CML__Settings_8h.html#a13">CML_NAMESPACE_USE</a>();<a name="l00019"></a>00019 <a name="l00020"></a>00020 <span class="comment">/**************************************************</span><a name="l00021"></a>00021 <span class="comment">* Event related error objects</span><a name="l00022"></a>00022 <span class="comment">**************************************************/</span><a name="l00023"></a>00023 <a class="code" href="CML__Error_8h.html#a0">CML_NEW_ERROR</a>( <a class="code" href="classEventError.html">EventError</a>, AlreadyOwned, <span class="stringliteral">"The event is already mapped to another object"</span> );<a name="l00024"></a>00024 <a class="code" href="CML__Error_8h.html#a0">CML_NEW_ERROR</a>( <a class="code" href="classEventError.html">EventError</a>, NotMapped, <span class="stringliteral">"The event is not mapped to this object."</span> );<a name="l00025"></a>00025 <a name="l00026"></a>00026 <span class="comment">/***************************************************************************/</span><span class="comment"></span><a name="l00027"></a>00027 <span class="comment">/**</span><a name="l00028"></a>00028 <span class="comment">Default constructor for an Event object.</span><a name="l00029"></a>00029 <span class="comment">@param val The value that the event will wait for. If not specified, </span><a name="l00030"></a>00030 <span class="comment"> defaults to zero.</span><a name="l00031"></a>00031 <span class="comment">*/</span><a name="l00032"></a>00032 <span class="comment">/***************************************************************************/</span><a name="l00033"></a><a class="code" href="classEvent.html#a0">00033</a> <a class="code" href="classEvent.html#a0">Event::Event</a>( <a class="code" href="CML__Utils_8h.html#a10">uint32</a> val )<a name="l00034"></a>00034 {<a name="l00035"></a>00035 map = 0; <a name="l00036"></a>00036 semPtr = 0; <a name="l00037"></a>00037 chainMap = 0;<a name="l00038"></a>00038 <a class="code" href="classEvent.html#p0">value</a> = val;<a name="l00039"></a>00039 }<a name="l00040"></a>00040 <a name="l00041"></a>00041 <span class="comment">/***************************************************************************/</span><span class="comment"></span><a name="l00042"></a>00042 <span class="comment">/**</span><a name="l00043"></a>00043 <span class="comment">Event distructor. This makes sure the event isn't mapped when it's destroyed</span><a name="l00044"></a>00044 <span class="comment">*/</span><a name="l00045"></a>00045 <span class="comment">/***************************************************************************/</span><a name="l00046"></a><a class="code" href="classEvent.html#a1">00046</a> <a class="code" href="classEvent.html#a1">Event::~Event</a>( <span class="keywordtype">void</span> )<a name="l00047"></a>00047 {<a name="l00048"></a>00048 <span class="keywordflow">if</span>( map )<a name="l00049"></a>00049 map-><a class="code" href="classEventMap.html#a3">Remove</a>( <span class="keyword">this</span> );<a name="l00050"></a>00050 }<a name="l00051"></a>00051 <a name="l00052"></a>00052 <span class="comment">/***************************************************************************/</span><span class="comment"></span><a name="l00053"></a>00053 <span class="comment">/**</span><a name="l00054"></a>00054 <span class="comment">Change the value that the event will wait for. The event's value can not</span><a name="l00055"></a>00055 <span class="comment">be changed while it is attached to an EventMap object. If this is attempted, </span><a name="l00056"></a>00056 <span class="comment">then &EventError::AlreadyOwned will be returned.</span><a name="l00057"></a>00057 <span class="comment"></span><a name="l00058"></a>00058 <span class="comment">@param val The new event value</span><a name="l00059"></a>00059 <span class="comment">@return A pointer to an error object, or NULL on success.</span><a name="l00060"></a>00060 <span class="comment">*/</span><a name="l00061"></a>00061 <span class="comment">/***************************************************************************/</span><a name="l00062"></a><a class="code" href="classEvent.html#a2">00062</a> <span class="keyword">const</span> <a class="code" href="classError.html">Error</a> *<a class="code" href="classEvent.html#a2">Event::setValue</a>( <a class="code" href="CML__Utils_8h.html#a10">uint32</a> val )<a name="l00063"></a>00063 {<a name="l00064"></a>00064 <span class="keywordflow">if</span>( map ) <span class="keywordflow">return</span> &<a class="code" href="classEventError.html#s0">EventError::AlreadyOwned</a>;<a name="l00065"></a>00065 <a class="code" href="classEvent.html#p0">value</a> = val;<a name="l00066"></a>00066 <span class="keywordflow">return</span> 0;<a name="l00067"></a>00067 }<a name="l00068"></a>00068 <a name="l00069"></a>00069 <span class="comment">/***************************************************************************/</span><span class="comment"></span><a name="l00070"></a>00070 <span class="comment">/**</span><a name="l00071"></a>00071 <span class="comment">Update this event's mask. If this event has a semaphore associated with it,</span><a name="l00072"></a>00072 <span class="comment">and this update causes it to become true, then the semaphore will be posted</span><a name="l00073"></a>00073 <span class="comment">and the event will be removed from it's map.</span><a name="l00074"></a>00074 <span class="comment">@param newMask The new mask value</span><a name="l00075"></a>00075 <span class="comment">*/</span><a name="l00076"></a>00076 <span class="comment">/***************************************************************************/</span><a name="l00077"></a>00077 <span class="keywordtype">void</span> Event::update( <a class="code" href="CML__Utils_8h.html#a10">uint32</a> mask )<a name="l00078"></a>00078 {<a name="l00079"></a>00079 <span class="keywordtype">bool</span> t = <a class="code" href="classEvent.html#a8">isTrue</a>( mask );<a name="l00080"></a>00080 <a name="l00081"></a>00081 <span class="keywordflow">if</span>( t )<a name="l00082"></a>00082 {<a name="l00083"></a>00083 trueMask = mask;<a name="l00084"></a>00084 <a name="l00085"></a>00085 <span class="keywordflow">if</span>( chainMap )<a name="l00086"></a>00086 chainMap-><a class="code" href="classEventMap.html#a6">setBits</a>( chainMask );<a name="l00087"></a>00087 <a name="l00088"></a>00088 <span class="keywordflow">if</span>( semPtr )<a name="l00089"></a>00089 semPtr-><a class="code" href="classSemaphore.html#a3">Put</a>();<a name="l00090"></a>00090 }<a name="l00091"></a>00091 <a name="l00092"></a>00092 <span class="keywordflow">else</span> <span class="keywordflow">if</span>( chainMap )<a name="l00093"></a>00093 chainMap-><a class="code" href="classEventMap.html#a7">clrBits</a>( chainMask );<a name="l00094"></a>00094 }<a name="l00095"></a>00095 <a name="l00096"></a>00096 <span class="comment">/***************************************************************************/</span><span class="comment"></span><a name="l00097"></a>00097 <span class="comment">/**</span><a name="l00098"></a>00098 <span class="comment">Wait on an event. This function causes the calling thread to pend until</span><a name="l00099"></a>00099 <span class="comment">the event is true, or the timeout expires.</span><a name="l00100"></a>00100 <span class="comment"></span><a name="l00101"></a>00101 <span class="comment">Note that the event should not be owned by any event map when this is called.</span><a name="l00102"></a>00102 <span class="comment"></span><a name="l00103"></a>00103 <span class="comment">@param m The event map that this event should watch.</span><a name="l00104"></a>00104 <span class="comment"></span><a name="l00105"></a>00105 <span class="comment">@param timeout The maximum amount of time to wait (milliseconds). If < 0,</span><a name="l00106"></a>00106 <span class="comment"> then the task will wait forever.</span><a name="l00107"></a>00107 <span class="comment"> </span><a name="l00108"></a>00108 <span class="comment">@return A pointer to an error object on failure, or NULL on success.</span><a name="l00109"></a>00109 <span class="comment">*/</span><a name="l00110"></a>00110 <span class="comment">/***************************************************************************/</span><a name="l00111"></a><a class="code" href="classEvent.html#a7">00111</a> <span class="keyword">const</span> <a class="code" href="classError.html">Error</a> *<a class="code" href="classEvent.html#a7">Event::Wait</a>( <a class="code" href="classEventMap.html">EventMap</a> &m, <a class="code" href="CML__Utils_8h.html#a9">int32</a> timeout )<a name="l00112"></a>00112 {<a name="l00113"></a>00113 <a class="code" href="classSemaphore.html">Semaphore</a> sem;<a name="l00114"></a>00114 semPtr = &sem;<a name="l00115"></a>00115 <a name="l00116"></a>00116 <span class="keyword">const</span> <a class="code" href="classError.html">Error</a> *err = m.<a class="code" href="classEventMap.html#a2">Add</a>( <span class="keyword">this</span> );<a name="l00117"></a>00117 <span class="keywordflow">if</span>( err )<a name="l00118"></a>00118 {<a name="l00119"></a>00119 semPtr = 0;<a name="l00120"></a>00120 <span class="keywordflow">return</span> err;<a name="l00121"></a>00121 }<a name="l00122"></a>00122 <a name="l00123"></a>00123 err = sem.<a class="code" href="classSemaphore.html#a2">Get</a>(timeout);<a name="l00124"></a>00124 ⌨️ 快捷键说明
复制代码
Ctrl + C
搜索代码
Ctrl + F
全屏模式
F11
切换主题
Ctrl + Shift + D
显示快捷键
?
增大字号
Ctrl + =
减小字号
Ctrl + -