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_element.html | 66 +++++++++++++++++++----------------- 1 file changed, 35 insertions(+), 31 deletions(-) (limited to 'docs/doxygen/html/class_element.html') diff --git a/docs/doxygen/html/class_element.html b/docs/doxygen/html/class_element.html index e22ec4d..2045891 100644 --- a/docs/doxygen/html/class_element.html +++ b/docs/doxygen/html/class_element.html @@ -94,6 +94,9 @@ $(document).ready(function(){initNavTree('class_element.html','');});
+

Base class of all elements of the program. This class is responsible for manage graphical and his data. + More...

+

#include <Element.h>

Inheritance diagram for Element:
@@ -102,23 +105,23 @@ Inheritance diagram for Element:
ControlElement -GraphicalElement -PowerElement +GraphicalElement +PowerElement ConnectionLine Constant -Exponential -Gain +Exponential +Gain IOControl Limiter Multiplier RateLimiter -Sum -TransferFunction -Text -Branch -Bus -Machines -Shunt +Sum +TransferFunction +Text +Branch +Bus +Machines +Shunt @@ -425,7 +428,8 @@ bool 
m_online = true 

Detailed Description

-
Author
Thales Lima Oliveira thale.nosp@m.s@uf.nosp@m.u.br
+

Base class of all elements of the program. This class is responsible for manage graphical and his data.

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

Definition at line 113 of file Element.h.

@@ -503,7 +507,7 @@ bool m_online = trueAdd a parent to the element. This method must be used on power elements that connect to a bus, so the parent must be a bus. The element basic points are calculated in this method, so apply this when the element is being inserted.

Parameters
- +
parentElement parent.
parentElement parent.
positionNode position in the parent.
@@ -542,7 +546,7 @@ bool m_online = trueAdd a parent to the element.

Parameters
- +
parentElement parent.
parentElement parent.
@@ -670,7 +674,7 @@ bool m_online = true
-

Implemented in Transformer, Text, Bus, Line, IOControl, Gain, Constant, TransferFunction, Capacitor, Inductor, Exponential, ConnectionLine, Limiter, Multiplier, RateLimiter, Machines, Sum, Branch, and Shunt.

+

Implemented in Transformer, Text, Bus, Line, IOControl, TransferFunction, Capacitor, Inductor, Constant, Gain, Machines, Sum, ConnectionLine, Exponential, Limiter, Multiplier, RateLimiter, Branch, and Shunt.

@@ -778,7 +782,7 @@ bool m_online = true -

Reimplemented in Transformer, Bus, Line, IOControl, Load, Gain, Constant, TransferFunction, Capacitor, Inductor, Exponential, ConnectionLine, Limiter, Multiplier, RateLimiter, Machines, Sum, and Branch.

+

Reimplemented in Transformer, Bus, Line, Load, IOControl, TransferFunction, Capacitor, Inductor, Machines, Constant, Gain, Sum, Branch, ConnectionLine, Exponential, Limiter, Multiplier, and RateLimiter.

Definition at line 302 of file Element.h.

@@ -882,7 +886,7 @@ bool m_online = trueDraw line.

Parameters
- +
pointsLine vertices.
pointsLine vertices.
modeOpenGl primitive.
@@ -1323,7 +1327,7 @@ bool m_online = trueGet a the element copy.

Returns
Copy of the element.
-

Reimplemented in SyncGenerator, SyncMotor, Transformer, Text, Bus, RateLimiter, Line, IOControl, ConnectionLine, TransferFunction, Gain, Exponential, Constant, Limiter, Multiplier, Sum, Load, IndMotor, Capacitor, and Inductor.

+

Reimplemented in SyncGenerator, SyncMotor, Transformer, Text, TransferFunction, Bus, Line, RateLimiter, IOControl, Gain, ConnectionLine, Exponential, Sum, Constant, Limiter, Load, Multiplier, IndMotor, Capacitor, and Inductor.

Definition at line 262 of file Element.h.

@@ -1353,7 +1357,7 @@ bool m_online = true

Get the element height.

-
Returns
Element height.
+
Returns
Element height.

Definition at line 197 of file Element.h.

@@ -1383,7 +1387,7 @@ bool m_online = true

Get the element ID.

-
Returns
Element ID.
+
Returns
Element ID.

Definition at line 272 of file Element.h.

@@ -1473,7 +1477,7 @@ bool m_online = true

Get the element position.

-
Returns
Element position.
+
Returns
Element position.

Definition at line 187 of file Element.h.

@@ -1503,7 +1507,7 @@ bool m_online = true

Get the element rectangle.

-
Returns
Element rectangle.
+
Returns
Element rectangle.

Definition at line 182 of file Element.h.

@@ -1595,7 +1599,7 @@ bool m_online = true

Get the element width.

-
Returns
Element width.
+
Returns
Element width.

Definition at line 207 of file Element.h.

@@ -1633,7 +1637,7 @@ bool m_online = true
-

Implemented in Transformer, Text, Bus, Line, IOControl, Gain, Constant, TransferFunction, Capacitor, Inductor, Exponential, Branch, ConnectionLine, Limiter, Multiplier, RateLimiter, Machines, Sum, and Shunt.

+

Implemented in Transformer, Text, Bus, Line, IOControl, TransferFunction, Capacitor, Inductor, Branch, Machines, Constant, Gain, Sum, ConnectionLine, Exponential, Limiter, Multiplier, RateLimiter, and Shunt.

@@ -1850,7 +1854,7 @@ bool m_online = true -

Reimplemented in ControlElement, Transformer, Line, Gain, ConnectionLine, Machines, Branch, and Shunt.

+

Reimplemented in ControlElement, Transformer, Line, Gain, Machines, ConnectionLine, Branch, and Shunt.

Definition at line 123 of file Element.cpp.

@@ -2137,7 +2141,7 @@ bool m_online = true -

Reimplemented in Machines, ConnectionLine, Branch, and Shunt.

+

Reimplemented in Machines, Branch, Shunt, and ConnectionLine.

Definition at line 359 of file Element.h.

@@ -2269,7 +2273,7 @@ bool m_online = true -

Reimplemented in Transformer, Text, Bus, IOControl, Gain, Machines, Constant, Load, TransferFunction, Capacitor, Exponential, Inductor, Limiter, Multiplier, RateLimiter, and Sum.

+

Reimplemented in Transformer, Text, Bus, IOControl, Machines, Load, TransferFunction, Capacitor, Inductor, Constant, Gain, Sum, Exponential, Limiter, Multiplier, and RateLimiter.

Definition at line 307 of file Element.h.

@@ -2610,7 +2614,7 @@ bool m_online = trueSet the element ID.

Parameters
- +
idElement ID.
idElement ID.
@@ -2862,13 +2866,13 @@ bool m_online = true
Parameters
- +
parentForm parent
elementElement that will be edited.
elementElement that will be edited.
Returns
True if the form is shown, false otherwise.
-

Reimplemented in SyncGenerator, SyncMotor, Transformer, Bus, Line, IOControl, Load, Capacitor, Inductor, Gain, Constant, IndMotor, TransferFunction, Exponential, Limiter, Multiplier, RateLimiter, and Sum.

+

Reimplemented in SyncGenerator, SyncMotor, Transformer, Bus, Line, Load, Capacitor, Inductor, IOControl, IndMotor, TransferFunction, Constant, Gain, Sum, Exponential, Limiter, Multiplier, and RateLimiter.

Definition at line 534 of file Element.h.

@@ -2942,7 +2946,7 @@ bool m_online = true -

Reimplemented in ControlElement, Transformer, Line, ConnectionLine, Machines, Shunt, and Branch.

+

Reimplemented in Transformer, ControlElement, Line, Machines, ConnectionLine, Shunt, and Branch.

Definition at line 117 of file Element.cpp.

-- cgit