cml__error_8h-source.html
来自「美国COPLEY驱动器,程序开发工具之一.」· HTML 代码 · 共 183 行 · 第 1/2 页
HTML
183 行
<!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_Error.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_Error.h</h1><a href="CML__Error_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"></span><a name="l00014"></a>00014 <span class="comment">This file defines the top level error class used throughout the </span><a name="l00015"></a>00015 <span class="comment">library.</span><a name="l00016"></a>00016 <span class="comment">*/</span><a name="l00017"></a>00017 <a name="l00018"></a>00018 <span class="preprocessor">#ifndef _DEF_INC_ERROR</span><a name="l00019"></a>00019 <span class="preprocessor"></span><span class="preprocessor">#define _DEF_INC_ERROR</span><a name="l00020"></a>00020 <span class="preprocessor"></span><a name="l00021"></a>00021 <span class="preprocessor">#include "CML_ErrorCodes.h"</span><a name="l00022"></a>00022 <span class="preprocessor">#include "<a class="code" href="CML__Settings_8h.html">CML_Settings.h</a>"</span><a name="l00023"></a>00023 <span class="preprocessor">#include "<a class="code" href="CML__Utils_8h.html">CML_Utils.h</a>"</span><a name="l00024"></a>00024 <a name="l00025"></a>00025 <a class="code" href="CML__Settings_8h.html#a11">CML_NAMESPACE_START</a>()<a name="l00026"></a>00026 <a name="l00027"></a>00027 <span class="comment">/**</span><a name="l00028"></a>00028 <span class="comment">This class is the root class for all error codes</span><a name="l00029"></a>00029 <span class="comment">returned by functions defined within the Motion Library.</span><a name="l00030"></a>00030 <span class="comment"></span><a name="l00031"></a>00031 <span class="comment">Every error condition defined in the library has a constant,</span><a name="l00032"></a>00032 <span class="comment">static error object associated with it. Pointers to these </span><a name="l00033"></a>00033 <span class="comment">objects are returned from the various function calls. </span><a name="l00034"></a>00034 <span class="comment"></span><a name="l00035"></a>00035 <span class="comment">All library functions that return an error object pointer</span><a name="l00036"></a>00036 <span class="comment">will return a NULL pointer in the case of no error. This</span><a name="l00037"></a>00037 <span class="comment">allows one to simply test the error pointer returned to</span><a name="l00038"></a>00038 <span class="comment">determine if it indicates an error.</span><a name="l00039"></a>00039 <span class="comment"></span><a name="l00040"></a>00040 <span class="comment">For example:</span><a name="l00041"></a>00041 <span class="comment"></span><a name="l00042"></a>00042 <span class="comment"><PRE></span><a name="l00043"></a>00043 <span class="comment"> const Error *err = SomeFunctionCall();</span><a name="l00044"></a>00044 <span class="comment"> </span><a name="l00045"></a>00045 <span class="comment"> if( err )</span><a name="l00046"></a>00046 <span class="comment"> printf( "Error: %%s\\n", err->toString() );</span><a name="l00047"></a>00047 <span class="comment"> else</span><a name="l00048"></a>00048 <span class="comment"> printf( "no error\\n" );</span><a name="l00049"></a>00049 <span class="comment"> </span><a name="l00050"></a>00050 <span class="comment"></PRE></span><a name="l00051"></a>00051 <span class="comment"></span><a name="l00052"></a>00052 <span class="comment">To test for a specific error condition, the following code</span><a name="l00053"></a>00053 <span class="comment">can be used:</span><a name="l00054"></a>00054 <span class="comment"></span><a name="l00055"></a>00055 <span class="comment"><PRE></span><a name="l00056"></a>00056 <span class="comment"> const Error *err = SomeFunctionCall();</span><a name="l00057"></a>00057 <span class="comment"> </span><a name="l00058"></a>00058 <span class="comment"> if( err == &ThreadError::Timeout )</span><a name="l00059"></a>00059 <span class="comment"> printf( "A timeout occurred\\n" );</span><a name="l00060"></a>00060 <span class="comment"></PRE></span><a name="l00061"></a>00061 <span class="comment"></span><a name="l00062"></a>00062 <span class="comment">Note that the constructor used to create a new unique error</span><a name="l00063"></a>00063 <span class="comment">code is protected, therefore only sub-classes of the Error</span><a name="l00064"></a>00064 <span class="comment">object are allowed to create new unique error codes.</span><a name="l00065"></a>00065 <span class="comment">*/</span><a name="l00066"></a><a class="code" href="classError.html">00066</a> class <a class="code" href="classError.html">Error</a><a name="l00067"></a>00067 {<a name="l00068"></a>00068 <span class="keyword">public</span>:<span class="comment"></span><a name="l00069"></a>00069 <span class="comment"> /// A constant error object that represents no error.</span><a name="l00070"></a><a class="code" href="classError.html#s0">00070</a> <span class="comment"></span> <span class="keyword">static</span> <span class="keyword">const</span> Error OK;<a name="l00071"></a>00071 <span class="comment"></span><a name="l00072"></a>00072 <span class="comment"> /// An invalid error ID code was passed to Error::Lookup</span><a name="l00073"></a><a class="code" href="classError.html#s1">00073</a> <span class="comment"></span> <span class="keyword">static</span> <span class="keyword">const</span> Error Unknown;<a name="l00074"></a>00074 <span class="comment"></span><a name="l00075"></a>00075 <span class="comment"> /**</span><a name="l00076"></a>00076 <span class="comment"> Return a C style string describing the error condition</span><a name="l00077"></a>00077 <span class="comment"> represented by this error object.</span><a name="l00078"></a>00078 <span class="comment"></span><a name="l00079"></a>00079 <span class="comment"> @return A constant character string describing the error</span><a name="l00080"></a>00080 <span class="comment"> condition.</span><a name="l00081"></a>00081 <span class="comment"> */</span><a name="l00082"></a><a class="code" href="classError.html#a0">00082</a> <span class="keyword">const</span> <span class="keywordtype">char</span> *toString()<span class="keyword"> const </span><a name="l00083"></a>00083 <span class="keyword"> </span>{⌨️ 快捷键说明
复制代码Ctrl + C
搜索代码Ctrl + F
全屏模式F11
增大字号Ctrl + =
减小字号Ctrl + -
显示快捷键?