📄 classampsettings.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: AmpSettings 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>AmpSettings Class Reference</h1><!-- doxytag: class="AmpSettings" --><a href="classAmpSettings-members.html">List of all members.</a><hr><a name="_details"></a><h2>Detailed Description</h2>Copley amplifier settings object. <p>This object is passed to the Init() method of the Copley amp. It holds the various customizable settings used by the amplifier.<p><p>Definition at line <a class="el" href="CML__Amp_8h-source.html#l00172">172</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 class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classAmpSettings.html#a0">AmpSettings</a> ()</td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">Create a settings object with all default values. <a href="#a0"></a><br></td></tr><tr><td colspan="2"><br><h2>Public Attributes</h2></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="classAmpSettings.html#o0">synchPeriod</a></td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">Synch object period in microseconds. <a href="#o0"></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="classAmpSettings.html#o1">synchID</a></td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">Synch object CAN message ID. <a href="#o1"></a><br></td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classAmpSettings.html#o2">synchUseFirstAmp</a></td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">Use first initialized amplifier as synch producer. <a href="#o2"></a><br></td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classAmpSettings.html#o3">synchProducer</a></td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">Synch producer (true/false) If true, this node will produce synch messages. <a href="#o3"></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="classAmpSettings.html#o4">timeStampID</a></td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">High resolution time stamp CAN ID. <a href="#o4"></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="classAmpSettings.html#o5">heartbeatPeriod</a></td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">The CANopen heartbeat protocol is one of two standard methods used to constantly watch for network or device problems. <a href="#o5"></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="classAmpSettings.html#o6">heartbeatTimeout</a></td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">Additional time to wait before generating a heartbeat error (milliseconds) If the heartbeat protocol is used, then this value, combined with the heartbeatTime will determine how long the network master waits for the node's heartbeat message before it generates a heartbeat error. <a href="#o6"></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="classAmpSettings.html#o7">guardTime</a></td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight"><a class="el" href="classNode.html">Node</a> guarding guard time (milliseconds). <a href="#o7"></a><br></td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="CML__Utils_8h.html#a6">uint8</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classAmpSettings.html#o8">lifeFactor</a></td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight"><a class="el" href="classNode.html">Node</a> guarding life time factor. <a href="#o8"></a><br></td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classAmpSettings.html#o9">enableOnInit</a></td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">Enable amplifier at init time. <a href="#o9"></a><br></td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="CML__AmpDef_8h.html#a397">AMP_MODE</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classAmpSettings.html#o10">initialMode</a></td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">Initial mode of operation. <a href="#o10"></a><br></td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classAmpSettings.html#o11">resetOnInit</a></td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">Reset the amplifier on init. <a href="#o11"></a><br></td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="CML__Utils_8h.html#a6">uint8</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classAmpSettings.html#o12">maxPvtSendCt</a></td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">Max PVT segments to send in response to a PVT status update. <a href="#o12"></a><br></td></tr></table><hr><h2>Constructor & Destructor Documentation</h2><a class="anchor" name="a0"></a><!-- doxytag: member="AmpSettings::AmpSettings" ref="a0" 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="classAmpSettings.html">AmpSettings</a> </td> <td class="md" valign="top">( </td> <td class="mdname1" valign="top" nowrap> </td> <td class="md" valign="top"> ) </td> <td class="md" nowrap></td> </tr> </table> </td> </tr></table><table cellspacing="5" cellpadding="0" border="0"> <tr> <td> </td> <td><p>Create a settings object with all default values. <p>The default values for each member of this class are defined below. <p>Definition at line <a class="el" href="Amp_8cpp-source.html#l01472">1472</a> of file <a class="el" href="Amp_8cpp-source.html">Amp.cpp</a>. </td> </tr></table><hr><h2>Member Data Documentation</h2><a class="anchor" name="o9"></a><!-- doxytag: member="AmpSettings::enableOnInit" ref="o9" 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">bool <a class="el" href="classAmpSettings.html#o9">enableOnInit</a> </td> </tr> </table> </td> </tr></table><table cellspacing="5" cellpadding="0" border="0"> <tr> <td> </td> <td><p>Enable amplifier at init time. <p>If this is true, then the amplifier will be enabled at the end of a successful init(). If false, the amplifier will be disabled when init() returns.<p>Default: true <p>Definition at line <a class="el" href="CML__Amp_8h-source.html#l00299">299</a> of file <a class="el" href="CML__Amp_8h-source.html">CML_Amp.h</a>. </td> </tr></table><a class="anchor" name="o7"></a><!-- doxytag: member="AmpSettings::guardTime" ref="o7" 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> <a class="el" href="classAmpSettings.html#o7">guardTime</a> </td> </tr> </table> </td> </tr></table><table cellspacing="5" cellpadding="0" border="0"> <tr> <td> </td> <td><p><a class="el" href="classNode.html">Node</a> guarding guard time (milliseconds). <p>The CANopen node guarding protocol is a second method (the first being the heartbeat protocol) for devices on the network to watch for network problems. In this protocol, the master controller sends a request message out to the slave device at a specified interval. The slave device responds to this request with a message indicating it's state.<p>The main difference between this protocol and the heartbeat protocol is that both the slave node and the master are able to recognize network errors. With the heartbeat protocol only the network master is able to identify network problems.<p>Note that only one of these two protocols can be active in a node device at any time. If the heartbeat period is non-zero, then the heartbeat protocol will be used.<p>This parameter gives the node guarding period for use with this node. This is the period between node guarding request messages sent by the master controller.<p>Note that both this parameter, and the life time factor must be non-zero for node guarding to be used.<p>Default 200 (ms) <p>Definition at line <a class="el" href="CML__Amp_8h-source.html#l00277">277</a> of file <a class="el" href="CML__Amp_8h-source.html">CML_Amp.h</a>. </td> </tr></table><a class="anchor" name="o5"></a><!-- doxytag: member="AmpSettings::heartbeatPeriod" ref="o5" 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> <a class="el" href="classAmpSettings.html#o5">heartbeatPeriod</a> </td> </tr> </table> </td> </tr></table><table cellspacing="5" cellpadding="0" border="0"> <tr> <td> </td> <td><p>The CANopen heartbeat protocol is one of two standard methods used to constantly watch for network or device problems. <p>When the heartbeat protocol is used, each device on the CANopen network transmits a 'heartbeat' message at a specified interval. The network master watches for these messages, and is able to detect a device error if it's heartbeat message is not received within the expected time.<p>This parameter configures the heartbeat period (milliseconds) that will be used by this amplifier to transmit it's heartbeat message.<p>If this parameter is set to zero, then the heartbeat protocol is disabled on this node.<p>Default: zero (not used) <p>Definition at line <a class="el" href="CML__Amp_8h-source.html#l00239">239</a> of file <a class="el" href="CML__Amp_8h-source.html">CML_Amp.h</a>. </td> </tr></table><a class="anchor" name="o6"></a><!-- doxytag: member="AmpSettings::heartbeatTimeout" ref="o6" 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> <a class="el" href="classAmpSettings.html#o6">heartbeatTimeout</a> </td> </tr> </table> </td> </tr></table><table cellspacing="5" cellpadding="0" border="0"> <tr> <td> </td> <td><p>Additional time to wait before generating a heartbeat error (milliseconds) If the heartbeat protocol is used, then this value, combined with the heartbeatTime will determine how long the network master waits for the node's heartbeat message before it generates a heartbeat error. <p>Note that setting this to zero does not disable the heartbeat protocol. set the heartbeatPeriod value to zero to disable heartbeat.<p>Default 200 (ms) <p>Definition at line <a class="el" href="CML__Amp_8h-source.html#l00250">250</a> of file <a class="el" href="CML__Amp_8h-source.html">CML_Amp.h</a>. </td> </tr></table><a class="anchor" name="o10"></a><!-- doxytag: member="AmpSettings::initialMode" ref="o10" 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__AmpDef_8h.html#a397">AMP_MODE</a> <a class="el" href="classAmpSettings.html#o10">initialMode</a> </td> </tr> </table> </td> </tr></table><table cellspacing="5" cellpadding="0" border="0"> <tr> <td> </td> <td><p>Initial mode of operation. <p>This defines the mode of operation that the amplifier will be placed in when it is initialized.<p>Default: AMPMODE_CAN_HOMING <p>Definition at line <a class="el" href="CML__Amp_8h-source.html#l00305">305</a> of file <a class="el" href="CML__Amp_8h-source.html">CML_Amp.h</a>. </td> </tr>⌨️ 快捷键说明
复制代码
Ctrl + C
搜索代码
Ctrl + F
全屏模式
F11
切换主题
Ctrl + Shift + D
显示快捷键
?
增大字号
Ctrl + =
减小字号
Ctrl + -