From bc5a3e8923cb8efedbbd5b88e212eb0e9009cf87 Mon Sep 17 00:00:00 2001 From: Thales Lima Oliveira Date: Thu, 5 Oct 2017 20:02:59 -0300 Subject: Add copyright on files and documentation update --- docs/doxygen/html/class_exponential.html | 30 ++++++++++++++++++++++-------- 1 file changed, 22 insertions(+), 8 deletions(-) (limited to 'docs/doxygen/html/class_exponential.html') diff --git a/docs/doxygen/html/class_exponential.html b/docs/doxygen/html/class_exponential.html index 833e923..c5a7707 100644 --- a/docs/doxygen/html/class_exponential.html +++ b/docs/doxygen/html/class_exponential.html @@ -21,6 +21,12 @@ + @@ -86,6 +92,11 @@ $(document).ready(function(){initNavTree('class_exponential.html','');});
Exponential Class Reference
+ +

Generates an output following an exponential function. \( output = A\cdot e^{B\cdot input} \). + More...

+ +

#include <Exponential.h>

Inheritance diagram for Exponential:
@@ -465,8 +476,11 @@ Additional Inherited Members  

Detailed Description

-
-

Definition at line 8 of file Exponential.h.

+

Generates an output following an exponential function. \( output = A\cdot e^{B\cdot input} \).

+
Author
Thales Lima Oliveira thale.nosp@m.s@uf.nosp@m.u.br
+
Date
05/10/2017
+ +

Definition at line 33 of file Exponential.h.

Member Function Documentation

◆ Contains()

@@ -502,7 +516,7 @@ Additional Inherited Members

Implements Element.

-

Definition at line 15 of file Exponential.h.

+

Definition at line 40 of file Exponential.h.

@@ -551,7 +565,7 @@ Additional Inherited Members

Reimplemented from Element.

-

Definition at line 17 of file Exponential.cpp.

+

Definition at line 34 of file Exponential.cpp.

@@ -583,7 +597,7 @@ Additional Inherited Members

Reimplemented from Element.

-

Definition at line 121 of file Exponential.cpp.

+

Definition at line 138 of file Exponential.cpp.

@@ -621,7 +635,7 @@ Additional Inherited Members

Implements Element.

-

Definition at line 16 of file Exponential.h.

+

Definition at line 41 of file Exponential.h.

@@ -659,7 +673,7 @@ Additional Inherited Members

Reimplemented from Element.

-

Definition at line 67 of file Exponential.cpp.

+

Definition at line 84 of file Exponential.cpp.

@@ -709,7 +723,7 @@ Additional Inherited Members

Reimplemented from Element.

-

Definition at line 56 of file Exponential.cpp.

+

Definition at line 73 of file Exponential.cpp.

-- cgit From 89befdb9b259d02249876e39ec6fd28860272439 Mon Sep 17 00:00:00 2001 From: Thales Lima Oliveira Date: Fri, 6 Oct 2017 17:06:15 -0300 Subject: A lot of documentation written --- docs/doxygen/html/class_exponential.html | 68 +++++++++++++++++++++++++++----- 1 file changed, 59 insertions(+), 9 deletions(-) (limited to 'docs/doxygen/html/class_exponential.html') 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','');});
-

Generates an output following an exponential function. \( output = A\cdot e^{B\cdot input} \). +

Generates an output following an exponential function. More...

#include <Exponential.h>

@@ -104,7 +104,7 @@ Inheritance diagram for Exponential:
ControlElement -Element +Element @@ -137,8 +137,8 @@ virtual void  - + + @@ -476,11 +476,11 @@ Additional Inherited Members
GetValues
virtual void SetValues (double aValue, double bValue)
 
-virtual bool Solve (double input, double timeStep)
virtual bool Solve (double input, double timeStep)
 Calculates the exponential. More...
 
virtual Element * GetCopy ()
 Get a the element copy. More...
 

Detailed Description

-

Generates an output following an exponential function. \( output = A\cdot e^{B\cdot input} \).

+

Generates an output following an exponential function.

Author
Thales Lima Oliveira thale.nosp@m.s@uf.nosp@m.u.br
Date
05/10/2017
-

Definition at line 33 of file Exponential.h.

+

Definition at line 32 of file Exponential.h.

Member Function Documentation

◆ Contains()

@@ -516,7 +516,7 @@ Additional Inherited Members

Implements Element.

-

Definition at line 40 of file Exponential.h.

+

Definition at line 39 of file Exponential.h.

@@ -635,7 +635,7 @@ Additional Inherited Members

Implements Element.

-

Definition at line 41 of file Exponential.h.

+

Definition at line 40 of file Exponential.h.

@@ -715,7 +715,7 @@ Additional Inherited Members
Parameters
- +
parentForm parent
elementElement that will be edited.
elementElement that will be edited.
@@ -725,6 +725,56 @@ Additional Inherited Members

Definition at line 73 of file Exponential.cpp.

+ + + +

◆ Solve()

+ +
+
+ + + + + +
+ + + + + + + + + + + + + + + + + + +
bool Exponential::Solve (double input,
double timeStep 
)
+ 		+virtual
+
+ +

Calculates the exponential.

+
\( output = A\cdot e^{B\cdot input} \)
Parameters
+ + + +
inputInput value.
timeStepTime step.
+
+
+
Returns
Aways true.
+ +

Reimplemented from ControlElement.

+ +

Definition at line 132 of file Exponential.cpp.

+
The documentation for this class was generated from the following files: