classamp.html
来自「美国COPLEY驱动器,程序开发工具之一.」· HTML 代码 · 共 447 行 · 第 1/5 页
HTML
447 行
<!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: Amp 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>Amp Class Reference</h1><!-- doxytag: class="Amp" --><!-- doxytag: inherits="CopleyNode" --><p>Inheritance diagram for Amp:<p><center><img src="classAmp.png" usemap="#Amp_map" border="0" alt=""></center><map name="Amp_map"><area href="classCopleyNode.html" alt="CopleyNode" shape="rect" coords="46,112,128,136"><area href="classNode.html" alt="Node" shape="rect" coords="46,56,128,80"><area href="classThread.html" alt="Thread" shape="rect" coords="0,0,82,24"><area href="classReceiver.html" alt="Receiver" shape="rect" coords="92,0,174,24"></map><a href="classAmp-members.html">List of all members.</a><hr><a name="_details"></a><h2>Detailed Description</h2>Copley Controls amplifier object. <p>This object represents a Copley Controls amplifier on the CANopen network.<p>The Amp object can be used directly for fairly easy control of an amplifier on the CANopen network. The object provides easy to use methods for setting and getting amplifier parameter blocks. It also handles many of the details of both point to point moves and the transfer of complex PVT profiles.<p>In addition, the standard Amp object provides several virtual functions which can be used in derived classes to signal the derived object on state changes or emergency conditions.<p><p>Definition at line <a class="el" href="CML__Amp_8h-source.html#l00494">494</a> of file <a class="el" href="CML__Amp_8h-source.html">CML_Amp.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 colspan="2"><div class="groupHeader">Amplifier initialization</div></td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classAmp.html#z0_0">Amp</a> ()</td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">Default constructor. <a href="#z0_0"></a><br></td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classAmp.html#z0_1">Amp</a> (<a class="el" href="classCanOpen.html">CanOpen</a> &<a class="el" href="classReceiver.html#p0">co</a>, <a class="el" href="CML__Utils_8h.html#a7">int16</a> nodeID)</td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">Construct and initialize an amplifier object using defaults for all amp settings. <a href="#z0_1"></a><br></td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classAmp.html#z0_2">Amp</a> (<a class="el" href="classCanOpen.html">CanOpen</a> &<a class="el" href="classReceiver.html#p0">co</a>, <a class="el" href="CML__Utils_8h.html#a7">int16</a> nodeID, <a class="el" href="classAmpSettings.html">AmpSettings</a> &settings)</td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">Construct and initialize an amplifier object. <a href="#z0_2"></a><br></td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="z0_3"></a><!-- doxytag: member="Amp::~Amp" ref="z0_3" args="()" -->virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classAmp.html#z0_3">~Amp</a> ()</td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">Amp object destructor. <br></td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top">const <a class="el" href="classError.html">Error</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classAmp.html#z0_4">Init</a> (<a class="el" href="classCanOpen.html">CanOpen</a> &<a class="el" href="classReceiver.html#p0">co</a>, <a class="el" href="CML__Utils_8h.html#a7">int16</a> nodeID)</td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">Initialize the amplifier object using all default settings. <a href="#z0_4"></a><br></td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top">const <a class="el" href="classError.html">Error</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classAmp.html#z0_5">Init</a> (<a class="el" href="classCanOpen.html">CanOpen</a> &<a class="el" href="classReceiver.html#p0">co</a>, <a class="el" href="CML__Utils_8h.html#a7">int16</a> nodeID, <a class="el" href="classAmpSettings.html">AmpSettings</a> &settings)</td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">Initialize the amplifier object with custom amp settings. <a href="#z0_5"></a><br></td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top">const <a class="el" href="classError.html">Error</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classAmp.html#z0_6">ReInit</a> (void)</td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">Re-initialize an amplifier. <a href="#z0_6"></a><br></td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top">const <a class="el" href="classError.html">Error</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classAmp.html#z0_7">Reset</a> (void)</td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">Reset the amplifier object. <a href="#z0_7"></a><br></td></tr><tr><td colspan="2"><div class="groupHeader">Amplifier modes & status info</div></td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top">const <a class="el" href="classError.html">Error</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classAmp.html#z1_0">SetAmpMode</a> (<a class="el" href="CML__AmpDef_8h.html#a397">AMP_MODE</a> mode)</td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">Set the amplifier mode of operation. <a href="#z1_0"></a><br></td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top">const <a class="el" href="classError.html">Error</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classAmp.html#z1_1">GetAmpMode</a> (<a class="el" href="CML__AmpDef_8h.html#a397">AMP_MODE</a> &mode)</td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">Get the currently active amplifier mode of operation. <a href="#z1_1"></a><br></td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top">const <a class="el" href="classError.html">Error</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classAmp.html#z1_2">Disable</a> (bool wait=true)</td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">Disable the amplifier. <a href="#z1_2"></a><br></td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top">const <a class="el" href="classError.html">Error</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classAmp.html#z1_3">Enable</a> (bool wait=true)</td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">Enable the amplifier. <a href="#z1_3"></a><br></td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classAmp.html#z1_4">IsHardwareEnabled</a> (void)</td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">Return true if the amplifier's PWM outputs are currently enabled. <a href="#z1_4"></a><br></td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classAmp.html#z1_5">IsSoftwareEnabled</a> (void)</td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">Return true if the amplifier is being enabled by software. <a href="#z1_5"></a><br></td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classAmp.html#z1_6">IsReferenced</a> (void)</td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">Return true if the amplifier has been successfully referenced (homed). <a href="#z1_6"></a><br></td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top">const <a class="el" href="classError.html">Error</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classAmp.html#z1_7">CheckStateForMove</a> (void)</td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">Check the amplifier's state to make sure a move can be started. <a href="#z1_7"></a><br></td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top">const <a class="el" href="classError.html">Error</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classAmp.html#z1_8">ClearFaults</a> (<a class="el" href="CML__AmpDef_8h.html#a400">AMP_FAULT</a> mask=(<a class="el" href="CML__AmpDef_8h.html#a400">AMP_FAULT</a>)-1)</td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">Clear amplifier faults. <a href="#z1_8"></a><br></td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top">const <a class="el" href="classError.html">Error</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classAmp.html#z1_9">GetFaults</a> (<a class="el" href="CML__AmpDef_8h.html#a400">AMP_FAULT</a> &value)</td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">Get any active amplifier faults. <a href="#z1_9"></a><br></td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top">const <a class="el" href="classError.html">Error</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classAmp.html#z1_10">SetFaultMask</a> (<a class="el" href="CML__AmpDef_8h.html#a400">AMP_FAULT</a> &value)</td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">Set the amplifier's fault mask. <a href="#z1_10"></a><br></td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top">const <a class="el" href="classError.html">Error</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classAmp.html#z1_11">GetFaultMask</a> (<a class="el" href="CML__AmpDef_8h.html#a400">AMP_FAULT</a> &value)</td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">Get the current value of the amplifier's fault mask. <a href="#z1_11"></a><br></td></tr>⌨️ 快捷键说明
复制代码Ctrl + C
搜索代码Ctrl + F
全屏模式F11
增大字号Ctrl + =
减小字号Ctrl + -
显示快捷键?