summaryrefslogtreecommitdiffstats
path: root/docs/doxygen/html/class_exponential.html
diff options
context:
space:
mode:
authorThales Lima Oliveira <thaleslima.ufu@gmail.com>2017-10-06 17:06:15 -0300
committerThales Lima Oliveira <thaleslima.ufu@gmail.com>2017-10-06 17:06:15 -0300
commit89befdb9b259d02249876e39ec6fd28860272439 (patch)
tree054de50365749426623bed352a10e84299e84cad /docs/doxygen/html/class_exponential.html
parentbc5a3e8923cb8efedbbd5b88e212eb0e9009cf87 (diff)
downloadPSP.git-89befdb9b259d02249876e39ec6fd28860272439.tar.gz
PSP.git-89befdb9b259d02249876e39ec6fd28860272439.tar.xz
PSP.git-89befdb9b259d02249876e39ec6fd28860272439.zip
A lot of documentation written
Diffstat (limited to 'docs/doxygen/html/class_exponential.html')
-rw-r--r--docs/doxygen/html/class_exponential.html68
1 files changed, 59 insertions, 9 deletions
diff --git a/docs/doxygen/html/class_exponential.html b/docs/doxygen/html/class_exponential.html
index c5a7707..f7b9b7b 100644
--- a/docs/doxygen/html/class_exponential.html
+++ b/docs/doxygen/html/class_exponential.html
@@ -93,7 +93,7 @@ $(document).ready(function(){initNavTree('class_exponential.html','');});
</div><!--header-->
<div class="contents">
-<p>Generates an output following an exponential function. \( output = A\cdot e^{B\cdot input} \).
+<p>Generates an output following an exponential function.
<a href="class_exponential.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="_exponential_8h_source.html">Exponential.h</a>&gt;</code></p>
@@ -104,7 +104,7 @@ Inheritance diagram for Exponential:</div>
<img src="class_exponential.png" usemap="#Exponential_map" alt=""/>
<map id="Exponential_map" name="Exponential_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">
@@ -137,8 +137,8 @@ virtual void&#160;</td><td class="memItemRight" valign="bottom"><b>GetValues</b>
<tr class="memitem:a0ebfd386bebb9a1f9d41a3eca0daed3b"><td class="memItemLeft" align="right" valign="top"><a id="a0ebfd386bebb9a1f9d41a3eca0daed3b"></a>
virtual void&#160;</td><td class="memItemRight" valign="bottom"><b>SetValues</b> (double aValue, double bValue)</td></tr>
<tr class="separator:a0ebfd386bebb9a1f9d41a3eca0daed3b"><td class="memSeparator" colspan="2">&#160;</td></tr>
-<tr class="memitem:ae8e635b32b5d6a8226a3654aa639094f"><td class="memItemLeft" align="right" valign="top"><a id="ae8e635b32b5d6a8226a3654aa639094f"></a>
-virtual bool&#160;</td><td class="memItemRight" valign="bottom"><b>Solve</b> (double input, double timeStep)</td></tr>
+<tr class="memitem:ae8e635b32b5d6a8226a3654aa639094f"><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_exponential.html#ae8e635b32b5d6a8226a3654aa639094f">Solve</a> (double input, double timeStep)</td></tr>
+<tr class="memdesc:ae8e635b32b5d6a8226a3654aa639094f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Calculates the exponential. <a href="#ae8e635b32b5d6a8226a3654aa639094f">More...</a><br /></td></tr>
<tr class="separator:ae8e635b32b5d6a8226a3654aa639094f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a85cda0dba6549828a9045e478e24609f"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="class_element.html">Element</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_exponential.html#a85cda0dba6549828a9045e478e24609f">GetCopy</a> ()</td></tr>
<tr class="memdesc:a85cda0dba6549828a9045e478e24609f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get a the element copy. <a href="#a85cda0dba6549828a9045e478e24609f">More...</a><br /></td></tr>
@@ -476,11 +476,11 @@ Additional Inherited Members</h2></td></tr>
<tr class="separator:abb2e253ec1e86353cd7160209c96553c inherit pub_static_methods_class_element"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
-<div class="textblock"><p>Generates an output following an exponential function. \( output = A\cdot e^{B\cdot input} \). </p>
+<div class="textblock"><p>Generates an output following an exponential function. </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="_exponential_8h_source.html#l00033">33</a> of file <a class="el" href="_exponential_8h_source.html">Exponential.h</a>.</p>
+<p class="definition">Definition at line <a class="el" href="_exponential_8h_source.html#l00032">32</a> of file <a class="el" href="_exponential_8h_source.html">Exponential.h</a>.</p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a id="a79eabfca357002f160b082a6df9f6f2b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a79eabfca357002f160b082a6df9f6f2b">&#9670;&nbsp;</a></span>Contains()</h2>
@@ -516,7 +516,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="_exponential_8h_source.html#l00040">40</a> of file <a class="el" href="_exponential_8h_source.html">Exponential.h</a>.</p>
+<p class="definition">Definition at line <a class="el" href="_exponential_8h_source.html#l00039">39</a> of file <a class="el" href="_exponential_8h_source.html">Exponential.h</a>.</p>
</div>
</div>
@@ -635,7 +635,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="_exponential_8h_source.html#l00041">41</a> of file <a class="el" href="_exponential_8h_source.html">Exponential.h</a>.</p>
+<p class="definition">Definition at line <a class="el" href="_exponential_8h_source.html#l00040">40</a> of file <a class="el" href="_exponential_8h_source.html">Exponential.h</a>.</p>
</div>
</div>
@@ -715,7 +715,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>
@@ -727,6 +727,56 @@ Additional Inherited Members</h2></td></tr>
</div>
</div>
+<a id="ae8e635b32b5d6a8226a3654aa639094f"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#ae8e635b32b5d6a8226a3654aa639094f">&#9670;&nbsp;</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 Exponential::Solve </td>
+ <td>(</td>
+ <td class="paramtype">double&#160;</td>
+ <td class="paramname"><em>input</em>, </td>
+ </tr>
+ <tr>
+ <td class="paramkey"></td>
+ <td></td>
+ <td class="paramtype">double&#160;</td>
+ <td class="paramname"><em>timeStep</em>&#160;</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>Calculates the exponential. </p>
+<center> \( output = A\cdot e^{B\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>Aways 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="_exponential_8cpp_source.html#l00132">132</a> of file <a class="el" href="_exponential_8cpp_source.html">Exponential.cpp</a>.</p>
+
+</div>
+</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li>Project/<a class="el" href="_exponential_8h_source.html">Exponential.h</a></li>
<li>Project/<a class="el" href="_exponential_8cpp_source.html">Exponential.cpp</a></li>