📄 classpmap16.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: Pmap16 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>Pmap16 Class Reference</h1><!-- doxytag: class="Pmap16" --><!-- doxytag: inherits="Pmap" --><p>Inheritance diagram for Pmap16:<p><center><img src="classPmap16.png" usemap="#Pmap16_map" border="0" alt=""></center><map name="Pmap16_map"><area href="classPmap.html" alt="Pmap" shape="rect" coords="0,0,57,24"></map><a href="classPmap16-members.html">List of all members.</a><hr><a name="_details"></a><h2>Detailed Description</h2>This is a <a class="el" href="classPDO.html">PDO</a> variable mapping class that extends the virtual <a class="el" href="classPmap.html">Pmap</a> class to handle 16-bit integers. <p><p>Definition at line <a class="el" href="CML__PDO_8h-source.html#l00365">365</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="Pmap16::Pmap16" ref="a0" args="()" --> </td><td class="memItemRight" valign="bottom"><a class="el" href="classPmap16.html#a0">Pmap16</a> ()</td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">Default constructor for a 16-bit mapping object. <br></td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classPmap16.html#a1">Pmap16</a> (<a class="el" href="CML__Utils_8h.html#a8">uint16</a> <a class="el" href="classPmap.html#p0">index</a>, <a class="el" href="CML__Utils_8h.html#a2">byte</a> <a class="el" href="classPmap.html#p1">sub</a>=0)</td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">Create a new 16-bit mapping object. <a href="#a1"></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="classPmap16.html#a2">Init</a> (<a class="el" href="CML__Utils_8h.html#a8">uint16</a> <a class="el" href="classPmap.html#p0">index</a>, <a class="el" href="CML__Utils_8h.html#a2">byte</a> <a class="el" href="classPmap.html#p1">sub</a>=0)</td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">Initialize a 16-bit mapping object. <a href="#a2"></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="classPmap16.html#a3">Get</a> (<a class="el" href="CML__Utils_8h.html#a2">byte</a> *cptr)</td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">Copy the current value of this variable into the passed character array. <a href="#a3"></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="classPmap16.html#a4">Set</a> (<a class="el" href="CML__Utils_8h.html#a2">byte</a> *cptr)</td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">Update the value of this variable based on the data passed in a character array. <a href="#a4"></a><br></td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="CML__Utils_8h.html#a7">int16</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classPmap16.html#a5">Read</a> (void)</td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">Read the current value of this variable. <a href="#a5"></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="classPmap16.html#a6">Write</a> (<a class="el" href="CML__Utils_8h.html#a7">int16</a> d)</td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">Write a new value to this variable. <a href="#a6"></a><br></td></tr></table><hr><h2>Constructor & Destructor Documentation</h2><a class="anchor" name="a1"></a><!-- doxytag: member="Pmap16::Pmap16" ref="a1" args="(uint16 index, byte sub=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"><a class="el" href="classPmap16.html">Pmap16</a> </td> <td class="md" valign="top">( </td> <td class="md" nowrap valign="top"><a class="el" href="CML__Utils_8h.html#a8">uint16</a> </td> <td class="mdname" nowrap> <em>index</em>, </td> </tr> <tr> <td class="md" nowrap align="right"></td> <td class="md"></td> <td class="md" nowrap><a class="el" href="CML__Utils_8h.html#a2">byte</a> </td> <td class="mdname" nowrap> <em>sub</em> = <code>0</code></td> </tr> <tr> <td class="md"></td> <td class="md">) </td> <td class="md" colspan="2"><code> [inline]</code></td> </tr> </table> </td> </tr></table><table cellspacing="5" cellpadding="0" border="0"> <tr> <td> </td> <td><p>Create a new 16-bit mapping object. <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>index</em> </td><td>Object index associated with this variable </td></tr> <tr><td valign="top"></td><td valign="top"><em>sub</em> </td><td>Object sub-index (defaults to 0) </td></tr> </table></dl><p>Definition at line <a class="el" href="CML__PDO_8h-source.html#l00374">374</a> of file <a class="el" href="CML__PDO_8h-source.html">CML_PDO.h</a>. </td> </tr></table><hr><h2>Member Function Documentation</h2><a class="anchor" name="a3"></a><!-- doxytag: member="Pmap16::Get" ref="a3" args="(byte *cptr)" --><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 Get </td> <td class="md" valign="top">( </td> <td class="md" nowrap valign="top"><a class="el" href="CML__Utils_8h.html#a2">byte</a> * </td> <td class="mdname1" valign="top" nowrap> <em>cptr</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>Copy the current value of this variable into the passed character array. <p>This function is called when a receive <a class="el" href="classPDO.html">PDO</a> is about to be transmitted to a node. <dl compact><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td valign="top"></td><td valign="top"><em>cptr</em> </td><td>A character pointer that references a char array of at least 2 bytes. The current value of this variable will be copied there. </td></tr> </table></dl><p>Reimplemented from <a class="el" href="classPmap.html#a4">Pmap</a>.<p>Definition at line <a class="el" href="CML__PDO_8h-source.html#l00390">390</a> of file <a class="el" href="CML__PDO_8h-source.html">CML_PDO.h</a>. </td> </tr></table><a class="anchor" name="a2"></a><!-- doxytag: member="Pmap16::Init" ref="a2" args="(uint16 index, byte sub=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">const <a class="el" href="classError.html">Error</a>* Init </td> <td class="md" valign="top">( </td> <td class="md" nowrap valign="top"><a class="el" href="CML__Utils_8h.html#a8">uint16</a> </td> <td class="mdname" nowrap> <em>index</em>, </td> </tr> <tr> <td class="md" nowrap align="right"></td> <td class="md"></td> <td class="md" nowrap><a class="el" href="CML__Utils_8h.html#a2">byte</a> </td> <td class="mdname" nowrap> <em>sub</em> = <code>0</code></td> </tr> <tr> <td class="md"></td> <td class="md">) </td> <td class="md" colspan="2"><code> [inline]</code></td> </tr> </table> </td> </tr></table><table cellspacing="5" cellpadding="0" border="0"> <tr> <td> </td> <td><p>Initialize a 16-bit mapping object. <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>index</em> </td><td>Object index associated with this variable </td></tr> <tr><td valign="top"></td><td valign="top"><em>sub</em> </td><td>Object sub-index (defaults to 0) </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="CML__PDO_8h-source.html#l00380">380</a> of file <a class="el" href="CML__PDO_8h-source.html">CML_PDO.h</a>. </td> </tr></table><a class="anchor" name="a5"></a><!-- doxytag: member="Pmap16::Read" ref="a5" 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 <a class="el" href="CML__Utils_8h.html#a7">int16</a> Read </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>Read the current value of this variable. <p><dl compact><dt><b>Returns:</b></dt><dd>The current value of this variable. </dd></dl><p>Definition at line <a class="el" href="CML__PDO_8h-source.html#l00413">413</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="Pmap16::Set" ref="a4" args="(byte *cptr)" --><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 Set </td> <td class="md" valign="top">( </td> <td class="md" nowrap valign="top"><a class="el" href="CML__Utils_8h.html#a2">byte</a> * </td> <td class="mdname1" valign="top" nowrap> <em>cptr</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>Update the value of this variable based on the data passed in a character array. <p>This function is called when a transmit <a class="el" href="classPDO.html">PDO</a> that this variable is mapped to is received. <dl compact><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td valign="top"></td><td valign="top"><em>cptr</em> </td><td>A character pointer that references a char array of at least 2 bytes. The value of this variable will be updated with the data passed in this array. </td></tr> </table></dl><p>Reimplemented from <a class="el" href="classPmap.html#a5">Pmap</a>.<p>Definition at line <a class="el" href="CML__PDO_8h-source.html#l00404">404</a> of file <a class="el" href="CML__PDO_8h-source.html">CML_PDO.h</a>. </td> </tr></table><a class="anchor" name="a6"></a><!-- doxytag: member="Pmap16::Write" ref="a6" args="(int16 d)" --><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 Write </td> <td class="md" valign="top">( </td> <td class="md" nowrap valign="top"><a class="el" href="CML__Utils_8h.html#a7">int16</a> </td> <td class="mdname1" valign="top" nowrap> <em>d</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>Write a new value to this variable. <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>d</em> </td><td>The new value to write. </td></tr> </table></dl><p>Definition at line <a class="el" href="CML__PDO_8h-source.html#l00422">422</a> of file <a class="el" href="CML__PDO_8h-source.html">CML_PDO.h</a>. </td> </tr></table><hr>The documentation for this class was generated from the following file:<ul><li><a class="el" href="CML__PDO_8h-source.html">CML_PDO.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 + -