📄 classpdo.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: PDO 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>PDO Class Reference</h1><!-- doxytag: class="PDO" --><p>Inheritance diagram for PDO:<p><center><img src="classPDO.png" usemap="#PDO_map" border="0" alt=""></center><map name="PDO_map"><area href="classRPDO.html" alt="RPDO" shape="rect" coords="0,56,115,80"><area href="classTPDO.html" alt="TPDO" shape="rect" coords="250,56,365,80"><area href="classIOModule_1_1AlgOutPDO.html" alt="IOModule::AlgOutPDO" shape="rect" coords="125,112,240,136"><area href="classIOModule_1_1DigOutPDO.html" alt="IOModule::DigOutPDO" shape="rect" coords="125,168,240,192"><area href="classRPDO__LinkCtrl.html" alt="RPDO_LinkCtrl" shape="rect" coords="125,224,240,248"><area href="classRPDO__Pvt.html" alt="RPDO_Pvt" shape="rect" coords="125,280,240,304"><area href="classIOModule_1_1AlgInPDO.html" alt="IOModule::AlgInPDO" shape="rect" coords="375,112,490,136"><area href="classIOModule_1_1DigInPDO.html" alt="IOModule::DigInPDO" shape="rect" coords="375,168,490,192"><area href="classTPDO__PvtBuffStat.html" alt="TPDO_PvtBuffStat" shape="rect" coords="375,224,490,248"><area href="classTPDO__Status.html" alt="TPDO_Status" shape="rect" coords="375,280,490,304"></map><a href="classPDO-members.html">List of all members.</a><hr><a name="_details"></a><h2>Detailed Description</h2>PDO (Process Data Object) base class. <p><p>Definition at line <a class="el" href="CML__PDO_8h-source.html#l00503">503</a> of file <a class="el" href="CML__PDO_8h-source.html">CML_PDO.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="anchor" name="a0"></a><!-- doxytag: member="PDO::PDO" ref="a0" args="(void)" --> </td><td class="memItemRight" valign="bottom"><a class="el" href="classPDO.html#a0">PDO</a> (void)</td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">Default constructor. Simply initializes some variables. <br></td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a1"></a><!-- doxytag: member="PDO::~PDO" ref="a1" args="()" -->virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classPDO.html#a1">~PDO</a> ()</td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">Virtual destructor. <br></td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top">virtual const <a class="el" href="classError.html">Error</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classPDO.html#a2">Init</a> (void)</td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">Initialize the PDO. <a href="#a2"></a><br></td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a3"></a><!-- doxytag: member="PDO::BaseIndex" ref="a3" args="(void)=0" -->virtual <a class="el" href="CML__Utils_8h.html#a8">uint16</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classPDO.html#a3">BaseIndex</a> (void)=0</td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">Return the base index in the object dictionary for this type of PDOs communication parameters. <br></td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="CML__Utils_8h.html#a10">uint32</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classPDO.html#a4">GetID</a> (void)=0</td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">Get the COB ID associated with the PDO. <a href="#a4"></a><br></td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top">virtual const <a class="el" href="classError.html">Error</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classPDO.html#a5">SetType</a> (<a class="el" href="CML__Utils_8h.html#a2">byte</a> t)</td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">Set the PDO transmission type code. <a href="#a5"></a><br></td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="CML__Utils_8h.html#a2">byte</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classPDO.html#a6">GetType</a> (void)</td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">Return the PDO transmission type associated with this PDO. <a href="#a6"></a><br></td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top">virtual const <a class="el" href="classError.html">Error</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classPDO.html#a7">ClearMap</a> (void)</td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">Clear the variable map associated with this PDO. <a href="#a7"></a><br></td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top">virtual const <a class="el" href="classError.html">Error</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classPDO.html#a8">AddVar</a> (<a class="el" href="classPmap.html">Pmap</a> &var)</td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">Add the passed variable to the end of the variable map associated with this PDO. <a href="#a8"></a><br></td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top">virtual int </td><td class="memItemRight" valign="bottom"><a class="el" href="classPDO.html#a9">GetRtrOk</a> (void)</td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">Return non-zero if RTR requests are OK for this PDO. <a href="#a9"></a><br></td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top">virtual int </td><td class="memItemRight" valign="bottom"><a class="el" href="classPDO.html#a10">GetMapCodes</a> (<a class="el" href="CML__Utils_8h.html#a10">uint32</a> codes[])</td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">Fill the array of 32-bit ints with the PDO mapping codes used by this PDO. <a href="#a10"></a><br></td></tr><tr><td colspan="2"><br><h2>Protected Attributes</h2></td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="p0"></a><!-- doxytag: member="PDO::flags" ref="p0" args="" --><a class="el" href="CML__Utils_8h.html#a2">byte</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classPDO.html#p0">flags</a></td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">Misc flags associated with the PDO. <br></td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="p1"></a><!-- doxytag: member="PDO::type" ref="p1" args="" --><a class="el" href="CML__Utils_8h.html#a2">byte</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classPDO.html#p1">type</a></td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">Transmission type code. <br></td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="p2"></a><!-- doxytag: member="PDO::mapCt" ref="p2" args="" -->int </td><td class="memItemRight" valign="bottom"><a class="el" href="classPDO.html#p2">mapCt</a></td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">Number of elements in the variable map. <br></td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="p3"></a><!-- doxytag: member="PDO::bitCt" ref="p3" args="" -->int </td><td class="memItemRight" valign="bottom"><a class="el" href="classPDO.html#p3">bitCt</a></td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">Number of bits mapped so far. <br></td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="p4"></a><!-- doxytag: member="PDO::map" ref="p4" args="[PDO_MAP_LEN]" --><a class="el" href="classPmap.html">Pmap</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classPDO.html#p4">map</a> [PDO_MAP_LEN]</td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">Array of pointers to <a class="el" href="classPmap.html">Pmap</a> objects that describe the variables transmitted by this PDO. <br></td></tr></table><hr><h2>Member Function Documentation</h2><a class="anchor" name="a8"></a><!-- doxytag: member="PDO::AddVar" ref="a8" args="(Pmap &var)" --><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">const <a class="el" href="classError.html">Error</a> * AddVar </td> <td class="md" valign="top">( </td> <td class="md" nowrap valign="top"><a class="el" href="classPmap.html">Pmap</a> & </td> <td class="mdname1" valign="top" nowrap> <em>var</em> </td> <td class="md" valign="top"> ) </td> <td class="md" nowrap><code> [virtual]</code></td> </tr> </table> </td> </tr></table><table cellspacing="5" cellpadding="0" border="0"> <tr> <td> </td> <td><p>Add the passed variable to the end of the variable map associated with this PDO. <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>var</em> </td><td>The variable to be added. </td></tr> </table></dl><dl compact><dt><b>Returns:</b></dt><dd>An error object.</dd></dl><p>Definition at line <a class="el" href="PDO_8cpp-source.html#l00053">53</a> of file <a class="el" href="PDO_8cpp-source.html">PDO.cpp</a>. </td> </tr></table><a class="anchor" name="a7"></a><!-- doxytag: member="PDO::ClearMap" ref="a7" 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">virtual const <a class="el" href="classError.html">Error</a>* ClearMap </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, virtual]</code></td> </tr> </table> </td> </tr></table><table cellspacing="5" cellpadding="0" border="0"> <tr> <td> </td> <td><p>Clear the variable map associated with this PDO. <p><dl compact><dt><b>Returns:</b></dt><dd>An error code </dd></dl><p>Definition at line <a class="el" href="CML__PDO_8h-source.html#l00552">552</a> of file <a class="el" href="CML__PDO_8h-source.html">CML_PDO.h</a>. </td> </tr></table><a class="anchor" name="a4"></a><!-- doxytag: member="PDO::GetID" ref="a4" args="(void)=0" --><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 <a class="el" href="CML__Utils_8h.html#a10">uint32</a> GetID </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> [pure virtual]</code></td> </tr> </table> </td> </tr></table><table cellspacing="5" cellpadding="0" border="0"> <tr> <td> </td> <td><p>Get the COB ID associated with the PDO. <p><dl compact><dt><b>Returns:</b></dt><dd>The COB-ID of the PDO </dd></dl><p>Implemented in <a class="el" href="classTPDO.html#a6">TPDO</a>, and <a class="el" href="classRPDO.html#a6">RPDO</a>. </td> </tr>⌨️ 快捷键说明
复制代码
Ctrl + C
搜索代码
Ctrl + F
全屏模式
F11
切换主题
Ctrl + Shift + D
显示快捷键
?
增大字号
Ctrl + =
减小字号
Ctrl + -