diff options
Diffstat (limited to 'docs/doxygen/html/class_gain.html')
| -rw-r--r-- | docs/doxygen/html/class_gain.html | 90 |
1 files changed, 77 insertions, 13 deletions
diff --git a/docs/doxygen/html/class_gain.html b/docs/doxygen/html/class_gain.html index 8c502b5..65c0902 100644 --- a/docs/doxygen/html/class_gain.html +++ b/docs/doxygen/html/class_gain.html @@ -21,6 +21,12 @@ <link href="search/search.css" rel="stylesheet" type="text/css"/> <script type="text/javascript" src="search/searchdata.js"></script> <script type="text/javascript" src="search/search.js"></script> +<script type="text/x-mathjax-config"> + MathJax.Hub.Config({ + extensions: ["tex2jax.js"], + jax: ["input/TeX","output/HTML-CSS"], +}); +</script><script type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.2/MathJax.js"></script> <link href="doxygen.css" rel="stylesheet" type="text/css" /> </head> <body> @@ -86,6 +92,11 @@ $(document).ready(function(){initNavTree('class_gain.html','');}); <div class="title">Gain Class Reference</div> </div> </div><!--header--> <div class="contents"> + +<p>Provide an output multiplying the input by a constant. + <a href="class_gain.html#details">More...</a></p> + +<p><code>#include <<a class="el" href="_gain_8h_source.html">Gain.h</a>></code></p> <div class="dynheader"> Inheritance diagram for Gain:</div> <div class="dyncontent"> @@ -93,7 +104,7 @@ Inheritance diagram for Gain:</div> <img src="class_gain.png" usemap="#Gain_map" alt=""/> <map id="Gain_map" name="Gain_map"> <area href="class_control_element.html" alt="ControlElement" shape="rect" coords="0,56,97,80"/> -<area href="class_element.html" alt="Element" shape="rect" coords="0,0,97,24"/> +<area href="class_element.html" title="Base class of all elements of the program. This class is responsible for manage graphical and his dat..." alt="Element" shape="rect" coords="0,0,97,24"/> </map> </div></div> <table class="memberdecls"> @@ -132,8 +143,8 @@ virtual double </td><td class="memItemRight" valign="bottom"><b>GetValue</b <tr class="memitem:a9930247d3cee160ac2ae815ad865f077"><td class="memItemLeft" align="right" valign="top"><a id="a9930247d3cee160ac2ae815ad865f077"></a> virtual void </td><td class="memItemRight" valign="bottom"><b>UpdatePoints</b> ()</td></tr> <tr class="separator:a9930247d3cee160ac2ae815ad865f077"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:a282cab6d339aa89a35c775bbea2aa117"><td class="memItemLeft" align="right" valign="top"><a id="a282cab6d339aa89a35c775bbea2aa117"></a> -virtual bool </td><td class="memItemRight" valign="bottom"><b>Solve</b> (double input, double timeStep)</td></tr> +<tr class="memitem:a282cab6d339aa89a35c775bbea2aa117"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_gain.html#a282cab6d339aa89a35c775bbea2aa117">Solve</a> (double input, double timeStep)</td></tr> +<tr class="memdesc:a282cab6d339aa89a35c775bbea2aa117"><td class="mdescLeft"> </td><td class="mdescRight">Multiply the input by a constant. <a href="#a282cab6d339aa89a35c775bbea2aa117">More...</a><br /></td></tr> <tr class="separator:a282cab6d339aa89a35c775bbea2aa117"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a489572e289935d7256c037af682b9351"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="class_element.html">Element</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="class_gain.html#a489572e289935d7256c037af682b9351">GetCopy</a> ()</td></tr> <tr class="memdesc:a489572e289935d7256c037af682b9351"><td class="mdescLeft"> </td><td class="mdescRight">Get a the element copy. <a href="#a489572e289935d7256c037af682b9351">More...</a><br /></td></tr> @@ -471,8 +482,11 @@ Additional Inherited Members</h2></td></tr> <tr class="separator:abb2e253ec1e86353cd7160209c96553c inherit pub_static_methods_class_element"><td class="memSeparator" colspan="2"> </td></tr> </table> <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> -<div class="textblock"> -<p class="definition">Definition at line <a class="el" href="_gain_8h_source.html#l00011">11</a> of file <a class="el" href="_gain_8h_source.html">Gain.h</a>.</p> +<div class="textblock"><p>Provide an output multiplying the input by a constant. </p> +<dl class="section author"><dt>Author</dt><dd>Thales Lima Oliveira <a href="#" onclick="location.href='mai'+'lto:'+'tha'+'le'+'s@u'+'fu'+'.br'; return false;">thale<span style="display: none;">.nosp@m.</span>s@uf<span style="display: none;">.nosp@m.</span>u.br</a> </dd></dl> +<dl class="section date"><dt>Date</dt><dd>05/10/2017 </dd></dl> + +<p class="definition">Definition at line <a class="el" href="_gain_8h_source.html#l00035">35</a> of file <a class="el" href="_gain_8h_source.html">Gain.h</a>.</p> </div><h2 class="groupheader">Member Function Documentation</h2> <a id="a9d80d49f5123cf4859bf15a251e3923f"></a> <h2 class="memtitle"><span class="permalink"><a href="#a9d80d49f5123cf4859bf15a251e3923f">◆ </a></span>Contains()</h2> @@ -508,7 +522,7 @@ Additional Inherited Members</h2></td></tr> <p>Implements <a class="el" href="class_element.html#abf6c4949733debca55b2f56d8e9b7372">Element</a>.</p> -<p class="definition">Definition at line <a class="el" href="_gain_8h_source.html#l00018">18</a> of file <a class="el" href="_gain_8h_source.html">Gain.h</a>.</p> +<p class="definition">Definition at line <a class="el" href="_gain_8h_source.html#l00042">42</a> of file <a class="el" href="_gain_8h_source.html">Gain.h</a>.</p> </div> </div> @@ -557,7 +571,7 @@ Additional Inherited Members</h2></td></tr> <p>Reimplemented from <a class="el" href="class_element.html#a551ed1eeab446b5366d56c2ee9dec187">Element</a>.</p> -<p class="definition">Definition at line <a class="el" href="_gain_8cpp_source.html#l00018">18</a> of file <a class="el" href="_gain_8cpp_source.html">Gain.cpp</a>.</p> +<p class="definition">Definition at line <a class="el" href="_gain_8cpp_source.html#l00035">35</a> of file <a class="el" href="_gain_8cpp_source.html">Gain.cpp</a>.</p> </div> </div> @@ -589,7 +603,7 @@ Additional Inherited Members</h2></td></tr> <p>Reimplemented from <a class="el" href="class_element.html#aeabe64a5907e917c8b61afd605ea52c3">Element</a>.</p> -<p class="definition">Definition at line <a class="el" href="_gain_8cpp_source.html#l00177">177</a> of file <a class="el" href="_gain_8cpp_source.html">Gain.cpp</a>.</p> +<p class="definition">Definition at line <a class="el" href="_gain_8cpp_source.html#l00194">194</a> of file <a class="el" href="_gain_8cpp_source.html">Gain.cpp</a>.</p> </div> </div> @@ -627,7 +641,7 @@ Additional Inherited Members</h2></td></tr> <p>Implements <a class="el" href="class_element.html#a038dfd8452fe48ab04bc4e47820c148e">Element</a>.</p> -<p class="definition">Definition at line <a class="el" href="_gain_8h_source.html#l00019">19</a> of file <a class="el" href="_gain_8h_source.html">Gain.h</a>.</p> +<p class="definition">Definition at line <a class="el" href="_gain_8h_source.html#l00043">43</a> of file <a class="el" href="_gain_8h_source.html">Gain.h</a>.</p> </div> </div> @@ -665,7 +679,7 @@ Additional Inherited Members</h2></td></tr> <p>Reimplemented from <a class="el" href="class_control_element.html#ac8bd52ddb8eed51a217fecb2eed65708">ControlElement</a>.</p> -<p class="definition">Definition at line <a class="el" href="_gain_8cpp_source.html#l00165">165</a> of file <a class="el" href="_gain_8cpp_source.html">Gain.cpp</a>.</p> +<p class="definition">Definition at line <a class="el" href="_gain_8cpp_source.html#l00182">182</a> of file <a class="el" href="_gain_8cpp_source.html">Gain.cpp</a>.</p> </div> </div> @@ -703,7 +717,7 @@ Additional Inherited Members</h2></td></tr> <p>Reimplemented from <a class="el" href="class_element.html#afab568cea0a7074bb9984e94bd2ba52e">Element</a>.</p> -<p class="definition">Definition at line <a class="el" href="_gain_8cpp_source.html#l00082">82</a> of file <a class="el" href="_gain_8cpp_source.html">Gain.cpp</a>.</p> +<p class="definition">Definition at line <a class="el" href="_gain_8cpp_source.html#l00099">99</a> of file <a class="el" href="_gain_8cpp_source.html">Gain.cpp</a>.</p> </div> </div> @@ -745,7 +759,7 @@ Additional Inherited Members</h2></td></tr> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">parent</td><td>Form parent </td></tr> - <tr><td class="paramname">element</td><td><a class="el" href="class_element.html">Element</a> that will be edited. </td></tr> + <tr><td class="paramname">element</td><td><a class="el" href="class_element.html" title="Base class of all elements of the program. This class is responsible for manage graphical and his dat...">Element</a> that will be edited. </td></tr> </table> </dd> </dl> @@ -753,7 +767,57 @@ Additional Inherited Members</h2></td></tr> <p>Reimplemented from <a class="el" href="class_element.html#ae1652eded3ccbd241a783691117418b2">Element</a>.</p> -<p class="definition">Definition at line <a class="el" href="_gain_8cpp_source.html#l00071">71</a> of file <a class="el" href="_gain_8cpp_source.html">Gain.cpp</a>.</p> +<p class="definition">Definition at line <a class="el" href="_gain_8cpp_source.html#l00088">88</a> of file <a class="el" href="_gain_8cpp_source.html">Gain.cpp</a>.</p> + +</div> +</div> +<a id="a282cab6d339aa89a35c775bbea2aa117"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a282cab6d339aa89a35c775bbea2aa117">◆ </a></span>Solve()</h2> + +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">bool Gain::Solve </td> + <td>(</td> + <td class="paramtype">double </td> + <td class="paramname"><em>input</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">double </td> + <td class="paramname"><em>timeStep</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">virtual</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> + +<p>Multiply the input by a constant. </p> +<center> \( output = K \cdot input \)</center> <dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">input</td><td>Input value. </td></tr> + <tr><td class="paramname">timeStep</td><td>Time step. </td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>Always true. </dd></dl> + +<p>Reimplemented from <a class="el" href="class_control_element.html">ControlElement</a>.</p> + +<p class="definition">Definition at line <a class="el" href="_gain_8cpp_source.html#l00188">188</a> of file <a class="el" href="_gain_8cpp_source.html">Gain.cpp</a>.</p> </div> </div> |