cml_8cpp-source.html

美国COPLEY驱动器,程序开发工具之一.

<a name="l00154"></a>00154 <span class="preprocessor"></span>}
<a name="l00155"></a>00155 
<a name="l00156"></a>00156 <span class="comment">/***************************************************************************/</span><span class="comment"></span>
<a name="l00157"></a>00157 <span class="comment">/**</span>
<a name="l00158"></a>00158 <span class="comment">Set the debug message log file name.  This file will be used to log </span>
<a name="l00159"></a>00159 <span class="comment">debug messages.  The file will be created (or truncated if it alread exists)</span>
<a name="l00160"></a>00160 <span class="comment">when the first message is written to the file.  Note that the debug level </span>
<a name="l00161"></a>00161 <span class="comment">must be set &gt; LOG_NONE for any messages to be written.  Also note that file access</span>
<a name="l00162"></a>00162 <span class="comment">must be enabled in CML_Settings.h for the log file to be used.</span>
<a name="l00163"></a>00163 <span class="comment"></span>
<a name="l00164"></a>00164 <span class="comment">If the log file is already open when this method is called, it will be closed</span>
<a name="l00165"></a>00165 <span class="comment">and a new log file with the specified name will be open on the next write to it.</span>
<a name="l00166"></a>00166 <span class="comment"></span>
<a name="l00167"></a>00167 <span class="comment">The default log file name is "cml.log"</span>
<a name="l00168"></a>00168 <span class="comment"></span>
<a name="l00169"></a>00169 <span class="comment">@param fname The log file name</span>
<a name="l00170"></a>00170 <span class="comment">*/</span>
<a name="l00171"></a>00171 <span class="comment">/***************************************************************************/</span>
<a name="l00172"></a><a class="code" href="classCopleyMotionLibrary.html#a7">00172</a> <span class="keywordtype">void</span> <a class="code" href="classCopleyMotionLibrary.html#a7">CopleyMotionLibrary::SetLogFile</a>( <span class="keyword">const</span> <span class="keywordtype">char</span> *fname )
<a name="l00173"></a>00173 {
<a name="l00174"></a>00174 <span class="preprocessor">#ifdef CML_FILE_ACCESS_OK</span>
<a name="l00175"></a>00175 <span class="preprocessor"></span>   <span class="keywordflow">if</span>( destroyed ) <span class="keywordflow">return</span>;
<a name="l00176"></a>00176 
<a name="l00177"></a>00177    <span class="keywordflow">if</span>( logFileName )
<a name="l00178"></a>00178    {
<a name="l00179"></a>00179       <span class="keyword">delete</span> logFileName;
<a name="l00180"></a>00180       logFileName = 0;
<a name="l00181"></a>00181    }
<a name="l00182"></a>00182 
<a name="l00183"></a>00183    logFileName = <span class="keyword">new</span> <span class="keywordtype">char</span>[ strlen(fname) + 1 ];
<a name="l00184"></a>00184    strcpy( logFileName, fname );
<a name="l00185"></a>00185 
<a name="l00186"></a>00186    <span class="keywordflow">if</span>( logFileBackup )
<a name="l00187"></a>00187    {
<a name="l00188"></a>00188       <span class="keyword">delete</span> logFileBackup;
<a name="l00189"></a>00189       logFileBackup = 0;
<a name="l00190"></a>00190    }
<a name="l00191"></a>00191 
<a name="l00192"></a>00192    logFileBackup = <span class="keyword">new</span> <span class="keywordtype">char</span>[ strlen(logFileName) + 5 ];
<a name="l00193"></a>00193    strcpy( logFileBackup, logFileName );
<a name="l00194"></a>00194    strcat( logFileBackup, <span class="stringliteral">".bak"</span> );
<a name="l00195"></a>00195 
<a name="l00196"></a>00196    <span class="comment">// If the log is open, close it so that next time it </span>
<a name="l00197"></a>00197    <span class="comment">// is written to a new log with the proper name will</span>
<a name="l00198"></a>00198    <span class="comment">// be created.</span>
<a name="l00199"></a>00199    ResizeLog();
<a name="l00200"></a>00200 <span class="preprocessor">#endif</span>
<a name="l00201"></a>00201 <span class="preprocessor"></span>}
<a name="l00202"></a>00202 
<a name="l00203"></a>00203 <span class="comment">/***************************************************************************/</span><span class="comment"></span>
<a name="l00204"></a>00204 <span class="comment">/**</span>
<a name="l00205"></a>00205 <span class="comment">Set the max CML log file size.  This option can be used to prevent a debug</span>
<a name="l00206"></a>00206 <span class="comment">log file from getting so large it uses all available disk space on long runs.</span>
<a name="l00207"></a>00207 <span class="comment">Once the log file exceeds this size, it will be renamed logfilename.bak (where</span>
<a name="l00208"></a>00208 <span class="comment">logfilename is replaced by the log file name), and a new log file will be </span>
<a name="l00209"></a>00209 <span class="comment">started.  Any old backup log file will be overwritten.</span>
<a name="l00210"></a>00210 <span class="comment"></span>
<a name="l00211"></a>00211 <span class="comment">The default max log size is 1,000,000 bytes.</span>
<a name="l00212"></a>00212 <span class="comment"></span>
<a name="l00213"></a>00213 <span class="comment">@param max Maximum log file size in bytes</span>
<a name="l00214"></a>00214 <span class="comment">*/</span>
<a name="l00215"></a>00215 <span class="comment">/***************************************************************************/</span>
<a name="l00216"></a><a class="code" href="classCopleyMotionLibrary.html#a5">00216</a> <span class="keywordtype">void</span> <a class="code" href="classCopleyMotionLibrary.html#a5">CopleyMotionLibrary::SetMaxLogSize</a>( <a class="code" href="CML__Utils_8h.html#a9">int32</a> max )
<a name="l00217"></a>00217 {
<a name="l00218"></a>00218    maxLogSize = max;
<a name="l00219"></a>00219 }
<a name="l00220"></a>00220 
<a name="l00221"></a>00221 <span class="comment">/***************************************************************************/</span><span class="comment"></span>
<a name="l00222"></a>00222 <span class="comment">/**</span>
<a name="l00223"></a>00223 <span class="comment">Write the CAN frame to the log file.  The log level must be at least LOG_FILT_CAN</span>
<a name="l00224"></a>00224 <span class="comment">for this to be written.</span>
<a name="l00225"></a>00225 <span class="comment"></span>
<a name="l00226"></a>00226 <span class="comment">@param recv True if this was a received message, false for transmit messages</span>
<a name="l00227"></a>00227 <span class="comment">@param frame The frame to log</span>
<a name="l00228"></a>00228 <span class="comment">*/</span>
<a name="l00229"></a>00229 <span class="comment">/***************************************************************************/</span>
<a name="l00230"></a><a class="code" href="classCopleyMotionLibrary.html#a11">00230</a> <span class="keywordtype">void</span> <a class="code" href="classCopleyMotionLibrary.html#a11">CopleyMotionLibrary::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="l00231"></a>00231 {
<a name="l00232"></a>00232 <span class="preprocessor">#ifdef CML_FILE_ACCESS_OK</span>
<a name="l00233"></a>00233 <span class="preprocessor"></span>   <span class="keywordflow">if</span>( debugLevel &lt; <a class="code" href="CML_8h.html#a8a5">LOG_FILT_CAN</a> ) <span class="keywordflow">return</span>;
<a name="l00234"></a>00234 
<a name="l00235"></a>00235    <span class="comment">// Debug level LOG_FILT_CAN filters out some CAN messages</span>
<a name="l00236"></a>00236    <span class="keywordflow">if</span>( debugLevel &lt; <a class="code" href="CML_8h.html#a8a6">LOG_CAN</a> )
<a name="l00237"></a>00237    {
<a name="l00238"></a>00238       <span class="keywordflow">if</span>( frame.<a class="code" href="structCanFrame.html#o1">id</a> == 0x080 ) <span class="keywordflow">return</span>;
<a name="l00239"></a>00239       <span class="keywordflow">if</span>( frame.<a class="code" href="structCanFrame.html#o1">id</a> == 0x180 ) <span class="keywordflow">return</span>;
<a name="l00240"></a>00240       <span class="keywordflow">if</span>( (frame.<a class="code" href="structCanFrame.html#o1">id</a> &gt; 0x700) &amp;&amp; (frame.<a class="code" href="structCanFrame.html#o1">id</a> &lt; 0x780) ) <span class="keywordflow">return</span>;
<a name="l00241"></a>00241    }
<a name="l00242"></a>00242 
<a name="l00243"></a>00243    <span class="comment">// Return immediately if the log file can't be open</span>
<a name="l00244"></a>00244    <span class="keywordflow">if</span>( !OpenLogFile() ) <span class="keywordflow">return</span>;
<a name="l00245"></a>00245 
<a name="l00246"></a>00246    <span class="comment">// Log a message describing the CAN frame</span>
<a name="l00247"></a>00247    <span class="keywordflow">switch</span>( frame.<a class="code" href="structCanFrame.html#o0">type</a> )
<a name="l00248"></a>00248    {
<a name="l00249"></a>00249       <span class="keywordflow">case</span> <a class="code" href="CML__Can_8h.html#a3a0">CAN_FRAME_DATA</a>:
<a name="l00250"></a>00250       {
<a name="l00251"></a>00251     <span class="keywordflow">if</span>( recv )
<a name="l00252"></a>00252        logSize += fprintf( (FILE *)log, <span class="stringliteral">"CAN.R: 0x%08x - "</span>, frame.<a class="code" href="structCanFrame.html#o1">id</a> );
<a name="l00253"></a>00253     <span class="keywordflow">else</span>
<a name="l00254"></a>00254        logSize += fprintf( (FILE *)log, <span class="stringliteral">"CAN.X: 0x%08x - "</span>, frame.<a class="code" href="structCanFrame.html#o1">id</a> );
<a name="l00255"></a>00255 
<a name="l00256"></a>00256     <span class="keywordflow">for</span>( <span class="keywordtype">int</span> i=0; i&lt;frame.<a class="code" href="structCanFrame.html#o2">length</a>; i++ )
<a name="l00257"></a>00257        logSize += fprintf( (FILE *)log, <span class="stringliteral">"0x%02x "</span>, frame.<a class="code" href="structCanFrame.html#o3">data</a>[i] );
<a name="l00258"></a>00258 
<a name="l00259"></a>00259     logSize += fprintf( (FILE *)log, <span class="stringliteral">"\n"</span> );
<a name="l00260"></a>00260     <span class="keywordflow">break</span>;
<a name="l00261"></a>00261       }
<a name="l00262"></a>00262 
<a name="l00263"></a>00263       <span class="keywordflow">case</span> <a class="code" href="CML__Can_8h.html#a3a1">CAN_FRAME_REMOTE</a>:
<a name="l00264"></a>00264     <span class="keywordflow">if</span>( recv )
<a name="l00265"></a>00265        logSize += fprintf( (FILE *)log, <span class="stringliteral">"CAN.R: 0x%08x - RMT\n"</span>, frame.<a class="code" href="structCanFrame.html#o1">id</a> );
<a name="l00266"></a>00266     <span class="keywordflow">else</span>
<a name="l00267"></a>00267        logSize += fprintf( (FILE *)log, <span class="stringliteral">"CAN.X: 0x%08x - RMT\n"</span>, frame.<a class="code" href="structCanFrame.html#o1">id</a> );
<a name="l00268"></a>00268     <span class="keywordflow">break</span>;
<a name="l00269"></a>00269 
<a name="l00270"></a>00270       <span class="keywordflow">case</span> <a class="code" href="CML__Can_8h.html#a3a2">CAN_FRAME_ERROR</a>:
<a name="l00271"></a>00271     logSize += fprintf( (FILE*)log, <span class="stringliteral">"CAN Error frame\n"</span> );
<a name="l00272"></a>00272     <span class="keywordflow">break</span>;
<a name="l00273"></a>00273 
<a name="l00274"></a>00274       <span class="keywordflow">default</span>:
<a name="l00275"></a>00275     logSize += fprintf( (FILE*)log, <span class="stringliteral">"Unknown CAN frame type!\n"</span> );
<a name="l00276"></a>00276     <span class="keywordflow">break</span>;
<a name="l00277"></a>00277    }
<a name="l00278"></a>00278 
<a name="l00279"></a>00279    mutex.<a class="code" href="classMutex.html#a3">Unlock</a>();
<a name="l00280"></a>00280 
<a name="l00281"></a>00281    <span class="comment">// Flush the file if requested to do so</span>
<a name="l00282"></a>00282    <span class="keywordflow">if</span>( flushOutput )
<a name="l00283"></a>00283       <a class="code" href="classCopleyMotionLibrary.html#a6">FlushLog</a>();
<a name="l00284"></a>00284 
<a name="l00285"></a>00285    <span class="keywordflow">if</span>( logSize &gt; maxLogSize )
<a name="l00286"></a>00286       ResizeLog();
<a name="l00287"></a>00287 <span class="preprocessor">#endif</span>
<a name="l00288"></a>00288 <span class="preprocessor"></span>}
<a name="l00289"></a>00289 
<a name="l00290"></a>00290 <span class="comment">/***************************************************************************/</span><span class="comment"></span>
<a name="l00291"></a>00291 <span class="comment">/**</span>
<a name="l00292"></a>00292 <span class="comment">Write a debug message to the log file.  The debug level must be set &gt;= LOG_DEBUG</span>
<a name="l00293"></a>00293 <span class="comment">for this message to be written.</span>
<a name="l00294"></a>00294 <span class="comment"></span>
<a name="l00295"></a>00295 <span class="comment">Note that message logging is only available if file support is enabled in </span>
<a name="l00296"></a>00296 <span class="comment">the CML_Settings.h file.</span>
<a name="l00297"></a>00297 <span class="comment"></span>
<a name="l00298"></a>00298 <span class="comment">@param fmt A printf style format string</span>
<a name="l00299"></a>00299 <span class="comment">*/</span>
<a name="l00300"></a>00300 <span class="comment">/***************************************************************************/</span>
<a name="l00301"></a><a class="code" href="classCopleyMotionLibrary.html#a8">00301</a> <span class="keywordtype">void</span> <a class="code" href="classCopleyMotionLibrary.html#a8">CopleyMotionLibrary::Debug</a>( <span class="keyword">const</span> <span class="keywordtype">char</span> *fmt, ... )
<a name="l00302"></a>00302 {
<a name="l00303"></a>00303 <span class="preprocessor">#ifdef CML_FILE_ACCESS_OK</span>
<a name="l00304"></a>00304 <span class="preprocessor"></span>   <span class="keywordflow">if</span>( debugLevel &lt; <a class="code" href="CML_8h.html#a8a4">LOG_DEBUG</a> ) <span class="keywordflow">return</span>;
<a name="l00305"></a>00305 
<a name="l00306"></a>00306    <span class="comment">// Return immediately if the log file can't be open</span>
<a name="l00307"></a>00307    <span class="keywordflow">if</span>( !OpenLogFile() ) <span class="keywordflow">return</span>;
<a name="l00308"></a>00308 
<a name="l00309"></a>00309    <span class="comment">// Write to the file.</span>
<a name="l00310"></a>00310    va_list ap;
<a name="l00311"></a>00311    va_start( ap, fmt );
<a name="l00312"></a>00312    logSize += vfprintf( (FILE *)log, fmt, ap );
<a name="l00313"></a>00313    mutex.<a class="code" href="classMutex.html#a3">Unlock</a>();
<a name="l00314"></a>00314    va_end( ap );
<a name="l00315"></a>00315