Files
MicrochipFor32/Doc/xml/classbsp___integral.xml

328 lines
21 KiB
XML
Raw Normal View History

2022-11-24 23:56:57 +08:00
<?xml version='1.0' encoding='UTF-8' standalone='no'?>
<doxygen xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="compound.xsd" version="1.9.5" xml:lang="zh">
<compounddef id="classbsp___integral" kind="class" language="C++" prot="public">
<compoundname>bsp_Integral</compoundname>
<includes refid="bsp___calculus_8h" local="no">bsp_Calculus.h</includes>
<sectiondef kind="public-attrib">
<memberdef kind="variable" id="classbsp___integral_1a656d90c5a713abf0665f1dcbf1a5101a" prot="public" static="no" mutable="no">
<type>float *</type>
<definition>float* bsp_Integral::result_list</definition>
<argsstring></argsstring>
<name>result_list</name>
<qualifiedname>bsp_Integral::result_list</qualifiedname>
<briefdescription>
<para>数据历史 </para>
</briefdescription>
<detaileddescription>
</detaileddescription>
<inbodydescription>
</inbodydescription>
<location file="D:/gitt/MicrochipFor32/bsp_Device/bsp_Calculus.h" line="77" column="6" bodyfile="D:/gitt/MicrochipFor32/bsp_Device/bsp_Calculus.h" bodystart="77" bodyend="-1"/>
<referencedby refid="classbsp___integral_1af274273b399f4da855646921f3ae31ba" compoundref="bsp___calculus_8h" startline="61" endline="64">bsp_Integral</referencedby>
<referencedby refid="classbsp___integral_1aae2b6143ca39861a83b77befc131bf5e" compoundref="bsp___calculus_8cpp" startline="113" endline="116">Integral_clslist</referencedby>
<referencedby refid="classbsp___integral_1a47307ddf418d2686245b118dcf61a199" compoundref="bsp___calculus_8cpp" startline="105" endline="108">Integral_dellist</referencedby>
<referencedby refid="classbsp___integral_1a80693e18b9b9509bdec0ebfd72f84072" compoundref="bsp___calculus_8cpp" startline="86" endline="100">Integral_list</referencedby>
<referencedby refid="classbsp___integral_1a86d9e02d1146744fe80ebab69070abb4" compoundref="bsp___calculus_8cpp" startline="75" endline="79">Integral_makelist</referencedby>
<referencedby refid="classbsp___integral_1a3f190eb273b4d6492fb39e2573ec37a1" compoundref="bsp___calculus_8h" startline="65" endline="67">~bsp_Integral</referencedby>
</memberdef>
<memberdef kind="variable" id="classbsp___integral_1a662c735b9432a46e48a642ebb9c0e8fa" prot="public" static="no" mutable="no">
<type><ref refid="varint_8h_1afaa62991928fb9fb18ff0db62a040aba" kindref="member">u32</ref></type>
<definition>u32 bsp_Integral::result_len</definition>
<argsstring></argsstring>
<name>result_len</name>
<qualifiedname>bsp_Integral::result_len</qualifiedname>
<briefdescription>
<para>历史缓冲区长度 </para>
</briefdescription>
<detaileddescription>
</detaileddescription>
<inbodydescription>
</inbodydescription>
<location file="D:/gitt/MicrochipFor32/bsp_Device/bsp_Calculus.h" line="78" column="4" bodyfile="D:/gitt/MicrochipFor32/bsp_Device/bsp_Calculus.h" bodystart="78" bodyend="-1"/>
<referencedby refid="classbsp___integral_1aae2b6143ca39861a83b77befc131bf5e" compoundref="bsp___calculus_8cpp" startline="113" endline="116">Integral_clslist</referencedby>
<referencedby refid="classbsp___integral_1a47307ddf418d2686245b118dcf61a199" compoundref="bsp___calculus_8cpp" startline="105" endline="108">Integral_dellist</referencedby>
<referencedby refid="classbsp___integral_1a80693e18b9b9509bdec0ebfd72f84072" compoundref="bsp___calculus_8cpp" startline="86" endline="100">Integral_list</referencedby>
<referencedby refid="classbsp___integral_1a86d9e02d1146744fe80ebab69070abb4" compoundref="bsp___calculus_8cpp" startline="75" endline="79">Integral_makelist</referencedby>
</memberdef>
<memberdef kind="variable" id="classbsp___integral_1a910f1f3faa2b4963e00718472b8389bc" prot="public" static="no" mutable="no">
<type>float</type>
<definition>float bsp_Integral::results</definition>
<argsstring></argsstring>
<name>results</name>
<qualifiedname>bsp_Integral::results</qualifiedname>
<briefdescription>
<para>积分缓存 </para>
</briefdescription>
<detaileddescription>
</detaileddescription>
<inbodydescription>
</inbodydescription>
<location file="D:/gitt/MicrochipFor32/bsp_Device/bsp_Calculus.h" line="79" column="6" bodyfile="D:/gitt/MicrochipFor32/bsp_Device/bsp_Calculus.h" bodystart="79" bodyend="-1"/>
<referencedby refid="classbsp___integral_1af274273b399f4da855646921f3ae31ba" compoundref="bsp___calculus_8h" startline="61" endline="64">bsp_Integral</referencedby>
<referencedby refid="classbsp___integral_1ade46f89bfdc6dd778c045a51c76c1839" compoundref="bsp___calculus_8cpp" startline="59" endline="61">Integral</referencedby>
<referencedby refid="classbsp___integral_1a80693e18b9b9509bdec0ebfd72f84072" compoundref="bsp___calculus_8cpp" startline="86" endline="100">Integral_list</referencedby>
<referencedby refid="classbsp___integral_1aaf7474301ed76ca9ce2b1884ae870019" compoundref="bsp___calculus_8cpp" startline="67" endline="68">Integral_set</referencedby>
</memberdef>
<memberdef kind="variable" id="classbsp___integral_1a4494cf9fc2873d457ed3bf8618b68045" prot="public" static="no" mutable="no">
<type>float</type>
<definition>float bsp_Integral::dt</definition>
<argsstring></argsstring>
<name>dt</name>
<qualifiedname>bsp_Integral::dt</qualifiedname>
<briefdescription>
<para>时间参数 </para>
</briefdescription>
<detaileddescription>
</detaileddescription>
<inbodydescription>
</inbodydescription>
<location file="D:/gitt/MicrochipFor32/bsp_Device/bsp_Calculus.h" line="80" column="6" bodyfile="D:/gitt/MicrochipFor32/bsp_Device/bsp_Calculus.h" bodystart="80" bodyend="-1"/>
<referencedby refid="classbsp___integral_1af274273b399f4da855646921f3ae31ba" compoundref="bsp___calculus_8h" startline="61" endline="64">bsp_Integral</referencedby>
<referencedby refid="classbsp___integral_1ade46f89bfdc6dd778c045a51c76c1839" compoundref="bsp___calculus_8cpp" startline="59" endline="61">Integral</referencedby>
<referencedby refid="classbsp___integral_1a80693e18b9b9509bdec0ebfd72f84072" compoundref="bsp___calculus_8cpp" startline="86" endline="100">Integral_list</referencedby>
</memberdef>
</sectiondef>
<sectiondef kind="public-func">
<memberdef kind="function" id="classbsp___integral_1af274273b399f4da855646921f3ae31ba" prot="public" static="no" const="no" explicit="no" inline="yes" virt="non-virtual">
<type></type>
<definition>bsp_Integral::bsp_Integral</definition>
<argsstring>(float dt)</argsstring>
<name>bsp_Integral</name>
<qualifiedname>bsp_Integral::bsp_Integral</qualifiedname>
<param>
<type>float</type>
<declname>dt</declname>
</param>
<briefdescription>
</briefdescription>
<detaileddescription>
</detaileddescription>
<inbodydescription>
</inbodydescription>
<location file="D:/gitt/MicrochipFor32/bsp_Device/bsp_Calculus.h" line="61" column="1" bodyfile="D:/gitt/MicrochipFor32/bsp_Device/bsp_Calculus.h" bodystart="61" bodyend="64"/>
<references refid="classbsp___integral_1a4494cf9fc2873d457ed3bf8618b68045" compoundref="bsp___calculus_8h" startline="80">dt</references>
<references refid="classbsp___integral_1a656d90c5a713abf0665f1dcbf1a5101a" compoundref="bsp___calculus_8h" startline="77">result_list</references>
<references refid="classbsp___integral_1a910f1f3faa2b4963e00718472b8389bc" compoundref="bsp___calculus_8h" startline="79">results</references>
</memberdef>
<memberdef kind="function" id="classbsp___integral_1a3f190eb273b4d6492fb39e2573ec37a1" prot="public" static="no" const="no" explicit="no" inline="yes" virt="non-virtual">
<type></type>
<definition>bsp_Integral::~bsp_Integral</definition>
<argsstring>(void)</argsstring>
<name>~bsp_Integral</name>
<qualifiedname>bsp_Integral::~bsp_Integral</qualifiedname>
<param>
<type>void</type>
</param>
<briefdescription>
</briefdescription>
<detaileddescription>
</detaileddescription>
<inbodydescription>
</inbodydescription>
<location file="D:/gitt/MicrochipFor32/bsp_Device/bsp_Calculus.h" line="65" column="1" bodyfile="D:/gitt/MicrochipFor32/bsp_Device/bsp_Calculus.h" bodystart="65" bodyend="67"/>
<references refid="classbsp___integral_1a656d90c5a713abf0665f1dcbf1a5101a" compoundref="bsp___calculus_8h" startline="77">result_list</references>
</memberdef>
<memberdef kind="function" id="classbsp___integral_1ade46f89bfdc6dd778c045a51c76c1839" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
<type>float</type>
<definition>float bsp_Integral::Integral</definition>
<argsstring>(float var)</argsstring>
<name>Integral</name>
<qualifiedname>bsp_Integral::Integral</qualifiedname>
<param>
<type>float</type>
<declname>var</declname>
</param>
<briefdescription>
<para>对数据积分 </para>
</briefdescription>
<detaileddescription>
<para><parameterlist kind="param"><parameteritem>
<parameternamelist>
<parametername>var</parametername>
</parameternamelist>
<parameterdescription>
<para>此处填入浮点数据 </para>
</parameterdescription>
</parameteritem>
</parameterlist>
<simplesect kind="return"><para>从开始到现在的总积分值 </para>
</simplesect>
</para>
</detaileddescription>
<inbodydescription>
</inbodydescription>
<location file="D:/gitt/MicrochipFor32/bsp_Device/bsp_Calculus.h" line="69" column="7" bodyfile="D:/gitt/MicrochipFor32/bsp_Device/bsp_Calculus.cpp" bodystart="59" bodyend="61"/>
<references refid="classbsp___integral_1a4494cf9fc2873d457ed3bf8618b68045" compoundref="bsp___calculus_8h" startline="80">dt</references>
<references refid="classbsp___integral_1a910f1f3faa2b4963e00718472b8389bc" compoundref="bsp___calculus_8h" startline="79">results</references>
</memberdef>
<memberdef kind="function" id="classbsp___integral_1aaf7474301ed76ca9ce2b1884ae870019" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
<type>void</type>
<definition>void bsp_Integral::Integral_set</definition>
<argsstring>(float results)</argsstring>
<name>Integral_set</name>
<qualifiedname>bsp_Integral::Integral_set</qualifiedname>
<param>
<type>float</type>
<declname>results</declname>
</param>
<briefdescription>
<para>重设当前积分值 </para>
</briefdescription>
<detaileddescription>
<para><parameterlist kind="param"><parameteritem>
<parameternamelist>
<parametername>var</parametername>
</parameternamelist>
<parameterdescription>
<para>要设置的积分值 </para>
</parameterdescription>
</parameteritem>
</parameterlist>
</para>
</detaileddescription>
<inbodydescription>
</inbodydescription>
<location file="D:/gitt/MicrochipFor32/bsp_Device/bsp_Calculus.h" line="70" column="6" bodyfile="D:/gitt/MicrochipFor32/bsp_Device/bsp_Calculus.cpp" bodystart="67" bodyend="68"/>
<references refid="classbsp___integral_1a910f1f3faa2b4963e00718472b8389bc" compoundref="bsp___calculus_8h" startline="79">results</references>
</memberdef>
<memberdef kind="function" id="classbsp___integral_1a80693e18b9b9509bdec0ebfd72f84072" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
<type>float</type>
<definition>float bsp_Integral::Integral_list</definition>
<argsstring>(float var)</argsstring>
<name>Integral_list</name>
<qualifiedname>bsp_Integral::Integral_list</qualifiedname>
<param>
<type>float</type>
<declname>var</declname>
</param>
<briefdescription>
<para>进行带有缓冲区的积分 </para>
</briefdescription>
<detaileddescription>
<para><parameterlist kind="param"><parameteritem>
<parameternamelist>
<parametername>var</parametername>
</parameternamelist>
<parameterdescription>
<para>需要积分的数值 </para>
</parameterdescription>
</parameteritem>
</parameterlist>
<simplesect kind="return"><para>返回积分值 </para>
</simplesect>
</para>
</detaileddescription>
<inbodydescription>
</inbodydescription>
<location file="D:/gitt/MicrochipFor32/bsp_Device/bsp_Calculus.h" line="72" column="7" bodyfile="D:/gitt/MicrochipFor32/bsp_Device/bsp_Calculus.cpp" bodystart="86" bodyend="100"/>
<references refid="classbsp___integral_1a4494cf9fc2873d457ed3bf8618b68045" compoundref="bsp___calculus_8h" startline="80">dt</references>
<references refid="classbsp___integral_1a662c735b9432a46e48a642ebb9c0e8fa" compoundref="bsp___calculus_8h" startline="78">result_len</references>
<references refid="classbsp___integral_1a656d90c5a713abf0665f1dcbf1a5101a" compoundref="bsp___calculus_8h" startline="77">result_list</references>
<references refid="classbsp___integral_1a910f1f3faa2b4963e00718472b8389bc" compoundref="bsp___calculus_8h" startline="79">results</references>
</memberdef>
<memberdef kind="function" id="classbsp___integral_1a86d9e02d1146744fe80ebab69070abb4" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
<type><ref refid="varint_8h_1afaa62991928fb9fb18ff0db62a040aba" kindref="member">u32</ref></type>
<definition>u32 bsp_Integral::Integral_makelist</definition>
<argsstring>(u32 len)</argsstring>
<name>Integral_makelist</name>
<qualifiedname>bsp_Integral::Integral_makelist</qualifiedname>
<param>
<type><ref refid="varint_8h_1afaa62991928fb9fb18ff0db62a040aba" kindref="member">u32</ref></type>
<declname>len</declname>
</param>
<briefdescription>
<para>赋予历史缓存长度 </para>
</briefdescription>
<detaileddescription>
<para><parameterlist kind="param"><parameteritem>
<parameternamelist>
<parametername>var</parametername>
</parameternamelist>
<parameterdescription>
<para>分配的缓存长度 </para>
</parameterdescription>
</parameteritem>
</parameterlist>
<simplesect kind="return"><para>返回分配的内存位置,0为分配失败 </para>
</simplesect>
</para>
</detaileddescription>
<inbodydescription>
</inbodydescription>
<location file="D:/gitt/MicrochipFor32/bsp_Device/bsp_Calculus.h" line="73" column="5" bodyfile="D:/gitt/MicrochipFor32/bsp_Device/bsp_Calculus.cpp" bodystart="75" bodyend="79"/>
<references refid="classbsp___integral_1aae2b6143ca39861a83b77befc131bf5e" compoundref="bsp___calculus_8cpp" startline="113" endline="116">Integral_clslist</references>
<references refid="classbsp___integral_1a662c735b9432a46e48a642ebb9c0e8fa" compoundref="bsp___calculus_8h" startline="78">result_len</references>
<references refid="classbsp___integral_1a656d90c5a713abf0665f1dcbf1a5101a" compoundref="bsp___calculus_8h" startline="77">result_list</references>
</memberdef>
<memberdef kind="function" id="classbsp___integral_1a47307ddf418d2686245b118dcf61a199" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
<type>void</type>
<definition>void bsp_Integral::Integral_dellist</definition>
<argsstring>(void)</argsstring>
<name>Integral_dellist</name>
<qualifiedname>bsp_Integral::Integral_dellist</qualifiedname>
<param>
<type>void</type>
</param>
<briefdescription>
<para>删除并释放历史缓冲区 </para>
</briefdescription>
<detaileddescription>
</detaileddescription>
<inbodydescription>
</inbodydescription>
<location file="D:/gitt/MicrochipFor32/bsp_Device/bsp_Calculus.h" line="74" column="6" bodyfile="D:/gitt/MicrochipFor32/bsp_Device/bsp_Calculus.cpp" bodystart="105" bodyend="108"/>
<references refid="classbsp___integral_1a662c735b9432a46e48a642ebb9c0e8fa" compoundref="bsp___calculus_8h" startline="78">result_len</references>
<references refid="classbsp___integral_1a656d90c5a713abf0665f1dcbf1a5101a" compoundref="bsp___calculus_8h" startline="77">result_list</references>
</memberdef>
<memberdef kind="function" id="classbsp___integral_1aae2b6143ca39861a83b77befc131bf5e" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
<type>void</type>
<definition>void bsp_Integral::Integral_clslist</definition>
<argsstring>(void)</argsstring>
<name>Integral_clslist</name>
<qualifiedname>bsp_Integral::Integral_clslist</qualifiedname>
<param>
<type>void</type>
</param>
<briefdescription>
<para>清空历史缓存区 </para>
</briefdescription>
<detaileddescription>
</detaileddescription>
<inbodydescription>
</inbodydescription>
<location file="D:/gitt/MicrochipFor32/bsp_Device/bsp_Calculus.h" line="75" column="6" bodyfile="D:/gitt/MicrochipFor32/bsp_Device/bsp_Calculus.cpp" bodystart="113" bodyend="116"/>
<references refid="classbsp___integral_1a662c735b9432a46e48a642ebb9c0e8fa" compoundref="bsp___calculus_8h" startline="78">result_len</references>
<references refid="classbsp___integral_1a656d90c5a713abf0665f1dcbf1a5101a" compoundref="bsp___calculus_8h" startline="77">result_list</references>
<referencedby refid="classbsp___integral_1a86d9e02d1146744fe80ebab69070abb4" compoundref="bsp___calculus_8cpp" startline="75" endline="79">Integral_makelist</referencedby>
</memberdef>
</sectiondef>
<briefdescription>
<para>一个积分对象 </para>
</briefdescription>
<detaileddescription>
<para><simplesect kind="note"><para>不应当混用Integral和Integral_list </para>
</simplesect>
<simplesect kind="note"><para>选定一种方式(带缓冲区或者不带)后,就不应该更改使用方式 </para>
</simplesect>
<simplesect kind="note"><para>虽然带缓冲区方式对算法时间影响不大,但是为了避免浪费空间,不建议使用过大的缓冲区 </para>
</simplesect>
</para>
</detaileddescription>
<location file="D:/gitt/MicrochipFor32/bsp_Device/bsp_Calculus.h" line="59" column="1" bodyfile="D:/gitt/MicrochipFor32/bsp_Device/bsp_Calculus.h" bodystart="59" bodyend="81"/>
<listofallmembers>
<member refid="classbsp___integral_1af274273b399f4da855646921f3ae31ba" prot="public" virt="non-virtual"><scope>bsp_Integral</scope><name>bsp_Integral</name></member>
<member refid="classbsp___integral_1a4494cf9fc2873d457ed3bf8618b68045" prot="public" virt="non-virtual"><scope>bsp_Integral</scope><name>dt</name></member>
<member refid="classbsp___integral_1ade46f89bfdc6dd778c045a51c76c1839" prot="public" virt="non-virtual"><scope>bsp_Integral</scope><name>Integral</name></member>
<member refid="classbsp___integral_1aae2b6143ca39861a83b77befc131bf5e" prot="public" virt="non-virtual"><scope>bsp_Integral</scope><name>Integral_clslist</name></member>
<member refid="classbsp___integral_1a47307ddf418d2686245b118dcf61a199" prot="public" virt="non-virtual"><scope>bsp_Integral</scope><name>Integral_dellist</name></member>
<member refid="classbsp___integral_1a80693e18b9b9509bdec0ebfd72f84072" prot="public" virt="non-virtual"><scope>bsp_Integral</scope><name>Integral_list</name></member>
<member refid="classbsp___integral_1a86d9e02d1146744fe80ebab69070abb4" prot="public" virt="non-virtual"><scope>bsp_Integral</scope><name>Integral_makelist</name></member>
<member refid="classbsp___integral_1aaf7474301ed76ca9ce2b1884ae870019" prot="public" virt="non-virtual"><scope>bsp_Integral</scope><name>Integral_set</name></member>
<member refid="classbsp___integral_1a662c735b9432a46e48a642ebb9c0e8fa" prot="public" virt="non-virtual"><scope>bsp_Integral</scope><name>result_len</name></member>
<member refid="classbsp___integral_1a656d90c5a713abf0665f1dcbf1a5101a" prot="public" virt="non-virtual"><scope>bsp_Integral</scope><name>result_list</name></member>
<member refid="classbsp___integral_1a910f1f3faa2b4963e00718472b8389bc" prot="public" virt="non-virtual"><scope>bsp_Integral</scope><name>results</name></member>
<member refid="classbsp___integral_1a3f190eb273b4d6492fb39e2573ec37a1" prot="public" virt="non-virtual"><scope>bsp_Integral</scope><name>~bsp_Integral</name></member>
</listofallmembers>
</compounddef>
</doxygen>