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_gain.html | 32 +++++++++++++++++++++++--------- 1 file changed, 23 insertions(+), 9 deletions(-) (limited to 'docs/doxygen/html/class_gain.html') diff --git a/docs/doxygen/html/class_gain.html b/docs/doxygen/html/class_gain.html index 8c502b5..4dd5e4f 100644 --- a/docs/doxygen/html/class_gain.html +++ b/docs/doxygen/html/class_gain.html @@ -21,6 +21,12 @@ + @@ -86,6 +92,11 @@ $(document).ready(function(){initNavTree('class_gain.html','');});
Gain Class Reference
+ +

Provide an output multiplying the input by a constant. \( output = K \cdot input \). + More...

+ +

#include <Gain.h>

Inheritance diagram for Gain:
@@ -471,8 +482,11 @@ Additional Inherited Members  

Detailed Description

-
-

Definition at line 11 of file Gain.h.

+

Provide an output multiplying the input by a constant. \( output = K \cdot input \).

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

Definition at line 36 of file Gain.h.

Member Function Documentation

◆ Contains()

@@ -508,7 +522,7 @@ Additional Inherited Members

Implements Element.

-

Definition at line 18 of file Gain.h.

+

Definition at line 43 of file Gain.h.

@@ -557,7 +571,7 @@ Additional Inherited Members

Reimplemented from Element.

-

Definition at line 18 of file Gain.cpp.

+

Definition at line 35 of file Gain.cpp.

@@ -589,7 +603,7 @@ Additional Inherited Members

Reimplemented from Element.

-

Definition at line 177 of file Gain.cpp.

+

Definition at line 194 of file Gain.cpp.

@@ -627,7 +641,7 @@ Additional Inherited Members

Implements Element.

-

Definition at line 19 of file Gain.h.

+

Definition at line 44 of file Gain.h.

@@ -665,7 +679,7 @@ Additional Inherited Members

Reimplemented from ControlElement.

-

Definition at line 165 of file Gain.cpp.

+

Definition at line 182 of file Gain.cpp.

@@ -703,7 +717,7 @@ Additional Inherited Members

Reimplemented from Element.

-

Definition at line 82 of file Gain.cpp.

+

Definition at line 99 of file Gain.cpp.

@@ -753,7 +767,7 @@ Additional Inherited Members

Reimplemented from Element.

-

Definition at line 71 of file Gain.cpp.

+

Definition at line 88 of file Gain.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_gain.html | 68 +++++++++++++++++++++++++++++++++------ 1 file changed, 59 insertions(+), 9 deletions(-) (limited to 'docs/doxygen/html/class_gain.html') diff --git a/docs/doxygen/html/class_gain.html b/docs/doxygen/html/class_gain.html index 4dd5e4f..65c0902 100644 --- a/docs/doxygen/html/class_gain.html +++ b/docs/doxygen/html/class_gain.html @@ -93,7 +93,7 @@ $(document).ready(function(){initNavTree('class_gain.html','');});
-

Provide an output multiplying the input by a constant. \( output = K \cdot input \). +

Provide an output multiplying the input by a constant. More...

#include <Gain.h>

@@ -104,7 +104,7 @@ Inheritance diagram for Gain:
ControlElement -Element +Element @@ -143,8 +143,8 @@ virtual double  - + + @@ -482,11 +482,11 @@ Additional Inherited Members
GetValue virtual void UpdatePoints ()
 
-virtual bool Solve (double input, double timeStep)
virtual bool Solve (double input, double timeStep)
 Multiply the input by a constant. More...
 
virtual Element * GetCopy ()
 Get a the element copy. More...
 

Detailed Description

-

Provide an output multiplying the input by a constant. \( output = K \cdot input \).

+

Provide an output multiplying the input by a constant.

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

Definition at line 36 of file Gain.h.

+

Definition at line 35 of file Gain.h.

Member Function Documentation

◆ Contains()

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

Implements Element.

-

Definition at line 43 of file Gain.h.

+

Definition at line 42 of file Gain.h.

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

Implements Element.

-

Definition at line 44 of file Gain.h.

+

Definition at line 43 of file Gain.h.

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

Definition at line 88 of file Gain.cpp.

+ + + +

◆ Solve()

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

Multiply the input by a constant.

+
\( output = K \cdot input \)
Parameters
+ + + +
inputInput value.
timeStepTime step.
+
+
+
Returns
Always true.
+ +

Reimplemented from ControlElement.

+ +

Definition at line 188 of file Gain.cpp.

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