source: flair-dev/tags/0.0.1/doc/Flair/classflair_1_1filter_1_1_nested_sat.html

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

complementary filter
File size: 39.2 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.7"/>
7<title>Flair: flair::filter::NestedSat 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="navtree.js"></script>
14<script type="text/javascript">
15 $(document).ready(initResizable);
16 $(window).load(resizeHeight);
17</script>
18<link href="search/search.css" rel="stylesheet" type="text/css"/>
19<script type="text/javascript" src="search/search.js"></script>
20<script type="text/javascript">
21 $(document).ready(function() { searchBox.OnSelectItem(0); });
22</script>
23<link href="doxygen.css" rel="stylesheet" type="text/css" />
24</head>
25<body>
26<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
27<div id="titlearea">
28<table cellspacing="0" cellpadding="0">
29 <tbody>
30 <tr style="height: 56px;">
31 <td id="projectlogo"><img alt="Logo" src="logo_hds.png"/></td>
32 <td style="padding-left: 0.5em;">
33 <div id="projectname">Flair
34 </div>
35 <div id="projectbrief">Framework Libre Air</div>
36 </td>
37 </tr>
38 </tbody>
39</table>
40</div>
41<!-- end header part -->
42<!-- Generated by Doxygen 1.8.7 -->
43<script type="text/javascript">
44var searchBox = new SearchBox("searchBox", "search",false,'Search');
45</script>
46 <div id="navrow1" class="tabs">
47 <ul class="tablist">
48 <li><a href="index.html"><span>Main&#160;Page</span></a></li>
49 <li><a href="namespaces.html"><span>Namespaces</span></a></li>
50 <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
51 <li><a href="files.html"><span>Files</span></a></li>
52 <li>
53 <div id="MSearchBox" class="MSearchBoxInactive">
54 <span class="left">
55 <img id="MSearchSelect" src="search/mag_sel.png"
56 onmouseover="return searchBox.OnSearchSelectShow()"
57 onmouseout="return searchBox.OnSearchSelectHide()"
58 alt=""/>
59 <input type="text" id="MSearchField" value="Search" accesskey="S"
60 onfocus="searchBox.OnSearchFieldFocus(true)"
61 onblur="searchBox.OnSearchFieldFocus(false)"
62 onkeyup="searchBox.OnSearchFieldChange(event)"/>
63 </span><span class="right">
64 <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
65 </span>
66 </div>
67 </li>
68 </ul>
69 </div>
70 <div id="navrow2" class="tabs2">
71 <ul class="tablist">
72 <li><a href="annotated.html"><span>Class&#160;List</span></a></li>
73 <li><a href="classes.html"><span>Class&#160;Index</span></a></li>
74 <li><a href="hierarchy.html"><span>Class&#160;Hierarchy</span></a></li>
75 <li><a href="functions.html"><span>Class&#160;Members</span></a></li>
76 </ul>
77 </div>
78</div><!-- top -->
79<div id="side-nav" class="ui-resizable side-nav-resizable">
80 <div id="nav-tree">
81 <div id="nav-tree-contents">
82 <div id="nav-sync" class="sync"></div>
83 </div>
84 </div>
85 <div id="splitbar" style="-moz-user-select:none;"
86 class="ui-resizable-handle">
87 </div>
88</div>
89<script type="text/javascript">
90$(document).ready(function(){initNavTree('classflair_1_1filter_1_1_nested_sat.html','');});
91</script>
92<div id="doc-content">
93<!-- window showing the filter options -->
94<div id="MSearchSelectWindow"
95 onmouseover="return searchBox.OnSearchSelectShow()"
96 onmouseout="return searchBox.OnSearchSelectHide()"
97 onkeydown="return searchBox.OnSearchSelectKey(event)">
98<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark">&#160;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark">&#160;</span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark">&#160;</span>Properties</a></div>
99
100<!-- iframe showing the search results (closed by default) -->
101<div id="MSearchResultsWindow">
102<iframe src="javascript:void(0)" frameborder="0"
103 name="MSearchResults" id="MSearchResults">
104</iframe>
105</div>
106
107<div class="header">
108 <div class="summary">
109<a href="#pub-methods">Public Member Functions</a> &#124;
110<a href="classflair_1_1filter_1_1_nested_sat-members.html">List of all members</a> </div>
111 <div class="headertitle">
112<div class="title">flair::filter::NestedSat Class Reference</div> </div>
113</div><!--header-->
114<div class="contents">
115
116<p>Class defining a PID with saturations.
117 <a href="classflair_1_1filter_1_1_nested_sat.html#details">More...</a></p>
118
119<p><code>#include &lt;<a class="el" href="_nested_sat_8h_source.html">NestedSat.h</a>&gt;</code></p>
120<div id="dynsection-0" onclick="return toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;">
121 <img id="dynsection-0-trigger" src="closed.png" alt="+"/> Inheritance diagram for flair::filter::NestedSat:</div>
122<div id="dynsection-0-summary" class="dynsummary" style="display:block;">
123</div>
124<div id="dynsection-0-content" class="dyncontent" style="display:none;">
125 <div class="center">
126 <img src="classflair_1_1filter_1_1_nested_sat.png" usemap="#flair::filter::NestedSat_map" alt=""/>
127 <map id="flair::filter::NestedSat_map" name="flair::filter::NestedSat_map">
128<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"/>
129<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"/>
130<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"/>
131</map>
132 </div></div>
133<table class="memberdecls">
134<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
135Public Member Functions</h2></td></tr>
136<tr class="memitem:a9a3ffb0952adc785f5b3f1e92d1a02cd"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classflair_1_1filter_1_1_nested_sat.html#a9a3ffb0952adc785f5b3f1e92d1a02cd">NestedSat</a> (const <a class="el" href="classflair_1_1gui_1_1_layout_position.html">gui::LayoutPosition</a> *position, std::string name)</td></tr>
137<tr class="memdesc:a9a3ffb0952adc785f5b3f1e92d1a02cd"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructor. <a href="#a9a3ffb0952adc785f5b3f1e92d1a02cd">More...</a><br /></td></tr>
138<tr class="separator:a9a3ffb0952adc785f5b3f1e92d1a02cd"><td class="memSeparator" colspan="2">&#160;</td></tr>
139<tr class="memitem:a899e174f442b871ecf4000f720fb11e9"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classflair_1_1filter_1_1_nested_sat.html#a899e174f442b871ecf4000f720fb11e9">~NestedSat</a> ()</td></tr>
140<tr class="memdesc:a899e174f442b871ecf4000f720fb11e9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Destructor. <a href="#a899e174f442b871ecf4000f720fb11e9">More...</a><br /></td></tr>
141<tr class="separator:a899e174f442b871ecf4000f720fb11e9"><td class="memSeparator" colspan="2">&#160;</td></tr>
142<tr class="memitem:a327a0a6562f638c4c4c7b9d14053cab4"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classflair_1_1filter_1_1_nested_sat.html#a327a0a6562f638c4c4c7b9d14053cab4">SetValues</a> (float p_ref, float p, float d)</td></tr>
143<tr class="memdesc:a327a0a6562f638c4c4c7b9d14053cab4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set input values. <a href="#a327a0a6562f638c4c4c7b9d14053cab4">More...</a><br /></td></tr>
144<tr class="separator:a327a0a6562f638c4c4c7b9d14053cab4"><td class="memSeparator" colspan="2">&#160;</td></tr>
145<tr class="memitem:a828d39a93d7e31ae92f82f52fbea6c73"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classflair_1_1filter_1_1_nested_sat.html#a828d39a93d7e31ae92f82f52fbea6c73">ConvertSatFromDegToRad</a> (void)</td></tr>
146<tr class="memdesc:a828d39a93d7e31ae92f82f52fbea6c73"><td class="mdescLeft">&#160;</td><td class="mdescRight">Convert saturation parameters in radians. <a href="#a828d39a93d7e31ae92f82f52fbea6c73">More...</a><br /></td></tr>
147<tr class="separator:a828d39a93d7e31ae92f82f52fbea6c73"><td class="memSeparator" colspan="2">&#160;</td></tr>
148<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>
149<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>
150<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>
151<tr class="separator:abd6d4ee32a9e01a2d1b0513a0aadafcb inherit pub_methods_classflair_1_1filter_1_1_control_law"><td class="memSeparator" colspan="2">&#160;</td></tr>
152<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>
153<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>
154<tr class="separator:a62210ace4d3338cbc528ed712e72ac27 inherit pub_methods_classflair_1_1filter_1_1_control_law"><td class="memSeparator" colspan="2">&#160;</td></tr>
155<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>
156<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>
157<tr class="separator:ace241d108bd0213135dbd6a5a561d0cf inherit pub_methods_classflair_1_1filter_1_1_control_law"><td class="memSeparator" colspan="2">&#160;</td></tr>
158<tr class="memitem:a3c42c9c7ae276e10d2ebad3a6701210d inherit pub_methods_classflair_1_1filter_1_1_control_law"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classflair_1_1filter_1_1_control_law.html#a3c42c9c7ae276e10d2ebad3a6701210d">UseDefaultPlot</a> (const <a class="el" href="classflair_1_1gui_1_1_layout_position.html">gui::LayoutPosition</a> *position)</td></tr>
159<tr class="memdesc:a3c42c9c7ae276e10d2ebad3a6701210d inherit pub_methods_classflair_1_1filter_1_1_control_law"><td class="mdescLeft">&#160;</td><td class="mdescRight">Use default plot. <a href="#a3c42c9c7ae276e10d2ebad3a6701210d">More...</a><br /></td></tr>
160<tr class="separator:a3c42c9c7ae276e10d2ebad3a6701210d inherit pub_methods_classflair_1_1filter_1_1_control_law"><td class="memSeparator" colspan="2">&#160;</td></tr>
161<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>
162<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>
163<tr class="separator:a228f8bf6857d96fa015bec9e016d2132 inherit pub_methods_classflair_1_1filter_1_1_control_law"><td class="memSeparator" colspan="2">&#160;</td></tr>
164<tr class="memitem:a0892ecd37930c5d92a41449ab6fa1f10 inherit pub_methods_classflair_1_1filter_1_1_control_law"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classflair_1_1filter_1_1_control_law.html#a0892ecd37930c5d92a41449ab6fa1f10">Reset</a> ()</td></tr>
165<tr class="memdesc:a0892ecd37930c5d92a41449ab6fa1f10 inherit pub_methods_classflair_1_1filter_1_1_control_law"><td class="mdescLeft">&#160;</td><td class="mdescRight">Reset the internal state of the control law. <a href="#a0892ecd37930c5d92a41449ab6fa1f10">More...</a><br /></td></tr>
166<tr class="separator:a0892ecd37930c5d92a41449ab6fa1f10 inherit pub_methods_classflair_1_1filter_1_1_control_law"><td class="memSeparator" colspan="2">&#160;</td></tr>
167<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>
168<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>
169<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>
170<tr class="separator:a9693b497752b466891eaafeb34bec4d3 inherit pub_methods_classflair_1_1core_1_1_i_o_device"><td class="memSeparator" colspan="2">&#160;</td></tr>
171<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>
172<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>
173<tr class="separator:a05246988b486def40926d8491e1bcc5f inherit pub_methods_classflair_1_1core_1_1_i_o_device"><td class="memSeparator" colspan="2">&#160;</td></tr>
174<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>
175<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>
176<tr class="separator:af7b42de6bb3893df860063228b55c229 inherit pub_methods_classflair_1_1core_1_1_i_o_device"><td class="memSeparator" colspan="2">&#160;</td></tr>
177<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>
178<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>
179<tr class="separator:a2e0b7af75abdbf39843d8bf2e45f08b9 inherit pub_methods_classflair_1_1core_1_1_i_o_device"><td class="memSeparator" colspan="2">&#160;</td></tr>
180<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>
181<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>
182<tr class="separator:a12d811c6926fb86da6b47f889109da66 inherit pub_methods_classflair_1_1core_1_1_i_o_device"><td class="memSeparator" colspan="2">&#160;</td></tr>
183<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>
184virtual <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>
185<tr class="separator:a75e82ca2ae2fb7c39d973dd3d16bc698 inherit pub_methods_classflair_1_1core_1_1_i_o_device"><td class="memSeparator" colspan="2">&#160;</td></tr>
186<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>
187virtual <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>
188<tr class="separator:aa325be57d48b268006120dde75dd65cc inherit pub_methods_classflair_1_1core_1_1_i_o_device"><td class="memSeparator" colspan="2">&#160;</td></tr>
189<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>
190<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>
191<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>
192<tr class="separator:aec92383fd5bf68d9df10414862b7e95c inherit pub_methods_classflair_1_1core_1_1_object"><td class="memSeparator" colspan="2">&#160;</td></tr>
193<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>
194<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>
195<tr class="separator:aa2bde0e6677bbef705c96c93cb06ad09 inherit pub_methods_classflair_1_1core_1_1_object"><td class="memSeparator" colspan="2">&#160;</td></tr>
196<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>
197<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>
198<tr class="separator:a9b0344dff7e1c05424d9152c8274523a inherit pub_methods_classflair_1_1core_1_1_object"><td class="memSeparator" colspan="2">&#160;</td></tr>
199<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>
200<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>
201<tr class="separator:a609a250ec037fbcaf8957c8f1dcbfc53 inherit pub_methods_classflair_1_1core_1_1_object"><td class="memSeparator" colspan="2">&#160;</td></tr>
202<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>
203<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>
204<tr class="separator:a360c112cc3017a5152ebf6e84d2efa70 inherit pub_methods_classflair_1_1core_1_1_object"><td class="memSeparator" colspan="2">&#160;</td></tr>
205<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>
206<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>
207<tr class="separator:ae22db4d723ec2d50b3ba48f26a6a770c inherit pub_methods_classflair_1_1core_1_1_object"><td class="memSeparator" colspan="2">&#160;</td></tr>
208<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>
209<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>
210<tr class="separator:a344f81cd35805a9501098bf727ac1a10 inherit pub_methods_classflair_1_1core_1_1_object"><td class="memSeparator" colspan="2">&#160;</td></tr>
211<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>
212<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>
213<tr class="separator:af001feba14fc053aa778e61080a0b4cf inherit pub_methods_classflair_1_1core_1_1_object"><td class="memSeparator" colspan="2">&#160;</td></tr>
214<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>
215<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>
216<tr class="separator:a168b18451b2ee6126e1e81d452005ff6 inherit pub_methods_classflair_1_1core_1_1_object"><td class="memSeparator" colspan="2">&#160;</td></tr>
217<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>
218<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>
219<tr class="separator:a3ca9694d29ec2b0491739879685df5ca inherit pub_methods_classflair_1_1core_1_1_object"><td class="memSeparator" colspan="2">&#160;</td></tr>
220<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>
221<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>
222<tr class="separator:a36cdd7f556e78b1bddd1d1fe4264bb85 inherit pub_methods_classflair_1_1core_1_1_object"><td class="memSeparator" colspan="2">&#160;</td></tr>
223</table><table class="memberdecls">
224<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="inherited"></a>
225Additional Inherited Members</h2></td></tr>
226<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>
227<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,
228<b>Red</b> = 31,
229<b>Green</b> = 32,
230<b>Orange</b> = 33
231 }</td></tr>
232<tr class="separator:aed5fccda511f97487040fed29f4efc97 inherit pub_types_classflair_1_1core_1_1_object"><td class="memSeparator" colspan="2">&#160;</td></tr>
233<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>
234<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>
235<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>
236<tr class="separator:a3df9057ae23eb34f1b1dae8e7a4a9efc inherit pro_methods_classflair_1_1core_1_1_i_o_device"><td class="memSeparator" colspan="2">&#160;</td></tr>
237<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>
238<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>
239<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>
240<tr class="separator:a9877d488ad17a52affd8c68beca426d1 inherit pro_attribs_classflair_1_1filter_1_1_control_law"><td class="memSeparator" colspan="2">&#160;</td></tr>
241<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>
242<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>
243<tr class="separator:aad8a67d158a1eda16ed53615e2511f97 inherit pro_attribs_classflair_1_1filter_1_1_control_law"><td class="memSeparator" colspan="2">&#160;</td></tr>
244</table>
245<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
246<div class="textblock"><p>Class defining a PID with saturations. </p>
247<p>The output of this control law is calculated as follows: <br />
248 p_ref=Sat(p_ref,k*sat_ref) <br />
249 d_ref=Sat[(p_ref-p)*kp,k*sat_dref] <br />
250 law=Sat[(d-d_ref)*kd,sat_u] <br />
251 where p, p_ref and d are input values (see <a class="el" href="classflair_1_1filter_1_1_nested_sat.html#a327a0a6562f638c4c4c7b9d14053cab4" title="Set input values. ">SetValues()</a>), <br />
252 where sat_ref, sat_dref and sat_u are settings availables on the ground station, <br />
253 where k is a conversion factor (see <a class="el" href="classflair_1_1filter_1_1_nested_sat.html#a828d39a93d7e31ae92f82f52fbea6c73" title="Convert saturation parameters in radians. ">ConvertSatFromDegToRad()</a>). </p>
254</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
255<a class="anchor" id="a9a3ffb0952adc785f5b3f1e92d1a02cd"></a>
256<div class="memitem">
257<div class="memproto">
258 <table class="memname">
259 <tr>
260 <td class="memname">flair::filter::NestedSat::NestedSat </td>
261 <td>(</td>
262 <td class="paramtype">const <a class="el" href="classflair_1_1gui_1_1_layout_position.html">gui::LayoutPosition</a> *&#160;</td>
263 <td class="paramname"><em>position</em>, </td>
264 </tr>
265 <tr>
266 <td class="paramkey"></td>
267 <td></td>
268 <td class="paramtype">std::string&#160;</td>
269 <td class="paramname"><em>name</em>&#160;</td>
270 </tr>
271 <tr>
272 <td></td>
273 <td>)</td>
274 <td></td><td></td>
275 </tr>
276 </table>
277</div><div class="memdoc">
278
279<p>Constructor. </p>
280<p>Construct a <a class="el" href="classflair_1_1filter_1_1_nested_sat.html" title="Class defining a PID with saturations. ">NestedSat</a> at given place position. <br />
281 The <a class="el" href="classflair_1_1filter_1_1_nested_sat.html" title="Class defining a PID with saturations. ">NestedSat</a> will automatically be child of position-&gt;getLayout() Layout. After calling this function, position will be deleted as it is no longer usefull. <br />
282 </p><dl class="params"><dt>Parameters</dt><dd>
283 <table class="params">
284 <tr><td class="paramname">position</td><td>position to display settings </td></tr>
285 <tr><td class="paramname">name</td><td>name </td></tr>
286 </table>
287 </dd>
288</dl>
289
290</div>
291</div>
292<a class="anchor" id="a899e174f442b871ecf4000f720fb11e9"></a>
293<div class="memitem">
294<div class="memproto">
295 <table class="memname">
296 <tr>
297 <td class="memname">flair::filter::NestedSat::~NestedSat </td>
298 <td>(</td>
299 <td class="paramname"></td><td>)</td>
300 <td></td>
301 </tr>
302 </table>
303</div><div class="memdoc">
304
305<p>Destructor. </p>
306
307</div>
308</div>
309<h2 class="groupheader">Member Function Documentation</h2>
310<a class="anchor" id="a327a0a6562f638c4c4c7b9d14053cab4"></a>
311<div class="memitem">
312<div class="memproto">
313 <table class="memname">
314 <tr>
315 <td class="memname">void flair::filter::NestedSat::SetValues </td>
316 <td>(</td>
317 <td class="paramtype">float&#160;</td>
318 <td class="paramname"><em>p_ref</em>, </td>
319 </tr>
320 <tr>
321 <td class="paramkey"></td>
322 <td></td>
323 <td class="paramtype">float&#160;</td>
324 <td class="paramname"><em>p</em>, </td>
325 </tr>
326 <tr>
327 <td class="paramkey"></td>
328 <td></td>
329 <td class="paramtype">float&#160;</td>
330 <td class="paramname"><em>d</em>&#160;</td>
331 </tr>
332 <tr>
333 <td></td>
334 <td>)</td>
335 <td></td><td></td>
336 </tr>
337 </table>
338</div><div class="memdoc">
339
340<p>Set input values. </p>
341<dl class="params"><dt>Parameters</dt><dd>
342 <table class="params">
343 <tr><td class="paramname">p_ref</td><td>proportional reference </td></tr>
344 <tr><td class="paramname">p</td><td>proportional value </td></tr>
345 <tr><td class="paramname">d</td><td>derivative value </td></tr>
346 </table>
347 </dd>
348</dl>
349
350</div>
351</div>
352<a class="anchor" id="a828d39a93d7e31ae92f82f52fbea6c73"></a>
353<div class="memitem">
354<div class="memproto">
355 <table class="memname">
356 <tr>
357 <td class="memname">void flair::filter::NestedSat::ConvertSatFromDegToRad </td>
358 <td>(</td>
359 <td class="paramtype">void&#160;</td>
360 <td class="paramname"></td><td>)</td>
361 <td></td>
362 </tr>
363 </table>
364</div><div class="memdoc">
365
366<p>Convert saturation parameters in radians. </p>
367<p>If this function is called, saturation parameters on the ground station will be interpreted as degrees. <br />
368Thus, an internal conversion from degrees to radians will be done (k=PI/180). </p>
369
370</div>
371</div>
372</div><!-- contents -->
373</div><!-- doc-content -->
374<!-- start footer part -->
375<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
376 <ul>
377 <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_nested_sat.html">NestedSat</a></li>
378 <li class="footer">Generated on Thu Apr 21 2016 11:41:05 for Flair by
379 <a href="http://www.doxygen.org/index.html">
380 <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.7 </li>
381 </ul>
382</div>
383</body>
384</html>
Note: See TracBrowser for help on using the repository browser.