cml__ampstruct_8h-source.html

来自「美国COPLEY驱动器,程序开发工具之一.」· HTML 代码 · 共 536 行 · 第 1/5 页

HTML
536
字号
<!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_AmpStruct.h Source File</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&nbsp;Page</a> | <a class="qindex" href="hierarchy.html">Class&nbsp;Hierarchy</a> | <a class="qindex" href="classes.html">Alphabetical&nbsp;List</a> | <a class="qindex" href="annotated.html">Class&nbsp;List</a> | <a class="qindex" href="dirs.html">Directories</a> | <a class="qindex" href="files.html">File&nbsp;List</a> | <a class="qindex" href="functions.html">Class&nbsp;Members</a> | <a class="qindex" href="globals.html">File&nbsp;Members</a></div><div class="nav"><a class="el" href="dir_000001.html">inc</a></div><h1>CML_AmpStruct.h</h1><a href="CML__AmpStruct_8h.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">/************************************************************/</span><a name="l00002"></a>00002 <span class="comment">/*                                                          */</span><a name="l00003"></a>00003 <span class="comment">/*  Copley Motion Libraries                                 */</span><a name="l00004"></a>00004 <span class="comment">/*                                                          */</span><a name="l00005"></a>00005 <span class="comment">/*  Author: Stephen Glow                                    */</span><a name="l00006"></a>00006 <span class="comment">/*                                                          */</span><a name="l00007"></a>00007 <span class="comment">/*  Copyright (c) 2002-2005 Copley Controls Corp.           */</span><a name="l00008"></a>00008 <span class="comment">/*                          http://www.copleycontrols.com   */</span><a name="l00009"></a>00009 <span class="comment">/*                                                          */</span><a name="l00010"></a>00010 <span class="comment">/************************************************************/</span><a name="l00011"></a>00011 <span class="comment"></span><a name="l00012"></a>00012 <span class="comment">/** \file</span><a name="l00013"></a>00013 <span class="comment"></span><a name="l00014"></a>00014 <span class="comment">  This file contains a number of structures used to pass configuration </span><a name="l00015"></a>00015 <span class="comment">  parameters to an Amp object.</span><a name="l00016"></a>00016 <span class="comment"></span><a name="l00017"></a>00017 <span class="comment">*/</span><a name="l00018"></a>00018 <a name="l00019"></a>00019 <span class="preprocessor">#ifndef _DEF_INC_CML_AMPSTRUCT</span><a name="l00020"></a>00020 <span class="preprocessor"></span><span class="preprocessor">#define _DEF_INC_CML_AMPSTRUCT</span><a name="l00021"></a>00021 <span class="preprocessor"></span><a name="l00022"></a>00022 <span class="preprocessor">#include "<a class="code" href="CML__Error_8h.html">CML_Error.h</a>"</span><a name="l00023"></a>00023 <span class="preprocessor">#include "<a class="code" href="CML__Filter_8h.html">CML_Filter.h</a>"</span><a name="l00024"></a>00024 <span class="preprocessor">#include "<a class="code" href="CML__Settings_8h.html">CML_Settings.h</a>"</span><a name="l00025"></a>00025 <span class="preprocessor">#include "<a class="code" href="CML__Utils_8h.html">CML_Utils.h</a>"</span><a name="l00026"></a>00026 <a name="l00027"></a>00027 <a class="code" href="CML__Settings_8h.html#a11">CML_NAMESPACE_START</a>()<a name="l00028"></a>00028 <a name="l00029"></a>00029 <span class="comment">/***************************************************************************/</span><span class="comment"></span><a name="l00030"></a>00030 <span class="comment">/**</span><a name="l00031"></a>00031 <span class="comment">This class represents error conditions that can occur when loading amplifer</span><a name="l00032"></a>00032 <span class="comment">data from a data file.</span><a name="l00033"></a>00033 <span class="comment">*/</span><a name="l00034"></a>00034 <span class="comment">/***************************************************************************/</span><a name="l00035"></a><a class="code" href="classAmpFileError.html">00035</a> class <a class="code" href="classAmpFileError.html">AmpFileError</a>: public <a class="code" href="classError.html">Error</a><a name="l00036"></a>00036 {<a name="l00037"></a>00037    <span class="keyword">public</span>:<a name="l00038"></a><a class="code" href="classAmpFileError.html#s0">00038</a>       <span class="keyword">static</span> <span class="keyword">const</span> <a class="code" href="classAmpFileError.html">AmpFileError</a> format;       <span class="comment">///&lt; Amplifier file format error</span><a name="l00039"></a><a class="code" href="classAmpFileError.html#s1">00039</a> <span class="comment"></span>      <span class="keyword">static</span> <span class="keyword">const</span> <a class="code" href="classAmpFileError.html">AmpFileError</a> tooOld;       <span class="comment">///&lt; Amplifier file format is too old, use CME version 3.1 or later</span><a name="l00040"></a><a class="code" href="classAmpFileError.html#s2">00040</a> <span class="comment"></span>      <span class="keyword">static</span> <span class="keyword">const</span> <a class="code" href="classAmpFileError.html">AmpFileError</a> noFileAccess; <span class="comment">///&lt; File access was not enabled at compile time.  See CML_Settings.h</span><a name="l00041"></a><a class="code" href="classAmpFileError.html#s3">00041</a> <span class="comment"></span>      <span class="keyword">static</span> <span class="keyword">const</span> <a class="code" href="classAmpFileError.html">AmpFileError</a> fileOpen;     <span class="comment">///&lt; Error opening amplifier file</span><a name="l00042"></a><a class="code" href="classAmpFileError.html#s4">00042</a> <span class="comment"></span>      <span class="keyword">static</span> <span class="keyword">const</span> <a class="code" href="classAmpFileError.html">AmpFileError</a> range;        <span class="comment">///&lt; A parameter in the amplifier file is out of range</span><a name="l00043"></a><a class="code" href="classAmpFileError.html#s5">00043</a> <span class="comment"></span>      <span class="keyword">static</span> <span class="keyword">const</span> <a class="code" href="classAmpFileError.html">AmpFileError</a> axis;         <span class="comment">///&lt; Amplifier file is for multi axis, not supported</span><a name="l00044"></a>00044 <span class="comment"></span><a name="l00045"></a>00045    <span class="keyword">protected</span>:<span class="comment"></span><a name="l00046"></a>00046 <span class="comment">      /// Standard protected constructor</span><a name="l00047"></a><a class="code" href="classAmpFileError.html#b0">00047</a> <span class="comment"></span>      <a class="code" href="classAmpFileError.html">AmpFileError</a>( <a class="code" href="CML__Utils_8h.html#a8">uint16</a> <span class="keywordtype">id</span>, <span class="keyword">const</span> <span class="keywordtype">char</span> *desc ): Error( id, desc ){}<a name="l00048"></a>00048 };<a name="l00049"></a>00049 <a name="l00050"></a>00050 <span class="comment">/***************************************************************************/</span><span class="comment"></span><a name="l00051"></a>00051 <span class="comment">/**</span><a name="l00052"></a>00052 <span class="comment">  Amplifier characteristics data structure.</span><a name="l00053"></a>00053 <span class="comment"></span><a name="l00054"></a>00054 <span class="comment">  This structure is used to hold information about the amplifier such as it's</span><a name="l00055"></a>00055 <span class="comment">  model number, serial number, peak current rating, etc.  </span><a name="l00056"></a>00056 <span class="comment"></span><a name="l00057"></a>00057 <span class="comment">  The amplifier characteristics defined in this structure can not be changed.</span><a name="l00058"></a>00058 <span class="comment">  They are defined by Copley Controls when the amplifier is designed and/or</span><a name="l00059"></a>00059 <span class="comment">  manufactured.</span><a name="l00060"></a>00060 <span class="comment"></span><a name="l00061"></a>00061 <span class="comment">  Use the Amp::GetAmpInfo method to retrieve this information from the amplifier.</span><a name="l00062"></a>00062 <span class="comment"></span><a name="l00063"></a>00063 <span class="comment">*/</span><a name="l00064"></a>00064 <span class="comment">/***************************************************************************/</span><a name="l00065"></a><a class="code" href="structAmpInfo.html">00065</a> <span class="keyword">struct </span><a class="code" href="structAmpInfo.html">AmpInfo</a><a name="l00066"></a>00066 {<a name="l00067"></a><a class="code" href="CML__AmpStruct_8h.html#a0">00067</a> <span class="preprocessor">#define COPLEY_MAX_STRING    41</span><a name="l00068"></a>00068 <span class="preprocessor"></span><a name="l00069"></a><a class="code" href="structAmpInfo.html#o0">00069</a>    <span class="keywordtype">char</span> <a class="code" href="structAmpInfo.html#o0">model</a>[ <a class="code" href="CML__AmpStruct_8h.html#a0">COPLEY_MAX_STRING</a> ];        <span class="comment">///&lt; Model number string</span><a name="l00070"></a><a class="code" href="structAmpInfo.html#o1">00070</a> <span class="comment"></span>   <span class="keywordtype">char</span> <a class="code" href="structAmpInfo.html#o1">mfgName</a>[ <a class="code" href="CML__AmpStruct_8h.html#a0">COPLEY_MAX_STRING</a> ];      <span class="comment">///&lt; Name of the amplifier manufacturer</span><a name="l00071"></a><a class="code" href="structAmpInfo.html#o2">00071</a> <span class="comment"></span>   <span class="keywordtype">char</span> <a class="code" href="structAmpInfo.html#o2">mfgWeb</a>[ <a class="code" href="CML__AmpStruct_8h.html#a0">COPLEY_MAX_STRING</a> ];       <span class="comment">///&lt; Web address of the manufacturer</span><a name="l00072"></a><a class="code" href="structAmpInfo.html#o3">00072</a> <span class="comment"></span>   <span class="keywordtype">char</span> <a class="code" href="structAmpInfo.html#o3">mfgInfo</a>[ <a class="code" href="CML__AmpStruct_8h.html#a0">COPLEY_MAX_STRING</a> ];      <span class="comment">///&lt; Amplifier's manufacturing information string</span><a name="l00073"></a><a class="code" href="structAmpInfo.html#o4">00073</a> <span class="comment"></span>   <span class="keywordtype">char</span> <a class="code" href="structAmpInfo.html#o4">swVer</a>[ <a class="code" href="CML__AmpStruct_8h.html#a0">COPLEY_MAX_STRING</a> ];        <span class="comment">///&lt; Software version number</span><a name="l00074"></a>00074 <span class="comment"></span><a name="l00075"></a><a class="code" href="structAmpInfo.html#o5">00075</a>    <a class="code" href="CML__Utils_8h.html#a8">uint16</a> <a class="code" href="structAmpInfo.html#o5">swVerNum</a>;      <span class="comment">///&lt; Version number represented as an integer</span><a name="l00076"></a>00076 <span class="comment"></span><a name="l00077"></a><a class="code" href="structAmpInfo.html#o6">00077</a>    <a class="code" href="CML__Utils_8h.html#a10">uint32</a> <a class="code" href="structAmpInfo.html#o6">serial</a>;        <span class="comment">///&lt; Serial number</span><a name="l00078"></a><a class="code" href="structAmpInfo.html#o7">00078</a> <span class="comment"></span>   <a class="code" href="CML__Utils_8h.html#a10">uint32</a> <a class="code" href="structAmpInfo.html#o7">modes</a>;         <span class="comment">///&lt; Supported modes of operation (see DSP402 spec)</span><a name="l00079"></a>00079 <span class="comment"></span><a name="l00080"></a><a class="code" href="structAmpInfo.html#o8">00080</a>    <a class="code" href="CML__Utils_8h.html#a8">uint16</a> <a class="code" href="structAmpInfo.html#o8">crntPeak</a>;      <span class="comment">///&lt; Peak current rating (10 milliamp units)</span><a name="l00081"></a><a class="code" href="structAmpInfo.html#o9">00081</a> <span class="comment"></span>   <a class="code" href="CML__Utils_8h.html#a8">uint16</a> <a class="code" href="structAmpInfo.html#o9">crntCont</a>;      <span class="comment">///&lt; Continuous current rating (10 milliamp units)</span><a name="l00082"></a><a class="code" href="structAmpInfo.html#o10">00082</a> <span class="comment"></span>   <a class="code" href="CML__Utils_8h.html#a8">uint16</a> <a class="code" href="structAmpInfo.html#o10">crntTime</a>;      <span class="comment">///&lt; Time at peak current (milliseconds)</span><a name="l00083"></a>00083 <span class="comment"></span><a name="l00084"></a><a class="code" href="structAmpInfo.html#o11">00084</a>    <a class="code" href="CML__Utils_8h.html#a8">uint16</a> <a class="code" href="structAmpInfo.html#o11">voltMax</a>;       <span class="comment">///&lt; Max bus voltage (100 millivolt units)</span><a name="l00085"></a><a class="code" href="structAmpInfo.html#o12">00085</a> <span class="comment"></span>   <a class="code" href="CML__Utils_8h.html#a8">uint16</a> <a class="code" href="structAmpInfo.html#o12">voltMin</a>;       <span class="comment">///&lt; Min bus voltage (100 millivolt units)</span><a name="l00086"></a><a class="code" href="structAmpInfo.html#o13">00086</a> <span class="comment"></span>   <a class="code" href="CML__Utils_8h.html#a8">uint16</a> <a class="code" href="structAmpInfo.html#o13">voltHyst</a>;      <span class="comment">///&lt; Bus voltage hysteresis for over voltage shutdown (100 millivolt units)</span><a name="l00087"></a>00087 <span class="comment"></span><a name="l00088"></a><a class="code" href="structAmpInfo.html#o14">00088</a>    <a class="code" href="CML__Utils_8h.html#a8">uint16</a> <a class="code" href="structAmpInfo.html#o14">tempMax</a>;       <span class="comment">///&lt; Max temperature (deg C)</span><a name="l00089"></a><a class="code" href="structAmpInfo.html#o15">00089</a> <span class="comment"></span>   <a class="code" href="CML__Utils_8h.html#a8">uint16</a> <a class="code" href="structAmpInfo.html#o15">tempHyst</a>;      <span class="comment">///&lt; Temperature hysteresis for over temp shutdown (deg C)</span><a name="l00090"></a>00090 <span class="comment"></span><a name="l00091"></a><a class="code" href="structAmpInfo.html#o16">00091</a>    <a class="code" href="CML__Utils_8h.html#a8">uint16</a> <a class="code" href="structAmpInfo.html#o16">pwmPeriod</a>;     <span class="comment">///&lt; PWM period (10 nanosecond units)</span><a name="l00092"></a><a class="code" href="structAmpInfo.html#o17">00092</a> <span class="comment"></span>   <a class="code" href="CML__Utils_8h.html#a8">uint16</a> <a class="code" href="structAmpInfo.html#o17">servoPeriod</a>;   <span class="comment">///&lt; Servo period (multiples of PWM period)</span><a name="l00093"></a>00093 <span class="comment"></span><a name="l00094"></a>00094    <span class="comment">// The following values or primarily for internal use by Copley</span><a name="l00095"></a><a class="code" href="structAmpInfo.html#o18">00095</a>    <a class="code" href="CML__Utils_8h.html#a7">int16</a> <a class="code" href="structAmpInfo.html#o18">crntScale</a>;      <span class="comment">///&lt; Current scaling factor </span><a name="l00096"></a><a class="code" href="structAmpInfo.html#o19">00096</a> <span class="comment"></span>   <a class="code" href="CML__Utils_8h.html#a7">int16</a> <a class="code" href="structAmpInfo.html#o19">voltScale</a>;      <span class="comment">///&lt; Voltage scaling factor</span><a name="l00097"></a><a class="code" href="structAmpInfo.html#o20">00097</a> <span class="comment"></span>   <a class="code" href="CML__Utils_8h.html#a7">int16</a> <a class="code" href="structAmpInfo.html#o20">refScale</a>;       <span class="comment">///&lt; Reference scaling factor</span><a name="l00098"></a><a class="code" href="structAmpInfo.html#o21">00098</a> <span class="comment"></span>   <a class="code" href="CML__Utils_8h.html#a7">int16</a> <a class="code" href="structAmpInfo.html#o21">aencScale</a>;      <span class="comment">///&lt; Analog encoder scaling factor</span><a name="l00099"></a><a class="code" href="structAmpInfo.html#o22">00099</a> <span class="comment"></span>   <a class="code" href="CML__Utils_8h.html#a7">int16</a> <a class="code" href="structAmpInfo.html#o22">type</a>;           <span class="comment">///&lt; Amp type</span>

⌨️ 快捷键说明

复制代码Ctrl + C
搜索代码Ctrl + F
全屏模式F11
增大字号Ctrl + =
减小字号Ctrl + -
显示快捷键?