📄 cml_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: CML.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>CML.cpp</h1><a href="CML_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">CML object definition. This file contains the code used to </span><a name="l00014"></a>00014 <span class="comment">implement the global CML object.</span><a name="l00015"></a>00015 <span class="comment">*/</span><a name="l00016"></a>00016 <a name="l00017"></a>00017 <span class="preprocessor">#include "<a class="code" href="CML_8h.html">CML.h</a>"</span><a name="l00018"></a>00018 <a name="l00019"></a>00019 <span class="preprocessor">#ifdef CML_FILE_ACCESS_OK</span><a name="l00020"></a>00020 <span class="preprocessor"></span><span class="preprocessor">#include <stdio.h></span><a name="l00021"></a>00021 <span class="preprocessor">#include <string.h></span><a name="l00022"></a>00022 <span class="preprocessor">#include <stdarg.h></span><a name="l00023"></a>00023 <span class="preprocessor">#endif</span><a name="l00024"></a>00024 <span class="preprocessor"></span><a name="l00025"></a>00025 <span class="comment">// Global CML object</span><a name="l00026"></a>00026 <a class="code" href="CML__Settings_8h.html#a11">CML_NAMESPACE_START</a>()<a name="l00027"></a><a class="code" href="CML_8cpp.html#a0">00027</a> <a class="code" href="classCopleyMotionLibrary.html">CopleyMotionLibrary</a> <a class="code" href="CML_8h.html#a0">cml</a>;<a name="l00028"></a>00028 <a class="code" href="CML__Settings_8h.html#a12">CML_NAMESPACE_END</a>()<a name="l00029"></a>00029 <a name="l00030"></a>00030 <a class="code" href="CML__Settings_8h.html#a13">CML_NAMESPACE_USE</a>();<a name="l00031"></a>00031 <a name="l00032"></a>00032 <span class="comment">/***************************************************************************/</span><span class="comment"></span><a name="l00033"></a>00033 <span class="comment">/**</span><a name="l00034"></a>00034 <span class="comment">Default constructor for the CopleyMotionLibrary object.</span><a name="l00035"></a>00035 <span class="comment">*/</span><a name="l00036"></a>00036 <span class="comment">/***************************************************************************/</span><a name="l00037"></a><a class="code" href="classCopleyMotionLibrary.html#a0">00037</a> <a class="code" href="classCopleyMotionLibrary.html">CopleyMotionLibrary</a>::<a class="code" href="classCopleyMotionLibrary.html">CopleyMotionLibrary</a>()<a name="l00038"></a>00038 {<a name="l00039"></a>00039 debugLevel = <a class="code" href="CML_8h.html#a8a1">LOG_NONE</a>;<a name="l00040"></a>00040 logFileName = 0;<a name="l00041"></a>00041 logFileBackup = 0;<a name="l00042"></a>00042 log = 0;<a name="l00043"></a>00043 logSize = 0;<a name="l00044"></a>00044 flushOutput = <span class="keyword">false</span>;<a name="l00045"></a>00045 destroyed = <span class="keyword">false</span>;<a name="l00046"></a>00046 maxLogSize = 1000000;<a name="l00047"></a>00047 <a name="l00048"></a>00048 SetLogFile( <span class="stringliteral">"cml.log"</span> );<a name="l00049"></a>00049 }<a name="l00050"></a>00050 <a name="l00051"></a>00051 <span class="comment">/***************************************************************************/</span><span class="comment"></span><a name="l00052"></a>00052 <span class="comment">/**</span><a name="l00053"></a>00053 <span class="comment">Destructor for CopleyMotionLibrary object. This simply closes the log file</span><a name="l00054"></a>00054 <span class="comment">if one is open.</span><a name="l00055"></a>00055 <span class="comment">*/</span><a name="l00056"></a>00056 <span class="comment">/***************************************************************************/</span><a name="l00057"></a><a class="code" href="classCopleyMotionLibrary.html#a1">00057</a> <a class="code" href="classCopleyMotionLibrary.html#a1">CopleyMotionLibrary::~CopleyMotionLibrary</a>()<a name="l00058"></a>00058 {<a name="l00059"></a>00059 <span class="preprocessor">#ifdef CML_FILE_ACCESS_OK</span><a name="l00060"></a>00060 <span class="preprocessor"></span> mutex.<a class="code" href="classMutex.html#a2">Lock</a>();<a name="l00061"></a>00061 <span class="keywordflow">if</span>( log )<a name="l00062"></a>00062 {<a name="l00063"></a>00063 fclose( (FILE*)log );<a name="l00064"></a>00064 log = NULL;<a name="l00065"></a>00065 destroyed = <span class="keyword">true</span>;<a name="l00066"></a>00066 }<a name="l00067"></a>00067 <a name="l00068"></a>00068 <span class="keywordflow">if</span>( logFileBackup )<a name="l00069"></a>00069 {<a name="l00070"></a>00070 <span class="keyword">delete</span> logFileBackup;<a name="l00071"></a>00071 logFileBackup = 0;<a name="l00072"></a>00072 }<a name="l00073"></a>00073 <a name="l00074"></a>00074 <span class="keywordflow">if</span>( logFileName )<a name="l00075"></a>00075 {<a name="l00076"></a>00076 <span class="keyword">delete</span> logFileName;<a name="l00077"></a>00077 logFileName = 0;<a name="l00078"></a>00078 }<a name="l00079"></a>00079 <a name="l00080"></a>00080 mutex.<a class="code" href="classMutex.html#a3">Unlock</a>();<a name="l00081"></a>00081 <span class="preprocessor">#endif</span><a name="l00082"></a>00082 <span class="preprocessor"></span>}<a name="l00083"></a>00083 <a name="l00084"></a>00084 <span class="comment">/***************************************************************************/</span><span class="comment"></span><a name="l00085"></a>00085 <span class="comment">/**</span><a name="l00086"></a>00086 <span class="comment">Get the CML library version string.</span><a name="l00087"></a>00087 <span class="comment">*/</span><a name="l00088"></a>00088 <span class="comment">/***************************************************************************/</span><a name="l00089"></a><a class="code" href="classCopleyMotionLibrary.html#a2">00089</a> <span class="keyword">const</span> <span class="keywordtype">char</span> *<a class="code" href="classCopleyMotionLibrary.html#a2">CopleyMotionLibrary::GetVersionString</a>( <span class="keywordtype">void</span> )<a name="l00090"></a>00090 {<a name="l00091"></a>00091 <span class="keywordflow">return</span> <span class="stringliteral">"1.12.00"</span>;<a name="l00092"></a>00092 }<a name="l00093"></a>00093 <a name="l00094"></a>00094 <span class="comment">/***************************************************************************/</span><span class="comment"></span><a name="l00095"></a>00095 <span class="comment">/**</span><a name="l00096"></a>00096 <span class="comment">Set the debug message level. The library code includes some debug messages</span><a name="l00097"></a>00097 <span class="comment">that may be enabled by setting the debug level to a value greater then LOG_NONE.</span><a name="l00098"></a>00098 <span class="comment"></span><a name="l00099"></a>00099 <span class="comment">If the level was previously set higher then LOG_NONE, and is then set to LOG_NONE, any</span><a name="l00100"></a>00100 <span class="comment">open log file will be closed.</span><a name="l00101"></a>00101 <span class="comment"></span><a name="l00102"></a>00102 <span class="comment">The default log level is LOG_NONE (no messages).</span><a name="l00103"></a>00103 <span class="comment"></span><a name="l00104"></a>00104 <span class="comment">@param level The log level. </span><a name="l00105"></a>00105 <span class="comment">*/</span><a name="l00106"></a>00106 <span class="comment">/***************************************************************************/</span><a name="l00107"></a>00107 <a name="l00108"></a><a class="code" href="classCopleyMotionLibrary.html#a3">00108</a> <span class="keywordtype">void</span> <a class="code" href="classCopleyMotionLibrary.html#a3">CopleyMotionLibrary::SetDebugLevel</a>( <a class="code" href="CML_8h.html#a8">CML_LOG_LEVEL</a> level )<a name="l00109"></a>00109 {<a name="l00110"></a>00110 debugLevel = level;<a name="l00111"></a>00111 <a name="l00112"></a>00112 <span class="preprocessor">#ifdef CML_FILE_ACCESS_OK</span><a name="l00113"></a>00113 <span class="preprocessor"></span> mutex.<a class="code" href="classMutex.html#a2">Lock</a>();<a name="l00114"></a>00114 <span class="keywordflow">if</span>( !level && log )<a name="l00115"></a>00115 {<a name="l00116"></a>00116 fclose( (FILE*)log );<a name="l00117"></a>00117 log = NULL;<a name="l00118"></a>00118 }<a name="l00119"></a>00119 mutex.<a class="code" href="classMutex.html#a3">Unlock</a>();<a name="l00120"></a>00120 <span class="preprocessor">#endif</span><a name="l00121"></a>00121 <span class="preprocessor"></span>}<a name="l00122"></a>00122 <a name="l00123"></a>00123 <span class="comment">/***************************************************************************/</span><span class="comment"></span><a name="l00124"></a>00124 <span class="comment">/**</span><a name="l00125"></a>00125 <span class="comment"> Enable/Disable the flushing of the log file after each write. This can be</span><a name="l00126"></a>00126 <span class="comment"> useful if debug messages are being lost due to a crash, however it can </span><a name="l00127"></a>00127 <span class="comment"> increase the time necessary to write to the file.</span><a name="l00128"></a>00128 <span class="comment"></span><a name="l00129"></a>00129 <span class="comment"> The default is false (don't flush).</span><a name="l00130"></a>00130 <span class="comment"></span><a name="l00131"></a>00131 <span class="comment"> @param flush True if file flushing is desired</span><a name="l00132"></a>00132 <span class="comment"> */</span><a name="l00133"></a>00133 <span class="comment">/***************************************************************************/</span><a name="l00134"></a><a class="code" href="classCopleyMotionLibrary.html#a4">00134</a> <span class="keywordtype">void</span> <a class="code" href="classCopleyMotionLibrary.html#a4">CopleyMotionLibrary::SetFlushLog</a>( <span class="keywordtype">bool</span> flush )<a name="l00135"></a>00135 {<a name="l00136"></a>00136 flushOutput = flush;<a name="l00137"></a>00137 }<a name="l00138"></a>00138 <a name="l00139"></a>00139 <span class="comment">/***************************************************************************/</span><span class="comment"></span><a name="l00140"></a>00140 <span class="comment">/**</span><a name="l00141"></a>00141 <span class="comment">Flush the log file (if one is open). This forces the log contents to be</span><a name="l00142"></a>00142 <span class="comment">written to disk, thus preventing it from being lost if the program exits</span><a name="l00143"></a>00143 <span class="comment">without calling the CML object destructor.</span><a name="l00144"></a>00144 <span class="comment">*/</span><a name="l00145"></a>00145 <span class="comment">/***************************************************************************/</span><a name="l00146"></a><a class="code" href="classCopleyMotionLibrary.html#a6">00146</a> <span class="keywordtype">void</span> <a class="code" href="classCopleyMotionLibrary.html#a6">CopleyMotionLibrary::FlushLog</a>( <span class="keywordtype">void</span> )<a name="l00147"></a>00147 {<a name="l00148"></a>00148 <span class="preprocessor">#ifdef CML_FILE_ACCESS_OK</span><a name="l00149"></a>00149 <span class="preprocessor"></span> mutex.<a class="code" href="classMutex.html#a2">Lock</a>();<a name="l00150"></a>00150 <span class="keywordflow">if</span>( log )<a name="l00151"></a>00151 fflush( (FILE*)log );<a name="l00152"></a>00152 mutex.<a class="code" href="classMutex.html#a3">Unlock</a>();<a name="l00153"></a>00153 <span class="preprocessor">#endif</span>⌨️ 快捷键说明
复制代码
Ctrl + C
搜索代码
Ctrl + F
全屏模式
F11
切换主题
Ctrl + Shift + D
显示快捷键
?
增大字号
Ctrl + =
减小字号
Ctrl + -