source: flair-dev/trunk/doc/Flair/classflair_1_1filter_1_1_pid.html@ 34

Last change on this file since 34 was 34, checked in by Sanahuja Guillaume, 8 years ago

doc
File size: 37.9 KB
Line 
1<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
2<html xmlns="http://www.w3.org/1999/xhtml">
3<head>
4<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
5<meta http-equiv="X-UA-Compatible" content="IE=9"/>
6<meta name="generator" content="Doxygen 1.8.9.1"/>
7<title>Flair: flair::filter::Pid Class Reference</title>
8<link href="tabs.css" rel="stylesheet" type="text/css"/>
9<script type="text/javascript" src="jquery.js"></script>
10<script type="text/javascript" src="dynsections.js"></script>
11<link href="navtree.css" rel="stylesheet" type="text/css"/>
12<script type="text/javascript" src="resize.js"></script>
13<script type="text/javascript" src="navtreedata.js"></script>
14<script type="text/javascript" src="navtree.js"></script>
15<script type="text/javascript">
16 $(document).ready(initResizable);
17 $(window).load(resizeHeight);
18</script>
19<link href="search/search.css" rel="stylesheet" type="text/css"/>
20<script type="text/javascript" src="search/searchdata.js"></script>
21<script type="text/javascript" src="search/search.js"></script>
22<script type="text/javascript">
23 $(document).ready(function() { init_search(); });
24</script>
25<link href="doxygen.css" rel="stylesheet" type="text/css" />
26</head>
27<body>
28<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
29<div id="titlearea">
30<table cellspacing="0" cellpadding="0">
31 <tbody>
32 <tr style="height: 56px;">
33 <td id="projectlogo"><img alt="Logo" src="logo_hds.png"/></td>
34 <td style="padding-left: 0.5em;">
35 <div id="projectname">Flair
36 </div>
37 <div id="projectbrief">Framework Libre Air</div>
38 </td>
39 </tr>
40 </tbody>
41</table>
42</div>
43<!-- end header part -->
44<!-- Generated by Doxygen 1.8.9.1 -->
45<script type="text/javascript">
46var searchBox = new SearchBox("searchBox", "search",false,'Search');
47</script>
48 <div id="navrow1" class="tabs">
49 <ul class="tablist">
50 <li><a href="index.html"><span>Main&#160;Page</span></a></li>
51 <li><a href="namespaces.html"><span>Namespaces</span></a></li>
52 <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
53 <li><a href="files.html"><span>Files</span></a></li>
54 <li>
55 <div id="MSearchBox" class="MSearchBoxInactive">
56 <span class="left">
57 <img id="MSearchSelect" src="search/mag_sel.png"
58 onmouseover="return searchBox.OnSearchSelectShow()"
59 onmouseout="return searchBox.OnSearchSelectHide()"
60 alt=""/>
61 <input type="text" id="MSearchField" value="Search" accesskey="S"
62 onfocus="searchBox.OnSearchFieldFocus(true)"
63 onblur="searchBox.OnSearchFieldFocus(false)"
64 onkeyup="searchBox.OnSearchFieldChange(event)"/>
65 </span><span class="right">
66 <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
67 </span>
68 </div>
69 </li>
70 </ul>
71 </div>
72 <div id="navrow2" class="tabs2">
73 <ul class="tablist">
74 <li><a href="annotated.html"><span>Class&#160;List</span></a></li>
75 <li><a href="classes.html"><span>Class&#160;Index</span></a></li>
76 <li><a href="hierarchy.html"><span>Class&#160;Hierarchy</span></a></li>
77 <li><a href="functions.html"><span>Class&#160;Members</span></a></li>
78 </ul>
79 </div>
80</div><!-- top -->
81<div id="side-nav" class="ui-resizable side-nav-resizable">
82 <div id="nav-tree">
83 <div id="nav-tree-contents">
84 <div id="nav-sync" class="sync"></div>
85 </div>
86 </div>
87 <div id="splitbar" style="-moz-user-select:none;"
88 class="ui-resizable-handle">
89 </div>
90</div>
91<script type="text/javascript">
92$(document).ready(function(){initNavTree('classflair_1_1filter_1_1_pid.html','');});
93</script>
94<div id="doc-content">
95<!-- window showing the filter options -->
96<div id="MSearchSelectWindow"
97 onmouseover="return searchBox.OnSearchSelectShow()"
98 onmouseout="return searchBox.OnSearchSelectHide()"
99 onkeydown="return searchBox.OnSearchSelectKey(event)">
100</div>
101
102<!-- iframe showing the search results (closed by default) -->
103<div id="MSearchResultsWindow">
104<iframe src="javascript:void(0)" frameborder="0"
105 name="MSearchResults" id="MSearchResults">
106</iframe>
107</div>
108
109<div class="header">
110 <div class="summary">
111<a href="#pub-methods">Public Member Functions</a> &#124;
112<a href="classflair_1_1filter_1_1_pid-members.html">List of all members</a> </div>
113 <div class="headertitle">
114<div class="title">flair::filter::Pid Class Reference</div> </div>
115</div><!--header-->
116<div class="contents">
117
118<p>Class defining a PID.
119 <a href="classflair_1_1filter_1_1_pid.html#details">More...</a></p>
120
121<p><code>#include &lt;<a class="el" href="_pid_8h_source.html">Pid.h</a>&gt;</code></p>
122<div id="dynsection-0" onclick="return toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;">
123 <img id="dynsection-0-trigger" src="closed.png" alt="+"/> Inheritance diagram for flair::filter::Pid:</div>
124<div id="dynsection-0-summary" class="dynsummary" style="display:block;">
125</div>
126<div id="dynsection-0-content" class="dyncontent" style="display:none;">
127 <div class="center">
128 <img src="classflair_1_1filter_1_1_pid.png" usemap="#flair::filter::Pid_map" alt=""/>
129 <map id="flair::filter::Pid_map" name="flair::filter::Pid_map">
130<area href="classflair_1_1filter_1_1_control_law.html" title="Base class for control law input must be created by reimplemented class. output is created by this cl..." alt="flair::filter::ControlLaw" shape="rect" coords="0,112,135,136"/>
131<area href="classflair_1_1core_1_1_i_o_device.html" title="Abstract class for input/ouput system. " alt="flair::core::IODevice" shape="rect" coords="0,56,135,80"/>
132<area href="classflair_1_1core_1_1_object.html" title="Base class for all Framework&#39;s classes. " alt="flair::core::Object" shape="rect" coords="0,0,135,24"/>
133</map>
134 </div></div>
135<table class="memberdecls">
136<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
137Public Member Functions</h2></td></tr>
138<tr class="memitem:a6505c295f5e719f1d85620b44c62d619"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classflair_1_1filter_1_1_pid.html#a6505c295f5e719f1d85620b44c62d619">Pid</a> (const <a class="el" href="classflair_1_1gui_1_1_layout_position.html">gui::LayoutPosition</a> *position, std::string name)</td></tr>
139<tr class="memdesc:a6505c295f5e719f1d85620b44c62d619"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructor. <a href="#a6505c295f5e719f1d85620b44c62d619">More...</a><br /></td></tr>
140<tr class="separator:a6505c295f5e719f1d85620b44c62d619"><td class="memSeparator" colspan="2">&#160;</td></tr>
141<tr class="memitem:ab8e08d20453ac21096363f591ac365df"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classflair_1_1filter_1_1_pid.html#ab8e08d20453ac21096363f591ac365df">~Pid</a> ()</td></tr>
142<tr class="memdesc:ab8e08d20453ac21096363f591ac365df"><td class="mdescLeft">&#160;</td><td class="mdescRight">Destructor. <a href="#ab8e08d20453ac21096363f591ac365df">More...</a><br /></td></tr>
143<tr class="separator:ab8e08d20453ac21096363f591ac365df"><td class="memSeparator" colspan="2">&#160;</td></tr>
144<tr class="memitem:a41573a79913af95cbb94d30225e913b6"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classflair_1_1filter_1_1_pid.html#a41573a79913af95cbb94d30225e913b6">Reset</a> (void)</td></tr>
145<tr class="memdesc:a41573a79913af95cbb94d30225e913b6"><td class="mdescLeft">&#160;</td><td class="mdescRight">Reset integral. <a href="#a41573a79913af95cbb94d30225e913b6">More...</a><br /></td></tr>
146<tr class="separator:a41573a79913af95cbb94d30225e913b6"><td class="memSeparator" colspan="2">&#160;</td></tr>
147<tr class="memitem:a27c025ae6b9a9a192a234ab74e2e6f8b"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classflair_1_1filter_1_1_pid.html#a27c025ae6b9a9a192a234ab74e2e6f8b">SetValues</a> (float p, float d)</td></tr>
148<tr class="memdesc:a27c025ae6b9a9a192a234ab74e2e6f8b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set input values. <a href="#a27c025ae6b9a9a192a234ab74e2e6f8b">More...</a><br /></td></tr>
149<tr class="separator:a27c025ae6b9a9a192a234ab74e2e6f8b"><td class="memSeparator" colspan="2">&#160;</td></tr>
150<tr class="memitem:a8128ecc530ff19abae93027d72d4b5ec"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classflair_1_1filter_1_1_pid.html#a8128ecc530ff19abae93027d72d4b5ec">UseDefaultPlot</a> (const <a class="el" href="classflair_1_1gui_1_1_layout_position.html">gui::LayoutPosition</a> *position)</td></tr>
151<tr class="memdesc:a8128ecc530ff19abae93027d72d4b5ec"><td class="mdescLeft">&#160;</td><td class="mdescRight">Use default plot. <a href="#a8128ecc530ff19abae93027d72d4b5ec">More...</a><br /></td></tr>
152<tr class="separator:a8128ecc530ff19abae93027d72d4b5ec"><td class="memSeparator" colspan="2">&#160;</td></tr>
153<tr class="inherit_header pub_methods_classflair_1_1filter_1_1_control_law"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classflair_1_1filter_1_1_control_law')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="classflair_1_1filter_1_1_control_law.html">flair::filter::ControlLaw</a></td></tr>
154<tr class="memitem:abd6d4ee32a9e01a2d1b0513a0aadafcb inherit pub_methods_classflair_1_1filter_1_1_control_law"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classflair_1_1filter_1_1_control_law.html#abd6d4ee32a9e01a2d1b0513a0aadafcb">ControlLaw</a> (const <a class="el" href="classflair_1_1core_1_1_object.html">core::Object</a> *parent, std::string name, uint32_t nb_out=1)</td></tr>
155<tr class="memdesc:abd6d4ee32a9e01a2d1b0513a0aadafcb inherit pub_methods_classflair_1_1filter_1_1_control_law"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructor. <a href="#abd6d4ee32a9e01a2d1b0513a0aadafcb">More...</a><br /></td></tr>
156<tr class="separator:abd6d4ee32a9e01a2d1b0513a0aadafcb inherit pub_methods_classflair_1_1filter_1_1_control_law"><td class="memSeparator" colspan="2">&#160;</td></tr>
157<tr class="memitem:a62210ace4d3338cbc528ed712e72ac27 inherit pub_methods_classflair_1_1filter_1_1_control_law"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classflair_1_1filter_1_1_control_law.html#a62210ace4d3338cbc528ed712e72ac27">~ControlLaw</a> ()</td></tr>
158<tr class="memdesc:a62210ace4d3338cbc528ed712e72ac27 inherit pub_methods_classflair_1_1filter_1_1_control_law"><td class="mdescLeft">&#160;</td><td class="mdescRight">Destructor. <a href="#a62210ace4d3338cbc528ed712e72ac27">More...</a><br /></td></tr>
159<tr class="separator:a62210ace4d3338cbc528ed712e72ac27 inherit pub_methods_classflair_1_1filter_1_1_control_law"><td class="memSeparator" colspan="2">&#160;</td></tr>
160<tr class="memitem:ace241d108bd0213135dbd6a5a561d0cf inherit pub_methods_classflair_1_1filter_1_1_control_law"><td class="memItemLeft" align="right" valign="top">float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classflair_1_1filter_1_1_control_law.html#ace241d108bd0213135dbd6a5a561d0cf">Output</a> (uint32_t index=0) const </td></tr>
161<tr class="memdesc:ace241d108bd0213135dbd6a5a561d0cf inherit pub_methods_classflair_1_1filter_1_1_control_law"><td class="mdescLeft">&#160;</td><td class="mdescRight">Output value. <a href="#ace241d108bd0213135dbd6a5a561d0cf">More...</a><br /></td></tr>
162<tr class="separator:ace241d108bd0213135dbd6a5a561d0cf inherit pub_methods_classflair_1_1filter_1_1_control_law"><td class="memSeparator" colspan="2">&#160;</td></tr>
163<tr class="memitem:a228f8bf6857d96fa015bec9e016d2132 inherit pub_methods_classflair_1_1filter_1_1_control_law"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classflair_1_1filter_1_1_control_law.html#a228f8bf6857d96fa015bec9e016d2132">Update</a> (<a class="el" href="namespaceflair_1_1core.html#acc0fa041e08ecf73b2d1d723c339a736">core::Time</a> time)</td></tr>
164<tr class="memdesc:a228f8bf6857d96fa015bec9e016d2132 inherit pub_methods_classflair_1_1filter_1_1_control_law"><td class="mdescLeft">&#160;</td><td class="mdescRight">Update using provided datas. <a href="#a228f8bf6857d96fa015bec9e016d2132">More...</a><br /></td></tr>
165<tr class="separator:a228f8bf6857d96fa015bec9e016d2132 inherit pub_methods_classflair_1_1filter_1_1_control_law"><td class="memSeparator" colspan="2">&#160;</td></tr>
166<tr class="inherit_header pub_methods_classflair_1_1core_1_1_i_o_device"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classflair_1_1core_1_1_i_o_device')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="classflair_1_1core_1_1_i_o_device.html">flair::core::IODevice</a></td></tr>
167<tr class="memitem:a9693b497752b466891eaafeb34bec4d3 inherit pub_methods_classflair_1_1core_1_1_i_o_device"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classflair_1_1core_1_1_i_o_device.html#a9693b497752b466891eaafeb34bec4d3">IODevice</a> (const <a class="el" href="classflair_1_1core_1_1_object.html">Object</a> *parent, std::string name)</td></tr>
168<tr class="memdesc:a9693b497752b466891eaafeb34bec4d3 inherit pub_methods_classflair_1_1core_1_1_i_o_device"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructor. <a href="#a9693b497752b466891eaafeb34bec4d3">More...</a><br /></td></tr>
169<tr class="separator:a9693b497752b466891eaafeb34bec4d3 inherit pub_methods_classflair_1_1core_1_1_i_o_device"><td class="memSeparator" colspan="2">&#160;</td></tr>
170<tr class="memitem:a05246988b486def40926d8491e1bcc5f inherit pub_methods_classflair_1_1core_1_1_i_o_device"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classflair_1_1core_1_1_i_o_device.html#a05246988b486def40926d8491e1bcc5f">~IODevice</a> ()</td></tr>
171<tr class="memdesc:a05246988b486def40926d8491e1bcc5f inherit pub_methods_classflair_1_1core_1_1_i_o_device"><td class="mdescLeft">&#160;</td><td class="mdescRight">Destructor. <a href="#a05246988b486def40926d8491e1bcc5f">More...</a><br /></td></tr>
172<tr class="separator:a05246988b486def40926d8491e1bcc5f inherit pub_methods_classflair_1_1core_1_1_i_o_device"><td class="memSeparator" colspan="2">&#160;</td></tr>
173<tr class="memitem:af7b42de6bb3893df860063228b55c229 inherit pub_methods_classflair_1_1core_1_1_i_o_device"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classflair_1_1core_1_1_i_o_device.html#af7b42de6bb3893df860063228b55c229">AddDeviceToLog</a> (const <a class="el" href="classflair_1_1core_1_1_i_o_device.html">IODevice</a> *device)</td></tr>
174<tr class="memdesc:af7b42de6bb3893df860063228b55c229 inherit pub_methods_classflair_1_1core_1_1_i_o_device"><td class="mdescLeft">&#160;</td><td class="mdescRight">Add an <a class="el" href="classflair_1_1core_1_1_i_o_device.html" title="Abstract class for input/ouput system. ">IODevice</a> to the logs. <a href="#af7b42de6bb3893df860063228b55c229">More...</a><br /></td></tr>
175<tr class="separator:af7b42de6bb3893df860063228b55c229 inherit pub_methods_classflair_1_1core_1_1_i_o_device"><td class="memSeparator" colspan="2">&#160;</td></tr>
176<tr class="memitem:a2e0b7af75abdbf39843d8bf2e45f08b9 inherit pub_methods_classflair_1_1core_1_1_i_o_device"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classflair_1_1core_1_1_i_o_device.html#a2e0b7af75abdbf39843d8bf2e45f08b9">AddDataToLog</a> (const <a class="el" href="classflair_1_1core_1_1io__data.html">io_data</a> *data)</td></tr>
177<tr class="memdesc:a2e0b7af75abdbf39843d8bf2e45f08b9 inherit pub_methods_classflair_1_1core_1_1_i_o_device"><td class="mdescLeft">&#160;</td><td class="mdescRight">Add an <a class="el" href="classflair_1_1core_1_1io__data.html" title="Abstract class for data types. ">io_data</a> to the log. <a href="#a2e0b7af75abdbf39843d8bf2e45f08b9">More...</a><br /></td></tr>
178<tr class="separator:a2e0b7af75abdbf39843d8bf2e45f08b9 inherit pub_methods_classflair_1_1core_1_1_i_o_device"><td class="memSeparator" colspan="2">&#160;</td></tr>
179<tr class="memitem:a12d811c6926fb86da6b47f889109da66 inherit pub_methods_classflair_1_1core_1_1_i_o_device"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classflair_1_1core_1_1_i_o_device.html#a12d811c6926fb86da6b47f889109da66">OutputToShMem</a> (bool enabled)</td></tr>
180<tr class="memdesc:a12d811c6926fb86da6b47f889109da66 inherit pub_methods_classflair_1_1core_1_1_i_o_device"><td class="mdescLeft">&#160;</td><td class="mdescRight">Send the output to a shared memory. <a href="#a12d811c6926fb86da6b47f889109da66">More...</a><br /></td></tr>
181<tr class="separator:a12d811c6926fb86da6b47f889109da66 inherit pub_methods_classflair_1_1core_1_1_i_o_device"><td class="memSeparator" colspan="2">&#160;</td></tr>
182<tr class="memitem:a75e82ca2ae2fb7c39d973dd3d16bc698 inherit pub_methods_classflair_1_1core_1_1_i_o_device"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a75e82ca2ae2fb7c39d973dd3d16bc698"></a>
183virtual <a class="el" href="classflair_1_1core_1_1_data_type.html">DataType</a> const &amp;&#160;</td><td class="memItemRight" valign="bottom"><b>GetInputDataType</b> () const </td></tr>
184<tr class="separator:a75e82ca2ae2fb7c39d973dd3d16bc698 inherit pub_methods_classflair_1_1core_1_1_i_o_device"><td class="memSeparator" colspan="2">&#160;</td></tr>
185<tr class="memitem:aa325be57d48b268006120dde75dd65cc inherit pub_methods_classflair_1_1core_1_1_i_o_device"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aa325be57d48b268006120dde75dd65cc"></a>
186virtual <a class="el" href="classflair_1_1core_1_1_data_type.html">DataType</a> const &amp;&#160;</td><td class="memItemRight" valign="bottom"><b>GetOutputDataType</b> () const </td></tr>
187<tr class="separator:aa325be57d48b268006120dde75dd65cc inherit pub_methods_classflair_1_1core_1_1_i_o_device"><td class="memSeparator" colspan="2">&#160;</td></tr>
188<tr class="inherit_header pub_methods_classflair_1_1core_1_1_object"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classflair_1_1core_1_1_object')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="classflair_1_1core_1_1_object.html">flair::core::Object</a></td></tr>
189<tr class="memitem:aec92383fd5bf68d9df10414862b7e95c inherit pub_methods_classflair_1_1core_1_1_object"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classflair_1_1core_1_1_object.html#aec92383fd5bf68d9df10414862b7e95c">Object</a> (const <a class="el" href="classflair_1_1core_1_1_object.html">Object</a> *parent=NULL, std::string name=&quot;&quot;, std::string type=&quot;&quot;)</td></tr>
190<tr class="memdesc:aec92383fd5bf68d9df10414862b7e95c inherit pub_methods_classflair_1_1core_1_1_object"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructor. <a href="#aec92383fd5bf68d9df10414862b7e95c">More...</a><br /></td></tr>
191<tr class="separator:aec92383fd5bf68d9df10414862b7e95c inherit pub_methods_classflair_1_1core_1_1_object"><td class="memSeparator" colspan="2">&#160;</td></tr>
192<tr class="memitem:aa2bde0e6677bbef705c96c93cb06ad09 inherit pub_methods_classflair_1_1core_1_1_object"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classflair_1_1core_1_1_object.html#aa2bde0e6677bbef705c96c93cb06ad09">~Object</a> ()</td></tr>
193<tr class="memdesc:aa2bde0e6677bbef705c96c93cb06ad09 inherit pub_methods_classflair_1_1core_1_1_object"><td class="mdescLeft">&#160;</td><td class="mdescRight">Destructor. <a href="#aa2bde0e6677bbef705c96c93cb06ad09">More...</a><br /></td></tr>
194<tr class="separator:aa2bde0e6677bbef705c96c93cb06ad09 inherit pub_methods_classflair_1_1core_1_1_object"><td class="memSeparator" colspan="2">&#160;</td></tr>
195<tr class="memitem:a9b0344dff7e1c05424d9152c8274523a inherit pub_methods_classflair_1_1core_1_1_object"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classflair_1_1core_1_1_object.html#a9b0344dff7e1c05424d9152c8274523a">ObjectName</a> (void) const </td></tr>
196<tr class="memdesc:a9b0344dff7e1c05424d9152c8274523a inherit pub_methods_classflair_1_1core_1_1_object"><td class="mdescLeft">&#160;</td><td class="mdescRight">Name. <a href="#a9b0344dff7e1c05424d9152c8274523a">More...</a><br /></td></tr>
197<tr class="separator:a9b0344dff7e1c05424d9152c8274523a inherit pub_methods_classflair_1_1core_1_1_object"><td class="memSeparator" colspan="2">&#160;</td></tr>
198<tr class="memitem:a609a250ec037fbcaf8957c8f1dcbfc53 inherit pub_methods_classflair_1_1core_1_1_object"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classflair_1_1core_1_1_object.html#a609a250ec037fbcaf8957c8f1dcbfc53">ObjectType</a> (void) const </td></tr>
199<tr class="memdesc:a609a250ec037fbcaf8957c8f1dcbfc53 inherit pub_methods_classflair_1_1core_1_1_object"><td class="mdescLeft">&#160;</td><td class="mdescRight">Type. <a href="#a609a250ec037fbcaf8957c8f1dcbfc53">More...</a><br /></td></tr>
200<tr class="separator:a609a250ec037fbcaf8957c8f1dcbfc53 inherit pub_methods_classflair_1_1core_1_1_object"><td class="memSeparator" colspan="2">&#160;</td></tr>
201<tr class="memitem:a360c112cc3017a5152ebf6e84d2efa70 inherit pub_methods_classflair_1_1core_1_1_object"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="classflair_1_1core_1_1_object.html">Object</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classflair_1_1core_1_1_object.html#a360c112cc3017a5152ebf6e84d2efa70">Parent</a> (void) const </td></tr>
202<tr class="memdesc:a360c112cc3017a5152ebf6e84d2efa70 inherit pub_methods_classflair_1_1core_1_1_object"><td class="mdescLeft">&#160;</td><td class="mdescRight">Parent. <a href="#a360c112cc3017a5152ebf6e84d2efa70">More...</a><br /></td></tr>
203<tr class="separator:a360c112cc3017a5152ebf6e84d2efa70 inherit pub_methods_classflair_1_1core_1_1_object"><td class="memSeparator" colspan="2">&#160;</td></tr>
204<tr class="memitem:ae22db4d723ec2d50b3ba48f26a6a770c inherit pub_methods_classflair_1_1core_1_1_object"><td class="memItemLeft" align="right" valign="top">std::vector&lt; const <a class="el" href="classflair_1_1core_1_1_object.html">Object</a> * &gt; *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classflair_1_1core_1_1_object.html#ae22db4d723ec2d50b3ba48f26a6a770c">TypeChilds</a> (void) const </td></tr>
205<tr class="memdesc:ae22db4d723ec2d50b3ba48f26a6a770c inherit pub_methods_classflair_1_1core_1_1_object"><td class="mdescLeft">&#160;</td><td class="mdescRight">Childs of the same type. <a href="#ae22db4d723ec2d50b3ba48f26a6a770c">More...</a><br /></td></tr>
206<tr class="separator:ae22db4d723ec2d50b3ba48f26a6a770c inherit pub_methods_classflair_1_1core_1_1_object"><td class="memSeparator" colspan="2">&#160;</td></tr>
207<tr class="memitem:a344f81cd35805a9501098bf727ac1a10 inherit pub_methods_classflair_1_1core_1_1_object"><td class="memItemLeft" align="right" valign="top">std::vector&lt; const <a class="el" href="classflair_1_1core_1_1_object.html">Object</a> * &gt; *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classflair_1_1core_1_1_object.html#a344f81cd35805a9501098bf727ac1a10">Childs</a> (void) const </td></tr>
208<tr class="memdesc:a344f81cd35805a9501098bf727ac1a10 inherit pub_methods_classflair_1_1core_1_1_object"><td class="mdescLeft">&#160;</td><td class="mdescRight">Childs. <a href="#a344f81cd35805a9501098bf727ac1a10">More...</a><br /></td></tr>
209<tr class="separator:a344f81cd35805a9501098bf727ac1a10 inherit pub_methods_classflair_1_1core_1_1_object"><td class="memSeparator" colspan="2">&#160;</td></tr>
210<tr class="memitem:af001feba14fc053aa778e61080a0b4cf inherit pub_methods_classflair_1_1core_1_1_object"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classflair_1_1core_1_1_object.html#af001feba14fc053aa778e61080a0b4cf">Information</a> (const char *function, int line, const char *format,...) const </td></tr>
211<tr class="memdesc:af001feba14fc053aa778e61080a0b4cf inherit pub_methods_classflair_1_1core_1_1_object"><td class="mdescLeft">&#160;</td><td class="mdescRight">Formatted information. <a href="#af001feba14fc053aa778e61080a0b4cf">More...</a><br /></td></tr>
212<tr class="separator:af001feba14fc053aa778e61080a0b4cf inherit pub_methods_classflair_1_1core_1_1_object"><td class="memSeparator" colspan="2">&#160;</td></tr>
213<tr class="memitem:a168b18451b2ee6126e1e81d452005ff6 inherit pub_methods_classflair_1_1core_1_1_object"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classflair_1_1core_1_1_object.html#a168b18451b2ee6126e1e81d452005ff6">Warning</a> (const char *function, const char *format,...) const </td></tr>
214<tr class="memdesc:a168b18451b2ee6126e1e81d452005ff6 inherit pub_methods_classflair_1_1core_1_1_object"><td class="mdescLeft">&#160;</td><td class="mdescRight">Formatted warning. <a href="#a168b18451b2ee6126e1e81d452005ff6">More...</a><br /></td></tr>
215<tr class="separator:a168b18451b2ee6126e1e81d452005ff6 inherit pub_methods_classflair_1_1core_1_1_object"><td class="memSeparator" colspan="2">&#160;</td></tr>
216<tr class="memitem:a3ca9694d29ec2b0491739879685df5ca inherit pub_methods_classflair_1_1core_1_1_object"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classflair_1_1core_1_1_object.html#a3ca9694d29ec2b0491739879685df5ca">Error</a> (const char *function, const char *format,...) const </td></tr>
217<tr class="memdesc:a3ca9694d29ec2b0491739879685df5ca inherit pub_methods_classflair_1_1core_1_1_object"><td class="mdescLeft">&#160;</td><td class="mdescRight">Formatted error. <a href="#a3ca9694d29ec2b0491739879685df5ca">More...</a><br /></td></tr>
218<tr class="separator:a3ca9694d29ec2b0491739879685df5ca inherit pub_methods_classflair_1_1core_1_1_object"><td class="memSeparator" colspan="2">&#160;</td></tr>
219<tr class="memitem:a36cdd7f556e78b1bddd1d1fe4264bb85 inherit pub_methods_classflair_1_1core_1_1_object"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classflair_1_1core_1_1_object.html#a36cdd7f556e78b1bddd1d1fe4264bb85">ErrorOccured</a> (bool recursive=true) const </td></tr>
220<tr class="memdesc:a36cdd7f556e78b1bddd1d1fe4264bb85 inherit pub_methods_classflair_1_1core_1_1_object"><td class="mdescLeft">&#160;</td><td class="mdescRight">Has an errror occured? <a href="#a36cdd7f556e78b1bddd1d1fe4264bb85">More...</a><br /></td></tr>
221<tr class="separator:a36cdd7f556e78b1bddd1d1fe4264bb85 inherit pub_methods_classflair_1_1core_1_1_object"><td class="memSeparator" colspan="2">&#160;</td></tr>
222</table><table class="memberdecls">
223<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="inherited"></a>
224Additional Inherited Members</h2></td></tr>
225<tr class="inherit_header pub_types_classflair_1_1core_1_1_object"><td colspan="2" onclick="javascript:toggleInherit('pub_types_classflair_1_1core_1_1_object')"><img src="closed.png" alt="-"/>&#160;Public Types inherited from <a class="el" href="classflair_1_1core_1_1_object.html">flair::core::Object</a></td></tr>
226<tr class="memitem:aed5fccda511f97487040fed29f4efc97 inherit pub_types_classflair_1_1core_1_1_object"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aed5fccda511f97487040fed29f4efc97"></a>enum &#160;</td><td class="memItemRight" valign="bottom"><b>color_t</b> { <b>Auto</b> = 0,
227<b>Red</b> = 31,
228<b>Green</b> = 32,
229<b>Orange</b> = 33
230 }</td></tr>
231<tr class="separator:aed5fccda511f97487040fed29f4efc97 inherit pub_types_classflair_1_1core_1_1_object"><td class="memSeparator" colspan="2">&#160;</td></tr>
232<tr class="inherit_header pub_attribs_classflair_1_1core_1_1_i_o_device"><td colspan="2" onclick="javascript:toggleInherit('pub_attribs_classflair_1_1core_1_1_i_o_device')"><img src="closed.png" alt="-"/>&#160;Public Attributes inherited from <a class="el" href="classflair_1_1core_1_1_i_o_device.html">flair::core::IODevice</a></td></tr>
233<tr class="memitem:a5b701dbf27a7b1210bf7daf176e4e9b6 inherit pub_attribs_classflair_1_1core_1_1_i_o_device"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a5b701dbf27a7b1210bf7daf176e4e9b6"></a>
234<a class="el" href="namespaceflair_1_1core.html#acc0fa041e08ecf73b2d1d723c339a736">Time</a>&#160;</td><td class="memItemRight" valign="bottom"><b>lastUpdate</b></td></tr>
235<tr class="separator:a5b701dbf27a7b1210bf7daf176e4e9b6 inherit pub_attribs_classflair_1_1core_1_1_i_o_device"><td class="memSeparator" colspan="2">&#160;</td></tr>
236<tr class="inherit_header pro_methods_classflair_1_1core_1_1_i_o_device"><td colspan="2" onclick="javascript:toggleInherit('pro_methods_classflair_1_1core_1_1_i_o_device')"><img src="closed.png" alt="-"/>&#160;Protected Member Functions inherited from <a class="el" href="classflair_1_1core_1_1_i_o_device.html">flair::core::IODevice</a></td></tr>
237<tr class="memitem:a3df9057ae23eb34f1b1dae8e7a4a9efc inherit pro_methods_classflair_1_1core_1_1_i_o_device"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classflair_1_1core_1_1_i_o_device.html#a3df9057ae23eb34f1b1dae8e7a4a9efc">ProcessUpdate</a> (<a class="el" href="classflair_1_1core_1_1io__data.html">io_data</a> *data)</td></tr>
238<tr class="memdesc:a3df9057ae23eb34f1b1dae8e7a4a9efc inherit pro_methods_classflair_1_1core_1_1_i_o_device"><td class="mdescLeft">&#160;</td><td class="mdescRight">Process the childs of type <a class="el" href="classflair_1_1core_1_1_i_o_device.html" title="Abstract class for input/ouput system. ">IODevice</a>, and log if needed. <a href="#a3df9057ae23eb34f1b1dae8e7a4a9efc">More...</a><br /></td></tr>
239<tr class="separator:a3df9057ae23eb34f1b1dae8e7a4a9efc inherit pro_methods_classflair_1_1core_1_1_i_o_device"><td class="memSeparator" colspan="2">&#160;</td></tr>
240<tr class="inherit_header pro_attribs_classflair_1_1filter_1_1_control_law"><td colspan="2" onclick="javascript:toggleInherit('pro_attribs_classflair_1_1filter_1_1_control_law')"><img src="closed.png" alt="-"/>&#160;Protected Attributes inherited from <a class="el" href="classflair_1_1filter_1_1_control_law.html">flair::filter::ControlLaw</a></td></tr>
241<tr class="memitem:a9877d488ad17a52affd8c68beca426d1 inherit pro_attribs_classflair_1_1filter_1_1_control_law"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classflair_1_1core_1_1cvmatrix.html">core::cvmatrix</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classflair_1_1filter_1_1_control_law.html#a9877d488ad17a52affd8c68beca426d1">input</a></td></tr>
242<tr class="memdesc:a9877d488ad17a52affd8c68beca426d1 inherit pro_attribs_classflair_1_1filter_1_1_control_law"><td class="mdescLeft">&#160;</td><td class="mdescRight">input matrix <a href="#a9877d488ad17a52affd8c68beca426d1">More...</a><br /></td></tr>
243<tr class="separator:a9877d488ad17a52affd8c68beca426d1 inherit pro_attribs_classflair_1_1filter_1_1_control_law"><td class="memSeparator" colspan="2">&#160;</td></tr>
244<tr class="memitem:aad8a67d158a1eda16ed53615e2511f97 inherit pro_attribs_classflair_1_1filter_1_1_control_law"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classflair_1_1core_1_1cvmatrix.html">core::cvmatrix</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classflair_1_1filter_1_1_control_law.html#aad8a67d158a1eda16ed53615e2511f97">output</a></td></tr>
245<tr class="memdesc:aad8a67d158a1eda16ed53615e2511f97 inherit pro_attribs_classflair_1_1filter_1_1_control_law"><td class="mdescLeft">&#160;</td><td class="mdescRight">output matrix <a href="#aad8a67d158a1eda16ed53615e2511f97">More...</a><br /></td></tr>
246<tr class="separator:aad8a67d158a1eda16ed53615e2511f97 inherit pro_attribs_classflair_1_1filter_1_1_control_law"><td class="memSeparator" colspan="2">&#160;</td></tr>
247</table>
248<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
249<div class="textblock"><p>Class defining a PID. </p>
250</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
251<a class="anchor" id="a6505c295f5e719f1d85620b44c62d619"></a>
252<div class="memitem">
253<div class="memproto">
254 <table class="memname">
255 <tr>
256 <td class="memname">flair::filter::Pid::Pid </td>
257 <td>(</td>
258 <td class="paramtype">const <a class="el" href="classflair_1_1gui_1_1_layout_position.html">gui::LayoutPosition</a> *&#160;</td>
259 <td class="paramname"><em>position</em>, </td>
260 </tr>
261 <tr>
262 <td class="paramkey"></td>
263 <td></td>
264 <td class="paramtype">std::string&#160;</td>
265 <td class="paramname"><em>name</em>&#160;</td>
266 </tr>
267 <tr>
268 <td></td>
269 <td>)</td>
270 <td></td><td></td>
271 </tr>
272 </table>
273</div><div class="memdoc">
274
275<p>Constructor. </p>
276<p>Construct a PID at given position. <br />
277 The PID will automatically be child of position-&gt;getLayout() Layout. After calling this function, position will be deleted as it is no longer usefull. <br />
278 </p><dl class="params"><dt>Parameters</dt><dd>
279 <table class="params">
280 <tr><td class="paramname">position</td><td>position to display settings </td></tr>
281 <tr><td class="paramname">name</td><td>name </td></tr>
282 </table>
283 </dd>
284</dl>
285
286</div>
287</div>
288<a class="anchor" id="ab8e08d20453ac21096363f591ac365df"></a>
289<div class="memitem">
290<div class="memproto">
291 <table class="memname">
292 <tr>
293 <td class="memname">flair::filter::Pid::~Pid </td>
294 <td>(</td>
295 <td class="paramname"></td><td>)</td>
296 <td></td>
297 </tr>
298 </table>
299</div><div class="memdoc">
300
301<p>Destructor. </p>
302
303</div>
304</div>
305<h2 class="groupheader">Member Function Documentation</h2>
306<a class="anchor" id="a41573a79913af95cbb94d30225e913b6"></a>
307<div class="memitem">
308<div class="memproto">
309<table class="mlabels">
310 <tr>
311 <td class="mlabels-left">
312 <table class="memname">
313 <tr>
314 <td class="memname">void flair::filter::Pid::Reset </td>
315 <td>(</td>
316 <td class="paramtype">void&#160;</td>
317 <td class="paramname"></td><td>)</td>
318 <td></td>
319 </tr>
320 </table>
321 </td>
322 <td class="mlabels-right">
323<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
324 </tr>
325</table>
326</div><div class="memdoc">
327
328<p>Reset integral. </p>
329
330<p>Reimplemented from <a class="el" href="classflair_1_1filter_1_1_control_law.html#a0892ecd37930c5d92a41449ab6fa1f10">flair::filter::ControlLaw</a>.</p>
331
332</div>
333</div>
334<a class="anchor" id="a27c025ae6b9a9a192a234ab74e2e6f8b"></a>
335<div class="memitem">
336<div class="memproto">
337 <table class="memname">
338 <tr>
339 <td class="memname">void flair::filter::Pid::SetValues </td>
340 <td>(</td>
341 <td class="paramtype">float&#160;</td>
342 <td class="paramname"><em>p</em>, </td>
343 </tr>
344 <tr>
345 <td class="paramkey"></td>
346 <td></td>
347 <td class="paramtype">float&#160;</td>
348 <td class="paramname"><em>d</em>&#160;</td>
349 </tr>
350 <tr>
351 <td></td>
352 <td>)</td>
353 <td></td><td></td>
354 </tr>
355 </table>
356</div><div class="memdoc">
357
358<p>Set input values. </p>
359<dl class="params"><dt>Parameters</dt><dd>
360 <table class="params">
361 <tr><td class="paramname">p</td><td>proportional value </td></tr>
362 <tr><td class="paramname">d</td><td>derivative value </td></tr>
363 </table>
364 </dd>
365</dl>
366
367</div>
368</div>
369<a class="anchor" id="a8128ecc530ff19abae93027d72d4b5ec"></a>
370<div class="memitem">
371<div class="memproto">
372<table class="mlabels">
373 <tr>
374 <td class="mlabels-left">
375 <table class="memname">
376 <tr>
377 <td class="memname">void flair::filter::Pid::UseDefaultPlot </td>
378 <td>(</td>
379 <td class="paramtype">const <a class="el" href="classflair_1_1gui_1_1_layout_position.html">gui::LayoutPosition</a> *&#160;</td>
380 <td class="paramname"><em>position</em></td><td>)</td>
381 <td></td>
382 </tr>
383 </table>
384 </td>
385 <td class="mlabels-right">
386<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
387 </tr>
388</table>
389</div><div class="memdoc">
390
391<p>Use default plot. </p>
392<p>Plot the output values at position. <br />
393 Plot consists of 4 curves: proportional part, derivative part, integral part and the sum of the three. <br />
394 After calling this function, position will be deleted as it is no longer usefull. <br />
395 </p><dl class="params"><dt>Parameters</dt><dd>
396 <table class="params">
397 <tr><td class="paramname">position</td><td>position to display plot </td></tr>
398 </table>
399 </dd>
400</dl>
401
402<p>Reimplemented from <a class="el" href="classflair_1_1filter_1_1_control_law.html#a3c42c9c7ae276e10d2ebad3a6701210d">flair::filter::ControlLaw</a>.</p>
403
404</div>
405</div>
406</div><!-- contents -->
407</div><!-- doc-content -->
408<!-- start footer part -->
409<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
410 <ul>
411 <li class="navelem"><a class="el" href="namespaceflair.html">flair</a></li><li class="navelem"><a class="el" href="namespaceflair_1_1filter.html">filter</a></li><li class="navelem"><a class="el" href="classflair_1_1filter_1_1_pid.html">Pid</a></li>
412 <li class="footer">Generated on Wed Sep 28 2016 06:30:10 for Flair by
413 <a href="http://www.doxygen.org/index.html">
414 <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.9.1 </li>
415 </ul>
416</div>
417</body>
418</html>
Note: See TracBrowser for help on using the repository browser.