📄 classfirmware.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: Firmware Class Reference</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><h1>Firmware Class Reference</h1><!-- doxytag: class="Firmware" --><a href="classFirmware-members.html">List of all members.</a><hr><a name="_details"></a><h2>Detailed Description</h2>Copley Controls amplifier firmware object. <p>This object is used to represent a firmware file which can be uploaded to an amplifier.<p>Note that uploading firmware to the amplifier is not part of normal operation. The amplifier firmware is stored in internal Flash memory, and only needs to be updated if a new version with new features or bug fixes is produced by Copley Controls Corporation.<p><p>Definition at line <a class="el" href="CML__Firmware_8h-source.html#l00073">73</a> of file <a class="el" href="CML__Firmware_8h-source.html">CML_Firmware.h</a>.<table border="0" cellpadding="0" cellspacing="0"><tr><td></td></tr><tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="CML__Utils_8h.html#a8">uint16</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classFirmware.html#a2">getFileVersion</a> ()</td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the firmware file version number. <a href="#a2"></a><br></td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="CML__Utils_8h.html#a8">uint16</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classFirmware.html#a3">getAmpType</a> ()</td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the amplifier type for this firmware. <a href="#a3"></a><br></td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="CML__Utils_8h.html#a10">uint32</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classFirmware.html#a4">getStart</a> ()</td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the firmware starting address. <a href="#a4"></a><br></td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="CML__Utils_8h.html#a10">uint32</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classFirmware.html#a5">getLength</a> ()</td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the firmware length (in words). <a href="#a5"></a><br></td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="CML__Utils_8h.html#a8">uint16</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classFirmware.html#a6">getData</a> (void)</td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the firmware binary data. <a href="#a6"></a><br></td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classFirmware.html#a7">progress</a> (<a class="el" href="CML__Utils_8h.html#a10">uint32</a> addr)</td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">This virtual function is called repeatedly during an amplifier firmware update. <a href="#a7"></a><br></td></tr></table><hr><h2>Member Function Documentation</h2><a class="anchor" name="a3"></a><!-- doxytag: member="Firmware::getAmpType" ref="a3" args="()" --><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#a8">uint16</a> getAmpType </td> <td class="md" valign="top">( </td> <td class="mdname1" valign="top" nowrap> </td> <td class="md" valign="top"> ) </td> <td class="md" nowrap><code> [inline]</code></td> </tr> </table> </td> </tr></table><table cellspacing="5" cellpadding="0" border="0"> <tr> <td> </td> <td><p>Returns the amplifier type for this firmware. <p><dl compact><dt><b>Returns:</b></dt><dd>The amplifier type for this firmware </dd></dl><p>Definition at line <a class="el" href="CML__Firmware_8h-source.html#l00102">102</a> of file <a class="el" href="CML__Firmware_8h-source.html">CML_Firmware.h</a>. </td> </tr></table><a class="anchor" name="a6"></a><!-- doxytag: member="Firmware::getData" ref="a6" 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#a8">uint16</a>* getData </td> <td class="md" valign="top">( </td> <td class="md" nowrap valign="top">void </td> <td class="mdname1" valign="top" nowrap> </td> <td class="md" valign="top"> ) </td> <td class="md" nowrap><code> [inline]</code></td> </tr> </table> </td> </tr></table><table cellspacing="5" cellpadding="0" border="0"> <tr> <td> </td> <td><p>Returns the firmware binary data. <p><dl compact><dt><b>Returns:</b></dt><dd>The firmware binary data </dd></dl><p>Definition at line <a class="el" href="CML__Firmware_8h-source.html#l00114">114</a> of file <a class="el" href="CML__Firmware_8h-source.html">CML_Firmware.h</a>. </td> </tr></table><a class="anchor" name="a2"></a><!-- doxytag: member="Firmware::getFileVersion" ref="a2" args="()" --><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#a8">uint16</a> getFileVersion </td> <td class="md" valign="top">( </td> <td class="mdname1" valign="top" nowrap> </td> <td class="md" valign="top"> ) </td> <td class="md" nowrap><code> [inline]</code></td> </tr> </table> </td> </tr></table><table cellspacing="5" cellpadding="0" border="0"> <tr> <td> </td> <td><p>Returns the firmware file version number. <p><dl compact><dt><b>Returns:</b></dt><dd>The firmware file version number </dd></dl><p>Definition at line <a class="el" href="CML__Firmware_8h-source.html#l00098">98</a> of file <a class="el" href="CML__Firmware_8h-source.html">CML_Firmware.h</a>. </td> </tr></table><a class="anchor" name="a5"></a><!-- doxytag: member="Firmware::getLength" ref="a5" args="()" --><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#a10">uint32</a> getLength </td> <td class="md" valign="top">( </td> <td class="mdname1" valign="top" nowrap> </td> <td class="md" valign="top"> ) </td> <td class="md" nowrap><code> [inline]</code></td> </tr> </table> </td> </tr></table><table cellspacing="5" cellpadding="0" border="0"> <tr> <td> </td> <td><p>Returns the firmware length (in words). <p><dl compact><dt><b>Returns:</b></dt><dd>The firmware length (in words) </dd></dl><p>Definition at line <a class="el" href="CML__Firmware_8h-source.html#l00110">110</a> of file <a class="el" href="CML__Firmware_8h-source.html">CML_Firmware.h</a>. </td> </tr></table><a class="anchor" name="a4"></a><!-- doxytag: member="Firmware::getStart" ref="a4" args="()" --><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#a10">uint32</a> getStart </td> <td class="md" valign="top">( </td> <td class="mdname1" valign="top" nowrap> </td> <td class="md" valign="top"> ) </td> <td class="md" nowrap><code> [inline]</code></td> </tr> </table> </td> </tr></table><table cellspacing="5" cellpadding="0" border="0"> <tr> <td> </td> <td><p>Returns the firmware starting address. <p><dl compact><dt><b>Returns:</b></dt><dd>The firmware starting address </dd></dl><p>Definition at line <a class="el" href="CML__Firmware_8h-source.html#l00106">106</a> of file <a class="el" href="CML__Firmware_8h-source.html">CML_Firmware.h</a>. </td> </tr></table><a class="anchor" name="a7"></a><!-- doxytag: member="Firmware::progress" ref="a7" args="(uint32 addr)" --><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">virtual void progress </td> <td class="md" valign="top">( </td> <td class="md" nowrap valign="top"><a class="el" href="CML__Utils_8h.html#a10">uint32</a> </td> <td class="mdname1" valign="top" nowrap> <em>addr</em> </td> <td class="md" valign="top"> ) </td> <td class="md" nowrap><code> [inline, virtual]</code></td> </tr> </table> </td> </tr></table><table cellspacing="5" cellpadding="0" border="0"> <tr> <td> </td> <td><p>This virtual function is called repeatedly during an amplifier firmware update. <p>It can be overloaded to display the progress of the download. This version does nothing. <dl compact><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td valign="top"></td><td valign="top"><em>addr</em> </td><td>The address currently being downloaded. </td></tr> </table></dl><p>Definition at line <a class="el" href="CML__Firmware_8h-source.html#l00121">121</a> of file <a class="el" href="CML__Firmware_8h-source.html">CML_Firmware.h</a>. </td> </tr></table><hr>The documentation for this class was generated from the following file:<ul><li><a class="el" href="CML__Firmware_8h-source.html">CML_Firmware.h</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>⌨️ 快捷键说明
复制代码
Ctrl + C
搜索代码
Ctrl + F
全屏模式
F11
切换主题
Ctrl + Shift + D
显示快捷键
?
增大字号
Ctrl + =
减小字号
Ctrl + -