371 lines
16 KiB
XML
371 lines
16 KiB
XML
<?xml version='1.0' encoding='UTF-8' standalone='no'?>
|
|
<section xmlns="http://docbook.org/ns/docbook" version="5.0" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="_classbsp___position___p_i_d" xml:lang="zh">
|
|
<title>bsp_Position_PID类 参考</title>
|
|
<indexterm><primary>bsp_Position_PID</primary></indexterm>
|
|
<para>
|
|
|
|
<para>位置法为基础的PID算法 </para>
|
|
|
|
</para>
|
|
<para>
|
|
<computeroutput>#include <bsp_PID.h></computeroutput>
|
|
</para>
|
|
<simplesect>
|
|
<title>Public 成员函数 </title>
|
|
<itemizedlist>
|
|
<listitem><para><link linkend="_classbsp___position___p_i_d_1ac50b1ff29153eed1fcb252a3eee2aa69">bsp_Position_PID</link> (void)</para>
|
|
</listitem>
|
|
<listitem><para><link linkend="_classbsp___position___p_i_d_1aa16c488294e5bfba71c8ef83ee76a250">bsp_Position_PID</link> (float <link linkend="_classbsp___position___p_i_d_1aa2ea863045a5bc0785693013154b6a52">Kp</link>, float <link linkend="_classbsp___position___p_i_d_1a58c60be7603ec356bbe428fb989d4e68">Ki</link>, float <link linkend="_classbsp___position___p_i_d_1a1678e1ea6b9e6ea56fde93df5aad4f75">Kd</link>, float <link linkend="_classbsp___position___p_i_d_1a04921569cfe25681f8763beaae01c1bc">target</link>, float <link linkend="_classbsp___position___p_i_d_1a08bba095208d3dcdb8c07e741dc3a77a">result_H</link>, float <link linkend="_classbsp___position___p_i_d_1a42a8eb4e1c96871e1b4eacb0cf46e196">result_L</link>)</para>
|
|
|
|
<para>PID算法 </para>
|
|
</listitem>
|
|
<listitem><para><link linkend="_classbsp___position___p_i_d_1a9cd33ec75d5ca15939d132644d4ceea8">~bsp_Position_PID</link> (void)</para>
|
|
</listitem>
|
|
<listitem><para>float <link linkend="_classbsp___position___p_i_d_1ac658466d8bc1d12fcd403c4b6f9ca9f7">PID</link> (float temp)</para>
|
|
|
|
<para>PID算法 </para>
|
|
</listitem>
|
|
<listitem><para>void <link linkend="_classbsp___position___p_i_d_1a7b60d7f8a80c632c501561e7e0765f14">clean</link> (void)</para>
|
|
|
|
<para>清理历史数据 </para>
|
|
</listitem>
|
|
<listitem><para>void <link linkend="_classbsp___position___p_i_d_1add37a6f47b3f9b6dd0d945def8ed2ef1">set</link> (float P, float I, float D)</para>
|
|
|
|
<para>PID参数设置 </para>
|
|
</listitem>
|
|
</itemizedlist>
|
|
</simplesect>
|
|
<simplesect>
|
|
<title>Public 属性 </title>
|
|
<itemizedlist>
|
|
<listitem><para>float <link linkend="_classbsp___position___p_i_d_1a04921569cfe25681f8763beaae01c1bc">target</link></para>
|
|
|
|
<para>设定值 </para>
|
|
</listitem>
|
|
<listitem><para>float <link linkend="_classbsp___position___p_i_d_1aa2ea863045a5bc0785693013154b6a52">Kp</link></para>
|
|
|
|
<para>比例系数 </para>
|
|
</listitem>
|
|
<listitem><para>float <link linkend="_classbsp___position___p_i_d_1a1678e1ea6b9e6ea56fde93df5aad4f75">Kd</link></para>
|
|
|
|
<para>积分系数 </para>
|
|
</listitem>
|
|
<listitem><para>float <link linkend="_classbsp___position___p_i_d_1a58c60be7603ec356bbe428fb989d4e68">Ki</link></para>
|
|
|
|
<para>微分系数 </para>
|
|
</listitem>
|
|
<listitem><para>float <link linkend="_classbsp___position___p_i_d_1a77ecc1d6378fb03cc63c9a3a263c90b2">result</link></para>
|
|
|
|
<para>输出值 </para>
|
|
</listitem>
|
|
</itemizedlist>
|
|
</simplesect>
|
|
<simplesect>
|
|
<title>Private 属性 </title>
|
|
<itemizedlist>
|
|
<listitem><para>float <link linkend="_classbsp___position___p_i_d_1a9e7c0b93c1936f3aca77800997f99c05">integral</link></para>
|
|
|
|
<para>积分值 </para>
|
|
</listitem>
|
|
<listitem><para>float <link linkend="_classbsp___position___p_i_d_1a04a54e038d2229f330e1913ce8b8aada">lasterror</link></para>
|
|
|
|
<para>前一拍偏差 </para>
|
|
</listitem>
|
|
<listitem><para>float <link linkend="_classbsp___position___p_i_d_1a08bba095208d3dcdb8c07e741dc3a77a">result_H</link></para>
|
|
|
|
<para>输出最高值 </para>
|
|
</listitem>
|
|
<listitem><para>float <link linkend="_classbsp___position___p_i_d_1a42a8eb4e1c96871e1b4eacb0cf46e196">result_L</link></para>
|
|
|
|
<para>输出最低值 </para>
|
|
</listitem>
|
|
</itemizedlist>
|
|
</simplesect>
|
|
<section>
|
|
<title>详细描述</title>
|
|
|
|
<para>位置法为基础的PID算法 </para>
|
|
<para>
|
|
在文件 <link linkend="_bsp___p_i_d_8h_source">bsp_PID.h</link> 第 <link linkend="_bsp___p_i_d_8h_source_1l00043">43</link> 行定义.</para>
|
|
</section>
|
|
<section>
|
|
<title>构造及析构函数说明</title>
|
|
<anchor xml:id="_classbsp___position___p_i_d_1ac50b1ff29153eed1fcb252a3eee2aa69"/><section>
|
|
<title>bsp_Position_PID()<computeroutput>[1/2]</computeroutput></title>
|
|
<indexterm><primary>bsp_Position_PID</primary><secondary>bsp_Position_PID</secondary></indexterm>
|
|
<indexterm><primary>bsp_Position_PID</primary><secondary>bsp_Position_PID</secondary></indexterm>
|
|
<para><computeroutput>bsp_Position_PID::bsp_Position_PID (void )</computeroutput></para><para>
|
|
在文件 <link linkend="_bsp___p_i_d_8cpp_source">bsp_PID.cpp</link> 第 <link linkend="_bsp___p_i_d_8cpp_source_1l00134">134</link> 行定义.</para>
|
|
</section>
|
|
<anchor xml:id="_classbsp___position___p_i_d_1aa16c488294e5bfba71c8ef83ee76a250"/><section>
|
|
<title>bsp_Position_PID()<computeroutput>[2/2]</computeroutput></title>
|
|
<indexterm><primary>bsp_Position_PID</primary><secondary>bsp_Position_PID</secondary></indexterm>
|
|
<indexterm><primary>bsp_Position_PID</primary><secondary>bsp_Position_PID</secondary></indexterm>
|
|
<para><computeroutput>bsp_Position_PID::bsp_Position_PID (float Kp, float Ki, float Kd, float target, float result_H, float result_L)</computeroutput></para><para>
|
|
|
|
<para>PID算法 </para>
|
|
</para>
|
|
|
|
<para>
|
|
<formalpara>
|
|
<title>
|
|
参数</title>
|
|
<para>
|
|
<table frame="all">
|
|
<tgroup cols="2" align="left" colsep="1" rowsep="1">
|
|
<colspec colwidth="1*"/>
|
|
<colspec colwidth="4*"/>
|
|
<tbody>
|
|
<row>
|
|
<entry>Kp</entry><entry>
|
|
<para>P参数 </para>
|
|
</entry>
|
|
</row>
|
|
<row>
|
|
<entry>Ki</entry><entry>
|
|
<para>I参数 </para>
|
|
</entry>
|
|
</row>
|
|
<row>
|
|
<entry>Kd</entry><entry>
|
|
<para>D参数 </para>
|
|
</entry>
|
|
</row>
|
|
<row>
|
|
<entry>target</entry><entry>
|
|
<para>目标值 </para>
|
|
</entry>
|
|
</row>
|
|
<row>
|
|
<entry>result_H</entry><entry>
|
|
<para>输出最大值 </para>
|
|
</entry>
|
|
</row>
|
|
<row>
|
|
<entry>result_L</entry><entry>
|
|
<para>输出最小值 </para>
|
|
</entry>
|
|
</row>
|
|
</tbody>
|
|
</tgroup>
|
|
</table>
|
|
</para>
|
|
</formalpara>
|
|
</para>
|
|
<para>
|
|
在文件 <link linkend="_bsp___p_i_d_8cpp_source">bsp_PID.cpp</link> 第 <link linkend="_bsp___p_i_d_8cpp_source_1l00155">155</link> 行定义.</para>
|
|
</section>
|
|
<anchor xml:id="_classbsp___position___p_i_d_1a9cd33ec75d5ca15939d132644d4ceea8"/><section>
|
|
<title>~bsp_Position_PID()</title>
|
|
<indexterm><primary>~bsp_Position_PID</primary><secondary>bsp_Position_PID</secondary></indexterm>
|
|
<indexterm><primary>bsp_Position_PID</primary><secondary>~bsp_Position_PID</secondary></indexterm>
|
|
<para><computeroutput>bsp_Position_PID::~bsp_Position_PID (void )</computeroutput></para><para>
|
|
在文件 <link linkend="_bsp___p_i_d_8cpp_source">bsp_PID.cpp</link> 第 <link linkend="_bsp___p_i_d_8cpp_source_1l00169">169</link> 行定义.</para>
|
|
</section>
|
|
</section>
|
|
<section>
|
|
<title>成员函数说明</title>
|
|
<anchor xml:id="_classbsp___position___p_i_d_1a7b60d7f8a80c632c501561e7e0765f14"/><section>
|
|
<title>clean()</title>
|
|
<indexterm><primary>clean</primary><secondary>bsp_Position_PID</secondary></indexterm>
|
|
<indexterm><primary>bsp_Position_PID</primary><secondary>clean</secondary></indexterm>
|
|
<para><computeroutput>void bsp_Position_PID::clean (void )</computeroutput></para><para>
|
|
|
|
<para>清理历史数据 </para>
|
|
</para>
|
|
|
|
<para><formalpara><title>返回</title>
|
|
|
|
<para>清除PID运算数据 </para>
|
|
</formalpara>
|
|
</para>
|
|
<para>
|
|
在文件 <link linkend="_bsp___p_i_d_8cpp_source">bsp_PID.cpp</link> 第 <link linkend="_bsp___p_i_d_8cpp_source_1l00096">96</link> 行定义.</para>
|
|
</section>
|
|
<anchor xml:id="_classbsp___position___p_i_d_1ac658466d8bc1d12fcd403c4b6f9ca9f7"/><section>
|
|
<title>PID()</title>
|
|
<indexterm><primary>PID</primary><secondary>bsp_Position_PID</secondary></indexterm>
|
|
<indexterm><primary>bsp_Position_PID</primary><secondary>PID</secondary></indexterm>
|
|
<para><computeroutput>float bsp_Position_PID::PID (float temp)</computeroutput></para><para>
|
|
|
|
<para>PID算法 </para>
|
|
</para>
|
|
|
|
<para>
|
|
<formalpara>
|
|
<title>
|
|
参数</title>
|
|
<para>
|
|
<table frame="all">
|
|
<tgroup cols="2" align="left" colsep="1" rowsep="1">
|
|
<colspec colwidth="1*"/>
|
|
<colspec colwidth="4*"/>
|
|
<tbody>
|
|
<row>
|
|
<entry>temp</entry><entry>
|
|
<para>目前变量 </para>
|
|
</entry>
|
|
</row>
|
|
</tbody>
|
|
</tgroup>
|
|
</table>
|
|
</para>
|
|
</formalpara>
|
|
<formalpara><title>返回</title>
|
|
|
|
<para>返回调整量 </para>
|
|
</formalpara>
|
|
</para>
|
|
<para>
|
|
在文件 <link linkend="_bsp___p_i_d_8cpp_source">bsp_PID.cpp</link> 第 <link linkend="_bsp___p_i_d_8cpp_source_1l00048">48</link> 行定义.</para>
|
|
</section>
|
|
<anchor xml:id="_classbsp___position___p_i_d_1add37a6f47b3f9b6dd0d945def8ed2ef1"/><section>
|
|
<title>set()</title>
|
|
<indexterm><primary>set</primary><secondary>bsp_Position_PID</secondary></indexterm>
|
|
<indexterm><primary>bsp_Position_PID</primary><secondary>set</secondary></indexterm>
|
|
<para><computeroutput>void bsp_Position_PID::set (float P, float I, float D)</computeroutput></para><para>
|
|
|
|
<para>PID参数设置 </para>
|
|
</para>
|
|
|
|
<para>
|
|
<formalpara>
|
|
<title>
|
|
参数</title>
|
|
<para>
|
|
<table frame="all">
|
|
<tgroup cols="2" align="left" colsep="1" rowsep="1">
|
|
<colspec colwidth="1*"/>
|
|
<colspec colwidth="4*"/>
|
|
<tbody>
|
|
<row>
|
|
<entry>P</entry><entry>
|
|
<para>P参数 </para>
|
|
</entry>
|
|
</row>
|
|
<row>
|
|
<entry>I</entry><entry>
|
|
<para>I参数 </para>
|
|
</entry>
|
|
</row>
|
|
<row>
|
|
<entry>D</entry><entry>
|
|
<para>D参数 </para>
|
|
</entry>
|
|
</row>
|
|
</tbody>
|
|
</tgroup>
|
|
</table>
|
|
</para>
|
|
</formalpara>
|
|
</para>
|
|
<para>
|
|
在文件 <link linkend="_bsp___p_i_d_8cpp_source">bsp_PID.cpp</link> 第 <link linkend="_bsp___p_i_d_8cpp_source_1l00119">119</link> 行定义.</para>
|
|
</section>
|
|
</section>
|
|
<section>
|
|
<title>类成员变量说明</title>
|
|
<anchor xml:id="_classbsp___position___p_i_d_1a9e7c0b93c1936f3aca77800997f99c05"/><section>
|
|
<title>integral</title>
|
|
<indexterm><primary>integral</primary><secondary>bsp_Position_PID</secondary></indexterm>
|
|
<indexterm><primary>bsp_Position_PID</primary><secondary>integral</secondary></indexterm>
|
|
<para><computeroutput>float bsp_Position_PID::integral<computeroutput>[private]</computeroutput></computeroutput></para><para>
|
|
|
|
<para>积分值 </para>
|
|
</para>
|
|
<para>
|
|
在文件 <link linkend="_bsp___p_i_d_8h_source">bsp_PID.h</link> 第 <link linkend="_bsp___p_i_d_8h_source_1l00061">61</link> 行定义.</para>
|
|
</section>
|
|
<anchor xml:id="_classbsp___position___p_i_d_1a1678e1ea6b9e6ea56fde93df5aad4f75"/><section>
|
|
<title>Kd</title>
|
|
<indexterm><primary>Kd</primary><secondary>bsp_Position_PID</secondary></indexterm>
|
|
<indexterm><primary>bsp_Position_PID</primary><secondary>Kd</secondary></indexterm>
|
|
<para><computeroutput>float bsp_Position_PID::Kd</computeroutput></para><para>
|
|
|
|
<para>积分系数 </para>
|
|
</para>
|
|
<para>
|
|
在文件 <link linkend="_bsp___p_i_d_8h_source">bsp_PID.h</link> 第 <link linkend="_bsp___p_i_d_8h_source_1l00057">57</link> 行定义.</para>
|
|
</section>
|
|
<anchor xml:id="_classbsp___position___p_i_d_1a58c60be7603ec356bbe428fb989d4e68"/><section>
|
|
<title>Ki</title>
|
|
<indexterm><primary>Ki</primary><secondary>bsp_Position_PID</secondary></indexterm>
|
|
<indexterm><primary>bsp_Position_PID</primary><secondary>Ki</secondary></indexterm>
|
|
<para><computeroutput>float bsp_Position_PID::Ki</computeroutput></para><para>
|
|
|
|
<para>微分系数 </para>
|
|
</para>
|
|
<para>
|
|
在文件 <link linkend="_bsp___p_i_d_8h_source">bsp_PID.h</link> 第 <link linkend="_bsp___p_i_d_8h_source_1l00058">58</link> 行定义.</para>
|
|
</section>
|
|
<anchor xml:id="_classbsp___position___p_i_d_1aa2ea863045a5bc0785693013154b6a52"/><section>
|
|
<title>Kp</title>
|
|
<indexterm><primary>Kp</primary><secondary>bsp_Position_PID</secondary></indexterm>
|
|
<indexterm><primary>bsp_Position_PID</primary><secondary>Kp</secondary></indexterm>
|
|
<para><computeroutput>float bsp_Position_PID::Kp</computeroutput></para><para>
|
|
|
|
<para>比例系数 </para>
|
|
</para>
|
|
<para>
|
|
在文件 <link linkend="_bsp___p_i_d_8h_source">bsp_PID.h</link> 第 <link linkend="_bsp___p_i_d_8h_source_1l00056">56</link> 行定义.</para>
|
|
</section>
|
|
<anchor xml:id="_classbsp___position___p_i_d_1a04a54e038d2229f330e1913ce8b8aada"/><section>
|
|
<title>lasterror</title>
|
|
<indexterm><primary>lasterror</primary><secondary>bsp_Position_PID</secondary></indexterm>
|
|
<indexterm><primary>bsp_Position_PID</primary><secondary>lasterror</secondary></indexterm>
|
|
<para><computeroutput>float bsp_Position_PID::lasterror<computeroutput>[private]</computeroutput></computeroutput></para><para>
|
|
|
|
<para>前一拍偏差 </para>
|
|
</para>
|
|
<para>
|
|
在文件 <link linkend="_bsp___p_i_d_8h_source">bsp_PID.h</link> 第 <link linkend="_bsp___p_i_d_8h_source_1l00062">62</link> 行定义.</para>
|
|
</section>
|
|
<anchor xml:id="_classbsp___position___p_i_d_1a77ecc1d6378fb03cc63c9a3a263c90b2"/><section>
|
|
<title>result</title>
|
|
<indexterm><primary>result</primary><secondary>bsp_Position_PID</secondary></indexterm>
|
|
<indexterm><primary>bsp_Position_PID</primary><secondary>result</secondary></indexterm>
|
|
<para><computeroutput>float bsp_Position_PID::result</computeroutput></para><para>
|
|
|
|
<para>输出值 </para>
|
|
</para>
|
|
<para>
|
|
在文件 <link linkend="_bsp___p_i_d_8h_source">bsp_PID.h</link> 第 <link linkend="_bsp___p_i_d_8h_source_1l00059">59</link> 行定义.</para>
|
|
</section>
|
|
<anchor xml:id="_classbsp___position___p_i_d_1a08bba095208d3dcdb8c07e741dc3a77a"/><section>
|
|
<title>result_H</title>
|
|
<indexterm><primary>result_H</primary><secondary>bsp_Position_PID</secondary></indexterm>
|
|
<indexterm><primary>bsp_Position_PID</primary><secondary>result_H</secondary></indexterm>
|
|
<para><computeroutput>float bsp_Position_PID::result_H<computeroutput>[private]</computeroutput></computeroutput></para><para>
|
|
|
|
<para>输出最高值 </para>
|
|
</para>
|
|
<para>
|
|
在文件 <link linkend="_bsp___p_i_d_8h_source">bsp_PID.h</link> 第 <link linkend="_bsp___p_i_d_8h_source_1l00064">64</link> 行定义.</para>
|
|
</section>
|
|
<anchor xml:id="_classbsp___position___p_i_d_1a42a8eb4e1c96871e1b4eacb0cf46e196"/><section>
|
|
<title>result_L</title>
|
|
<indexterm><primary>result_L</primary><secondary>bsp_Position_PID</secondary></indexterm>
|
|
<indexterm><primary>bsp_Position_PID</primary><secondary>result_L</secondary></indexterm>
|
|
<para><computeroutput>float bsp_Position_PID::result_L<computeroutput>[private]</computeroutput></computeroutput></para><para>
|
|
|
|
<para>输出最低值 </para>
|
|
</para>
|
|
<para>
|
|
在文件 <link linkend="_bsp___p_i_d_8h_source">bsp_PID.h</link> 第 <link linkend="_bsp___p_i_d_8h_source_1l00065">65</link> 行定义.</para>
|
|
</section>
|
|
<anchor xml:id="_classbsp___position___p_i_d_1a04921569cfe25681f8763beaae01c1bc"/><section>
|
|
<title>target</title>
|
|
<indexterm><primary>target</primary><secondary>bsp_Position_PID</secondary></indexterm>
|
|
<indexterm><primary>bsp_Position_PID</primary><secondary>target</secondary></indexterm>
|
|
<para><computeroutput>float bsp_Position_PID::target</computeroutput></para><para>
|
|
|
|
<para>设定值 </para>
|
|
</para>
|
|
<para>
|
|
在文件 <link linkend="_bsp___p_i_d_8h_source">bsp_PID.h</link> 第 <link linkend="_bsp___p_i_d_8h_source_1l00055">55</link> 行定义.</para>
|
|
</section>
|
|
<para>
|
|
该类的文档由以下文件生成:</para>
|
|
D:/gitt/MicrochipFor32/bsp_Device/<link linkend="_bsp___p_i_d_8h">bsp_PID.h</link>D:/gitt/MicrochipFor32/bsp_Device/<link linkend="_bsp___p_i_d_8cpp">bsp_PID.cpp</link></section>
|
|
</section>
|