cml__error_8h-source.html

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

<a name="l00084"></a>00084 <span class="preprocessor">#ifdef CML_ERROR_MESSAGES</span>
<a name="l00085"></a>00085 <span class="preprocessor"></span>      <span class="keywordflow">return</span> description; 
<a name="l00086"></a>00086 <span class="preprocessor">#else</span>
<a name="l00087"></a>00087 <span class="preprocessor"></span>      <span class="keywordflow">return</span> <span class="stringliteral">"Error descriptions not supported"</span>;
<a name="l00088"></a>00088 <span class="preprocessor">#endif</span>
<a name="l00089"></a>00089 <span class="preprocessor"></span>   }
<a name="l00090"></a>00090 
<a name="l00091"></a>00091    <span class="comment">/***************************************************************************/</span><span class="comment"></span>
<a name="l00092"></a>00092 <span class="comment">   /**</span>
<a name="l00093"></a>00093 <span class="comment">     Return an integer ID that can be used to identify the error.</span>
<a name="l00094"></a>00094 <span class="comment"></span>
<a name="l00095"></a>00095 <span class="comment">     Each error code in the system has a unique 16-bit integer identifier associated</span>
<a name="l00096"></a>00096 <span class="comment">     with it.  This function can be used to return this identifier.</span>
<a name="l00097"></a>00097 <span class="comment"></span>
<a name="l00098"></a>00098 <span class="comment">     These ID codes are primarily intended for internal use by the Error object, they</span>
<a name="l00099"></a>00099 <span class="comment">     are only provided externally for use in system which require an integer error ID</span>
<a name="l00100"></a>00100 <span class="comment">     code to interface with other parts of the system.  The function Error::Lookup</span>
<a name="l00101"></a>00101 <span class="comment">     can be used to convert the ID value back into an error object.</span>
<a name="l00102"></a>00102 <span class="comment"></span>
<a name="l00103"></a>00103 <span class="comment">     @return The 16-bit integer ID value associated with this Error object.</span>
<a name="l00104"></a>00104 <span class="comment">     */</span>
<a name="l00105"></a>00105    <span class="comment">/***************************************************************************/</span>
<a name="l00106"></a><a class="code" href="classError.html#a1">00106</a>    <a class="code" href="CML__Utils_8h.html#a8">uint16</a> GetID( <span class="keywordtype">void</span> )<span class="keyword"> const </span>{ <span class="keywordflow">return</span> id; }
<a name="l00107"></a>00107 
<a name="l00108"></a>00108 <span class="preprocessor">#if CML_ERROR_HASH_SIZE &gt; 0 </span>
<a name="l00109"></a>00109 <span class="preprocessor"></span>   <span class="keyword">static</span> <span class="keyword">const</span> Error *Lookup( <a class="code" href="CML__Utils_8h.html#a7">int16</a> <span class="keywordtype">id</span> );
<a name="l00110"></a>00110 <span class="preprocessor">#endif</span>
<a name="l00111"></a>00111 <span class="preprocessor"></span>
<a name="l00112"></a>00112 <span class="keyword">protected</span>:<span class="comment"></span>
<a name="l00113"></a>00113 <span class="comment">   /**</span>
<a name="l00114"></a>00114 <span class="comment">     Constructor used to create an error object of a particular</span>
<a name="l00115"></a>00115 <span class="comment">     type.  This constructor is protected, so only sub-classes </span>
<a name="l00116"></a>00116 <span class="comment">     of the Error class can construct objects in this manner.</span>
<a name="l00117"></a>00117 <span class="comment"></span>
<a name="l00118"></a>00118 <span class="comment">     A unique ID coded and a description string must be provided</span>
<a name="l00119"></a>00119 <span class="comment">     with the new object.</span>
<a name="l00120"></a>00120 <span class="comment">     */</span>
<a name="l00121"></a><a class="code" href="classError.html#b0">00121</a>    Error( <a class="code" href="CML__Utils_8h.html#a8">uint16</a> i, <span class="keyword">const</span> <span class="keywordtype">char</span> *desc ): 
<a name="l00122"></a>00122       id(i)
<a name="l00123"></a>00123 #ifdef <a class="code" href="CML__Settings_8h.html#a9">CML_ERROR_MESSAGES</a>
<a name="l00124"></a>00124     , description(desc)
<a name="l00125"></a>00125 #endif
<a name="l00126"></a>00126    {
<a name="l00127"></a>00127 <span class="preprocessor">#if CML_ERROR_HASH_SIZE &gt; 0 </span>
<a name="l00128"></a>00128 <span class="preprocessor"></span>      InitErrorHash();
<a name="l00129"></a>00129 <span class="preprocessor">#endif</span>
<a name="l00130"></a>00130 <span class="preprocessor"></span>   }
<a name="l00131"></a>00131 
<a name="l00132"></a>00132 <span class="keyword">private</span>:
<a name="l00133"></a>00133 <span class="comment"></span>
<a name="l00134"></a>00134 <span class="comment">   /// An ID code that identifies the type of the error.</span>
<a name="l00135"></a>00135 <span class="comment"></span>   <a class="code" href="CML__Utils_8h.html#a8">uint16</a> id;
<a name="l00136"></a>00136 <span class="comment"></span>
<a name="l00137"></a>00137 <span class="comment">   /// A constant description of the error code assigned</span>
<a name="l00138"></a>00138 <span class="comment">   /// to new error types.</span>
<a name="l00139"></a>00139 <span class="comment"></span><span class="preprocessor">#ifdef CML_ERROR_MESSAGES</span>
<a name="l00140"></a>00140 <span class="preprocessor"></span>   <span class="keyword">const</span> <span class="keywordtype">char</span> *description;
<a name="l00141"></a>00141 <span class="preprocessor">#endif</span>
<a name="l00142"></a>00142 <span class="preprocessor"></span>
<a name="l00143"></a>00143 <span class="preprocessor">#if CML_ERROR_HASH_SIZE &gt; 0 </span>
<a name="l00144"></a>00144 <span class="preprocessor"></span><span class="comment">   /// Used for error code lookup</span>
<a name="l00145"></a>00145 <span class="comment"></span>   <span class="keyword">const</span> Error *next;
<a name="l00146"></a>00146 <span class="comment"></span>
<a name="l00147"></a>00147 <span class="comment">   /// Internal function used to initialize the error object</span>
<a name="l00148"></a>00148 <span class="comment">   /// hash when a new error is constructed.</span>
<a name="l00149"></a>00149 <span class="comment"></span>   <span class="keywordtype">void</span> InitErrorHash( <span class="keywordtype">void</span> );
<a name="l00150"></a>00150 <span class="preprocessor">#endif</span>
<a name="l00151"></a>00151 <span class="preprocessor"></span>};
<a name="l00152"></a>00152 
<a name="l00153"></a>00153 <span class="comment">// The following macro is useful for creating new error objects</span>
<a name="l00154"></a>00154 <span class="preprocessor">#ifdef CML_ERROR_MESSAGES</span>
<a name="l00155"></a><a class="code" href="CML__Error_8h.html#a0">00155</a> <span class="preprocessor"></span><span class="preprocessor">#  define CML_NEW_ERROR( group, name, message ) const group group::name = group( CMLERR_ ## group ## _ ## name, message )</span>
<a name="l00156"></a>00156 <span class="preprocessor"></span><span class="preprocessor">#else</span>
<a name="l00157"></a>00157 <span class="preprocessor"></span><span class="preprocessor">#  define CML_NEW_ERROR( group, name, message ) const group group::name = group( CMLERR_ ## group ## _ ## name, 0 )</span>
<a name="l00158"></a>00158 <span class="preprocessor"></span><span class="preprocessor">#endif</span>
<a name="l00159"></a>00159 <span class="preprocessor"></span>
<a name="l00160"></a>00160 <a class="code" href="CML__Settings_8h.html#a12">CML_NAMESPACE_END</a>()
<a name="l00161"></a>00161 
<a name="l00162"></a>00162 #endif
<a name="l00163"></a>00163 
</pre></div><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>