cml_8h-source.html

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

<a name="l00071"></a>00071 <span class="comment"></span>   <a class="code" href="CML_8h.html#a8a2">LOG_ERRORS</a>     = 1,   <span class="comment">///&lt; Log serious errors only</span>
<a name="l00072"></a>00072 <span class="comment"></span>   <a class="code" href="CML_8h.html#a8a3">LOG_WARNINGS</a>   = 2,   <span class="comment">///&lt; Log warning messages and errors</span>
<a name="l00073"></a>00073 <span class="comment"></span>   <a class="code" href="CML_8h.html#a8a4">LOG_DEBUG</a>      = 3,   <span class="comment">///&lt; Log some debugging info</span>
<a name="l00074"></a>00074 <span class="comment"></span>   <a class="code" href="CML_8h.html#a8a5">LOG_FILT_CAN</a>   = 5,   <span class="comment">///&lt; Log most CAN messages.  A few common messages are filtered out.</span>
<a name="l00075"></a>00075 <span class="comment"></span>   <a class="code" href="CML_8h.html#a8a6">LOG_CAN</a>        = 6,   <span class="comment">///&lt; Log all CAN messages</span>
<a name="l00076"></a><a class="code" href="CML_8h.html#a8a7">00076</a> <span class="comment"></span>   <a class="code" href="CML_8h.html#a8a7">LOG_EVERYTHING</a> = 99   <span class="comment">///&lt; Log everything</span>
<a name="l00077"></a>00077 <span class="comment"></span>};
<a name="l00078"></a>00078 
<a name="l00079"></a>00079 <span class="comment">/***************************************************************************/</span><span class="comment"></span>
<a name="l00080"></a>00080 <span class="comment">/**</span>
<a name="l00081"></a>00081 <span class="comment">Copley Motion Libraries utility object.</span>
<a name="l00082"></a>00082 <span class="comment"></span>
<a name="l00083"></a>00083 <span class="comment">This object defines a number of handy methods related to the libraries</span>
<a name="l00084"></a>00084 <span class="comment">as a whole.</span>
<a name="l00085"></a>00085 <span class="comment"></span>
<a name="l00086"></a>00086 <span class="comment">A single global CML object is created by the libraries automatically.</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">00089</a> <span class="keyword">class </span><a class="code" href="classCopleyMotionLibrary.html">CopleyMotionLibrary</a>
<a name="l00090"></a>00090 {
<a name="l00091"></a>00091    <span class="keywordtype">char</span> *logFileName;
<a name="l00092"></a>00092    <span class="keywordtype">char</span> *logFileBackup;
<a name="l00093"></a>00093    <a class="code" href="CML_8h.html#a8">CML_LOG_LEVEL</a> debugLevel;
<a name="l00094"></a>00094    <span class="keywordtype">bool</span> flushOutput;
<a name="l00095"></a>00095    <span class="keywordtype">bool</span> destroyed;
<a name="l00096"></a>00096    <a class="code" href="classMutex.html">Mutex</a> mutex;
<a name="l00097"></a>00097    <span class="keywordtype">void</span> *log;
<a name="l00098"></a>00098    <a class="code" href="CML__Utils_8h.html#a9">int32</a> logSize, maxLogSize;
<a name="l00099"></a>00099    <span class="keywordtype">bool</span> OpenLogFile( <span class="keywordtype">void</span> );
<a name="l00100"></a>00100    <span class="keywordtype">void</span> ResizeLog( <span class="keywordtype">void</span> );
<a name="l00101"></a>00101 <span class="keyword">public</span>:
<a name="l00102"></a>00102    <a class="code" href="classCopleyMotionLibrary.html#a0">CopleyMotionLibrary</a>();
<a name="l00103"></a>00103    <a class="code" href="classCopleyMotionLibrary.html#a1">~CopleyMotionLibrary</a>();
<a name="l00104"></a>00104    <span class="keyword">const</span> <span class="keywordtype">char</span> *<a class="code" href="classCopleyMotionLibrary.html#a2">GetVersionString</a>();
<a name="l00105"></a>00105    <span class="keywordtype">void</span> <a class="code" href="classCopleyMotionLibrary.html#a3">SetDebugLevel</a>( <a class="code" href="CML_8h.html#a8">CML_LOG_LEVEL</a> level );
<a name="l00106"></a>00106    <span class="keywordtype">void</span> <a class="code" href="classCopleyMotionLibrary.html#a4">SetFlushLog</a>( <span class="keywordtype">bool</span> flush );
<a name="l00107"></a>00107    <span class="keywordtype">void</span> <a class="code" href="classCopleyMotionLibrary.html#a5">SetMaxLogSize</a>( <a class="code" href="CML__Utils_8h.html#a9">int32</a> max );
<a name="l00108"></a>00108    <span class="keywordtype">void</span> <a class="code" href="classCopleyMotionLibrary.html#a6">FlushLog</a>( <span class="keywordtype">void</span> );
<a name="l00109"></a>00109    <span class="keywordtype">void</span> <a class="code" href="classCopleyMotionLibrary.html#a7">SetLogFile</a>( <span class="keyword">const</span> <span class="keywordtype">char</span> *fname );
<a name="l00110"></a>00110    <span class="keywordtype">void</span> <a class="code" href="classCopleyMotionLibrary.html#a8">Debug</a>( <span class="keyword">const</span> <span class="keywordtype">char</span> *fmt, ... );
<a name="l00111"></a>00111    <span class="keywordtype">void</span> <a class="code" href="classCopleyMotionLibrary.html#a9">Warn</a>( <span class="keyword">const</span> <span class="keywordtype">char</span> *fmt, ... );
<a name="l00112"></a>00112    <span class="keywordtype">void</span> <a class="code" href="classCopleyMotionLibrary.html#a10">Error</a>( <span class="keyword">const</span> <span class="keywordtype">char</span> *fmt, ... );
<a name="l00113"></a>00113    <span class="keywordtype">void</span> <a class="code" href="classCopleyMotionLibrary.html#a11">LogCAN</a>( <span class="keywordtype">bool</span> recv, <span class="keyword">struct</span> <a class="code" href="structCanFrame.html">CanFrame</a> &amp;frame );
<a name="l00114"></a>00114 <span class="comment"></span>
<a name="l00115"></a>00115 <span class="comment">   /// Return the debug level </span>
<a name="l00116"></a>00116 <span class="comment">   /// @return The debug level presently set</span>
<a name="l00117"></a><a class="code" href="classCopleyMotionLibrary.html#a12">00117</a> <span class="comment"></span>   <a class="code" href="CML_8h.html#a8">CML_LOG_LEVEL</a> <a class="code" href="classCopleyMotionLibrary.html#a12">GetDebugLevel</a>( <span class="keywordtype">void</span> ){ <span class="keywordflow">return</span> debugLevel; }
<a name="l00118"></a>00118 <span class="comment"></span>
<a name="l00119"></a>00119 <span class="comment">   /// Get the state of the log flushing setting.</span>
<a name="l00120"></a>00120 <span class="comment">   /// @return true if enabled.</span>
<a name="l00121"></a><a class="code" href="classCopleyMotionLibrary.html#a13">00121</a> <span class="comment"></span>   <span class="keywordtype">bool</span> <a class="code" href="classCopleyMotionLibrary.html#a13">GetFlushLog</a>( <span class="keywordtype">void</span> ){ <span class="keywordflow">return</span> flushOutput; }
<a name="l00122"></a>00122 <span class="comment"></span>
<a name="l00123"></a>00123 <span class="comment">   /// Return the max log size.</span>
<a name="l00124"></a>00124 <span class="comment">   /// @return The max log size in bytes</span>
<a name="l00125"></a><a class="code" href="classCopleyMotionLibrary.html#a14">00125</a> <span class="comment"></span>   <a class="code" href="CML__Utils_8h.html#a9">int32</a> <a class="code" href="classCopleyMotionLibrary.html#a14">GetMaxLogSize</a>( <span class="keywordtype">void</span> ){ <span class="keywordflow">return</span> maxLogSize; }
<a name="l00126"></a>00126 <span class="comment"></span>
<a name="l00127"></a>00127 <span class="comment">   /// Return the name of the log file</span>
<a name="l00128"></a>00128 <span class="comment">   /// @return The log file name as a zero terminated string</span>
<a name="l00129"></a><a class="code" href="classCopleyMotionLibrary.html#a15">00129</a> <span class="comment"></span>   <span class="keyword">const</span> <span class="keywordtype">char</span> *<a class="code" href="classCopleyMotionLibrary.html#a15">GetLogFile</a>( <span class="keywordtype">void</span> ){ <span class="keywordflow">return</span> logFileName; }
<a name="l00130"></a>00130 };
<a name="l00131"></a>00131 <span class="comment"></span>
<a name="l00132"></a>00132 <span class="comment">/// Global CML object</span>
<a name="l00133"></a>00133 <span class="comment"></span><span class="keyword">extern</span> <a class="code" href="classCopleyMotionLibrary.html">CopleyMotionLibrary</a> <a class="code" href="CML_8h.html#a0">cml</a>;
<a name="l00134"></a>00134 
<a name="l00135"></a>00135 <a class="code" href="CML__Settings_8h.html#a12">CML_NAMESPACE_END</a>()
<a name="l00136"></a>00136 
<a name="l00137"></a>00137 #endif
<a name="l00138"></a>00138 
</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>