diff options
| author | Thales Lima Oliveira <thaleslima.ufu@gmail.com> | 2017-10-06 17:06:15 -0300 |
|---|---|---|
| committer | Thales Lima Oliveira <thaleslima.ufu@gmail.com> | 2017-10-06 17:06:15 -0300 |
| commit | 89befdb9b259d02249876e39ec6fd28860272439 (patch) | |
| tree | 054de50365749426623bed352a10e84299e84cad /Project/Gain.h | |
| parent | bc5a3e8923cb8efedbbd5b88e212eb0e9009cf87 (diff) | |
| download | PSP.git-89befdb9b259d02249876e39ec6fd28860272439.tar.gz PSP.git-89befdb9b259d02249876e39ec6fd28860272439.tar.xz PSP.git-89befdb9b259d02249876e39ec6fd28860272439.zip | |
A lot of documentation written
Diffstat (limited to 'Project/Gain.h')
| -rw-r--r-- | Project/Gain.h | 10 |
1 files changed, 8 insertions, 2 deletions
diff --git a/Project/Gain.h b/Project/Gain.h index 6b378d2..7245e2f 100644 --- a/Project/Gain.h +++ b/Project/Gain.h @@ -30,7 +30,6 @@ class GainForm; * @author Thales Lima Oliveira <thales@ufu.br> * @date 05/10/2017 * @brief Provide an output multiplying the input by a constant. - * \f$ output = K \cdot input \f$ * @file Gain.h */ class Gain : public ControlElement @@ -49,7 +48,14 @@ class Gain : public ControlElement virtual void SetValue(double value); virtual double GetValue() const { return m_value; } virtual void UpdatePoints(); - + /** + * @brief Multiply the input by a constant + * + * <center>\f$ output = K \cdot input \f$</center> + * @param input Input value. + * @param timeStep Time step. + * @return Always true. + */ virtual bool Solve(double input, double timeStep); virtual Element* GetCopy(); |