classcopleymotionlibrary.html

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

    <td>
      &nbsp;
    </td>
    <td>

<p>
Return the name of the log file. 
<p>
<dl compact><dt><b>Returns:</b></dt><dd>The log file name as a zero terminated string </dd></dl>

<p>
Definition at line <a class="el" href="CML_8h-source.html#l00129">129</a> of file <a class="el" href="CML_8h-source.html">CML.h</a>.    </td>
  </tr>
</table>
<a class="anchor" name="a14"></a><!-- doxytag: member="CopleyMotionLibrary::GetMaxLogSize" ref="a14" args="(void)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
  <tr>
    <td class="mdRow">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top"><a class="el" href="CML__Utils_8h.html#a9">int32</a> GetMaxLogSize           </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top">void&nbsp;</td>
          <td class="mdname1" valign="top" nowrap>          </td>
          <td class="md" valign="top">&nbsp;)&nbsp;</td>
          <td class="md" nowrap><code> [inline]</code></td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Return the max log size. 
<p>
<dl compact><dt><b>Returns:</b></dt><dd>The max log size in bytes </dd></dl>

<p>
Definition at line <a class="el" href="CML_8h-source.html#l00125">125</a> of file <a class="el" href="CML_8h-source.html">CML.h</a>.    </td>
  </tr>
</table>
<a class="anchor" name="a11"></a><!-- doxytag: member="CopleyMotionLibrary::LogCAN" ref="a11" args="(bool recv, struct CanFrame &amp;frame)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
  <tr>
    <td class="mdRow">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top">void LogCAN           </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top">bool&nbsp;</td>
          <td class="mdname" nowrap> <em>recv</em>, </td>
        </tr>
        <tr>
          <td class="md" nowrap align="right"></td>
          <td class="md"></td>
          <td class="md" nowrap>struct <a class="el" href="structCanFrame.html">CanFrame</a> &amp;&nbsp;</td>
          <td class="mdname" nowrap> <em>frame</em></td>
        </tr>
        <tr>
          <td class="md"></td>
          <td class="md">)&nbsp;</td>
          <td class="md" colspan="2"></td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Write the CAN frame to the log file. 
<p>
The log level must be at least LOG_FILT_CAN for this to be written.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>recv</em>&nbsp;</td><td>True if this was a received message, false for transmit messages </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>frame</em>&nbsp;</td><td>The frame to log</td></tr>
  </table>
</dl>

<p>
Definition at line <a class="el" href="CML_8cpp-source.html#l00230">230</a> of file <a class="el" href="CML_8cpp-source.html">CML.cpp</a>.    </td>
  </tr>
</table>
<a class="anchor" name="a3"></a><!-- doxytag: member="CopleyMotionLibrary::SetDebugLevel" ref="a3" args="(CML_LOG_LEVEL level)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
  <tr>
    <td class="mdRow">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top">void SetDebugLevel           </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top"><a class="el" href="CML_8h.html#a8">CML_LOG_LEVEL</a>&nbsp;</td>
          <td class="mdname1" valign="top" nowrap> <em>level</em>          </td>
          <td class="md" valign="top">&nbsp;)&nbsp;</td>
          <td class="md" nowrap></td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Set the debug message level. 
<p>
The library code includes some debug messages that may be enabled by setting the debug level to a value greater then LOG_NONE.<p>
If the level was previously set higher then LOG_NONE, and is then set to LOG_NONE, any open log file will be closed.<p>
The default log level is LOG_NONE (no messages).<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>level</em>&nbsp;</td><td>The log level.</td></tr>
  </table>
</dl>

<p>
Definition at line <a class="el" href="CML_8cpp-source.html#l00108">108</a> of file <a class="el" href="CML_8cpp-source.html">CML.cpp</a>.    </td>
  </tr>
</table>
<a class="anchor" name="a4"></a><!-- doxytag: member="CopleyMotionLibrary::SetFlushLog" ref="a4" args="(bool flush)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
  <tr>
    <td class="mdRow">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top">void SetFlushLog           </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top">bool&nbsp;</td>
          <td class="mdname1" valign="top" nowrap> <em>flush</em>          </td>
          <td class="md" valign="top">&nbsp;)&nbsp;</td>
          <td class="md" nowrap></td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Enable/Disable the flushing of the log file after each write. 
<p>
This can be useful if debug messages are being lost due to a crash, however it can increase the time necessary to write to the file.<p>
The default is false (don't flush).<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>flush</em>&nbsp;</td><td>True if file flushing is desired</td></tr>
  </table>
</dl>

<p>
Definition at line <a class="el" href="CML_8cpp-source.html#l00134">134</a> of file <a class="el" href="CML_8cpp-source.html">CML.cpp</a>.    </td>
  </tr>
</table>
<a class="anchor" name="a7"></a><!-- doxytag: member="CopleyMotionLibrary::SetLogFile" ref="a7" args="(const char *fname)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
  <tr>
    <td class="mdRow">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top">void SetLogFile           </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top">const char *&nbsp;</td>
          <td class="mdname1" valign="top" nowrap> <em>fname</em>          </td>
          <td class="md" valign="top">&nbsp;)&nbsp;</td>
          <td class="md" nowrap></td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Set the debug message log file name. 
<p>
This file will be used to log debug messages. The file will be created (or truncated if it alread exists) when the first message is written to the file. Note that the debug level must be set &gt; LOG_NONE for any messages to be written. Also note that file access must be enabled in <a class="el" href="CML__Settings_8h.html">CML_Settings.h</a> for the log file to be used.<p>
If the log file is already open when this method is called, it will be closed and a new log file with the specified name will be open on the next write to it.<p>
The default log file name is "cml.log"<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>fname</em>&nbsp;</td><td>The log file name</td></tr>
  </table>
</dl>

<p>
Definition at line <a class="el" href="CML_8cpp-source.html#l00172">172</a> of file <a class="el" href="CML_8cpp-source.html">CML.cpp</a>.    </td>
  </tr>
</table>
<a class="anchor" name="a5"></a><!-- doxytag: member="CopleyMotionLibrary::SetMaxLogSize" ref="a5" args="(int32 max)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
  <tr>
    <td class="mdRow">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top">void SetMaxLogSize           </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top"><a class="el" href="CML__Utils_8h.html#a9">int32</a>&nbsp;</td>
          <td class="mdname1" valign="top" nowrap> <em>max</em>          </td>
          <td class="md" valign="top">&nbsp;)&nbsp;</td>
          <td class="md" nowrap></td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Set the max CML log file size. 
<p>
This option can be used to prevent a debug log file from getting so large it uses all available disk space on long runs. Once the log file exceeds this size, it will be renamed logfilename.bak (where logfilename is replaced by the log file name), and a new log file will be started. Any old backup log file will be overwritten.<p>
The default max log size is 1,000,000 bytes.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>max</em>&nbsp;</td><td>Maximum log file size in bytes</td></tr>
  </table>
</dl>

<p>
Definition at line <a class="el" href="CML_8cpp-source.html#l00216">216</a> of file <a class="el" href="CML_8cpp-source.html">CML.cpp</a>.    </td>
  </tr>
</table>
<a class="anchor" name="a9"></a><!-- doxytag: member="CopleyMotionLibrary::Warn" ref="a9" args="(const char *fmt,...)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
  <tr>
    <td class="mdRow">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top">void Warn           </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top">const char *&nbsp;</td>
          <td class="mdname" nowrap> <em>fmt</em>, </td>
        </tr>
        <tr>
          <td class="md" nowrap align="right"></td>
          <td class="md"></td>
          <td class="md" nowrap>&nbsp;</td>
          <td class="mdname" nowrap> <em>...</em></td>
        </tr>
        <tr>
          <td class="md"></td>
          <td class="md">)&nbsp;</td>
          <td class="md" colspan="2"></td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Write a warning message to the log file. 
<p>
The debug level must be set &gt;= LOG_WARNINGS for this message to be written.<p>
Note that message logging is only available if file support is enabled in the <a class="el" href="CML__Settings_8h.html">CML_Settings.h</a> file.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>fmt</em>&nbsp;</td><td>A printf style format string</td></tr>
  </table>
</dl>

<p>
Definition at line <a class="el" href="CML_8cpp-source.html#l00336">336</a> of file <a class="el" href="CML_8cpp-source.html">CML.cpp</a>.    </td>
  </tr>
</table>
<hr>The documentation for this class was generated from the following files:<ul>
<li><a class="el" href="CML_8h-source.html">CML.h</a><li><a class="el" href="CML_8cpp-source.html">CML.cpp</a></ul>
<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>