📄 cml__utils_8h.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: CML_Utils.h File 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><div class="nav"><a class="el" href="dir_000001.html">inc</a></div><h1>CML_Utils.h File Reference</h1><hr><a name="_details"></a><h2>Detailed Description</h2>This file holds various handy utility types and functions. <p><p>Definition in file <a class="el" href="CML__Utils_8h-source.html">CML_Utils.h</a>.<p><p><a href="CML__Utils_8h-source.html">Go to the source code of this file.</a><table border="0" cellpadding="0" cellspacing="0"><tr><td></td></tr><tr><td colspan="2"><br><h2>Defines</h2></td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="CML__Utils_8h.html#a0">ByteCast</a>(x) ((<a class="el" href="CML__Utils_8h.html#a2">byte</a>)(x))</td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">The <a class="el" href="CML__Utils_8h.html#a0">ByteCast()</a> macro is used to cast a value to a byte type (unsigned char). <a href="#a0"></a><br></td></tr><tr><td colspan="2"><br><h2>Typedefs</h2></td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a1"></a><!-- doxytag: member="CML_Utils.h::uchar" ref="a1" args="" -->typedef unsigned char </td><td class="memItemRight" valign="bottom"><a class="el" href="CML__Utils_8h.html#a1">uchar</a></td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">unsigned character <br></td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a2"></a><!-- doxytag: member="CML_Utils.h::byte" ref="a2" args="" -->typedef unsigned char </td><td class="memItemRight" valign="bottom"><a class="el" href="CML__Utils_8h.html#a2">byte</a></td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">unsigned character <br></td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a3"></a><!-- doxytag: member="CML_Utils.h::uint" ref="a3" args="" -->typedef unsigned int </td><td class="memItemRight" valign="bottom"><a class="el" href="CML__Utils_8h.html#a3">uint</a></td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">unsigned integer type <br></td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a4"></a><!-- doxytag: member="CML_Utils.h::ulong" ref="a4" args="" -->typedef unsigned long </td><td class="memItemRight" valign="bottom"><a class="el" href="CML__Utils_8h.html#a4">ulong</a></td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">unsigned long type <br></td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a5"></a><!-- doxytag: member="CML_Utils.h::int8" ref="a5" args="" -->typedef signed char </td><td class="memItemRight" valign="bottom"><a class="el" href="CML__Utils_8h.html#a5">int8</a></td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">8-bit integer type <br></td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a6"></a><!-- doxytag: member="CML_Utils.h::uint8" ref="a6" args="" -->typedef unsigned char </td><td class="memItemRight" valign="bottom"><a class="el" href="CML__Utils_8h.html#a6">uint8</a></td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">8-bit unsigned integer type <br></td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top">typedef short </td><td class="memItemRight" valign="bottom"><a class="el" href="CML__Utils_8h.html#a7">int16</a></td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">Signed 16-bit integer type. <a href="#a7"></a><br></td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top">typedef unsigned short </td><td class="memItemRight" valign="bottom"><a class="el" href="CML__Utils_8h.html#a8">uint16</a></td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">16-bit unsigned integer type <a href="#a8"></a><br></td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top">typedef int </td><td class="memItemRight" valign="bottom"><a class="el" href="CML__Utils_8h.html#a9">int32</a></td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">Signed 32-bit integer type. <a href="#a9"></a><br></td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top">typedef unsigned int </td><td class="memItemRight" valign="bottom"><a class="el" href="CML__Utils_8h.html#a10">uint32</a></td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">Unsigned 32-bit integer type. <a href="#a10"></a><br></td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top">typedef double </td><td class="memItemRight" valign="bottom"><a class="el" href="CML__Utils_8h.html#a11">uunit</a></td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">User programmable unit. <a href="#a11"></a><br></td></tr><tr><td colspan="2"><br><h2>Functions</h2></td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a12"></a><!-- doxytag: member="CML_Utils.h::bytes_to_uint32" ref="a12" args="(byte *b)" --><a class="el" href="CML__Utils_8h.html#a10">uint32</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="CML__Utils_8h.html#a12">bytes_to_uint32</a> (<a class="el" href="CML__Utils_8h.html#a2">byte</a> *b)</td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a13"></a><!-- doxytag: member="CML_Utils.h::bytes_to_uint16" ref="a13" args="(byte *b)" --><a class="el" href="CML__Utils_8h.html#a8">uint16</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="CML__Utils_8h.html#a13">bytes_to_uint16</a> (<a class="el" href="CML__Utils_8h.html#a2">byte</a> *b)</td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a14"></a><!-- doxytag: member="CML_Utils.h::bytes_to_int32" ref="a14" args="(byte *b)" --><a class="el" href="CML__Utils_8h.html#a9">int32</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="CML__Utils_8h.html#a14">bytes_to_int32</a> (<a class="el" href="CML__Utils_8h.html#a2">byte</a> *b)</td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a15"></a><!-- doxytag: member="CML_Utils.h::bytes_to_int16" ref="a15" args="(byte *b)" --><a class="el" href="CML__Utils_8h.html#a7">int16</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="CML__Utils_8h.html#a15">bytes_to_int16</a> (<a class="el" href="CML__Utils_8h.html#a2">byte</a> *b)</td></tr></table><hr><h2>Define Documentation</h2><a class="anchor" name="a0"></a><!-- doxytag: member="CML_Utils.h::ByteCast" ref="a0" args="(x)" --><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">#define ByteCast </td> <td class="md" valign="top">( </td> <td class="md" nowrap valign="top">x </td> <td class="mdname1" valign="top" nowrap> </td> <td class="md" valign="top"> ) </td> <td class="md" nowrap> ((<a class="el" href="CML__Utils_8h.html#a2">byte</a>)(x))</td> </tr> </table> </td> </tr></table><table cellspacing="5" cellpadding="0" border="0"> <tr> <td> </td> <td><p>The <a class="el" href="CML__Utils_8h.html#a0">ByteCast()</a> macro is used to cast a value to a byte type (unsigned char). <p>The reason that a macro is used rather then a simple cast is that some processors have characters that are more then 8 bits long. This is particularly common with 16-bit or 32-bit microcontrollers and DSPs. On such systems the ByteCast macro will strip off any upper bits and then cast the result to a byte. On systems with 8-bit bytes the ByteCast macro simply casts the passed value to a byte.<p>Definition at line <a class="el" href="CML__Utils_8h-source.html#l00122">122</a> of file <a class="el" href="CML__Utils_8h-source.html">CML_Utils.h</a>. </td> </tr></table><hr><h2>Typedef Documentation</h2><a class="anchor" name="a7"></a><!-- doxytag: member="CML_Utils.h::int16" ref="a7" 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#a7">int16</a> </td> </tr> </table> </td> </tr></table><table cellspacing="5" cellpadding="0" border="0"> <tr> <td> </td> <td><p>Signed 16-bit integer type. <p>Note that the actual definition of this type will depend on the compiler being used. The standard C language header file limits.h will be used to determine how to create the type definition.<p>Definition at line <a class="el" href="CML__Utils_8h-source.html#l00040">40</a> of file <a class="el" href="CML__Utils_8h-source.html">CML_Utils.h</a>. </td> </tr></table><a class="anchor" name="a9"></a><!-- doxytag: member="CML_Utils.h::int32" ref="a9" 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#a9">int32</a> </td> </tr> </table> </td> </tr></table><table cellspacing="5" cellpadding="0" border="0"> <tr> <td> </td> <td><p>Signed 32-bit integer type. <p>Note that the actual definition of this type will depend on the compiler being used. The standard C language header file limits.h will be used to determine how to create the type definition.<p>Definition at line <a class="el" href="CML__Utils_8h-source.html#l00070">70</a> of file <a class="el" href="CML__Utils_8h-source.html">CML_Utils.h</a>. </td> </tr></table><a class="anchor" name="a8"></a><!-- doxytag: member="CML_Utils.h::uint16" ref="a8" 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> </td> </tr> </table> </td> </tr></table><table cellspacing="5" cellpadding="0" border="0"> <tr> <td> </td> <td><p>16-bit unsigned integer type <p>Note that the actual definition of this type will depend on the compiler being used. The standard C language header file limits.h will be used to determine how to create the type definition.<p>Definition at line <a class="el" href="CML__Utils_8h-source.html#l00055">55</a> of file <a class="el" href="CML__Utils_8h-source.html">CML_Utils.h</a>. </td> </tr></table><a class="anchor" name="a10"></a><!-- doxytag: member="CML_Utils.h::uint32" ref="a10" 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> </td> </tr> </table> </td> </tr></table><table cellspacing="5" cellpadding="0" border="0"> <tr> <td> </td> <td><p>Unsigned 32-bit integer type. <p>Note that the actual definition of this type will depend on the compiler being used. The standard C language header file limits.h will be used to determine how to create the type definition.<p>Definition at line <a class="el" href="CML__Utils_8h-source.html#l00085">85</a> of file <a class="el" href="CML__Utils_8h-source.html">CML_Utils.h</a>. </td> </tr></table><a class="anchor" name="a11"></a><!-- doxytag: member="CML_Utils.h::uunit" ref="a11" 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#a11">uunit</a> </td> </tr> </table> </td> </tr></table><table cellspacing="5" cellpadding="0" border="0"> <tr> <td> </td> <td><p>User programmable unit. <p>If user units are enabled in the <a class="el" href="CML__Settings_8h.html">CML_Settings.h</a> file, then this type will resolve to double precision floating point. If not, then this type will resolve to a 32-bit integer.<p>User units are used for all position, velocity, acceleration, and jerk values passed to/from an <a class="el" href="classAmp.html">Amp</a> object.<p>Definition at line <a class="el" href="CML__Utils_8h-source.html#l00103">103</a> of file <a class="el" href="CML__Utils_8h-source.html">CML_Utils.h</a>. </td> </tr></table><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 + -