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_element.html | 184 ++++++++++++++++++----------------- 1 file changed, 97 insertions(+), 87 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 8f8a29a..e22ec4d 100644 --- a/docs/doxygen/html/class_element.html +++ b/docs/doxygen/html/class_element.html @@ -21,6 +21,12 @@ + @@ -87,6 +93,8 @@ $(document).ready(function(){initNavTree('class_element.html','');});
Element Class Referenceabstract
+ +

#include <Element.h>

Inheritance diagram for Element:
@@ -96,14 +104,14 @@ Inheritance diagram for Element:
ControlElement GraphicalElement PowerElement -ConnectionLine -Constant -Exponential -Gain -IOControl -Limiter -Multiplier -RateLimiter +ConnectionLine +Constant +Exponential +Gain +IOControl +Limiter +Multiplier +RateLimiter Sum TransferFunction Text @@ -417,8 +425,10 @@ bool m_online = true 

Detailed Description

-
-

Definition at line 88 of file Element.h.

+
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.

Member Function Documentation

◆ AddChild()

@@ -452,7 +462,7 @@ bool m_online = true -

Definition at line 333 of file Element.cpp.

+

Definition at line 353 of file Element.cpp.

@@ -494,14 +504,14 @@ bool m_online = true
Parameters
- +
parentElement parent.
positionNode position in the parent.
positionNode position in the parent.

Reimplemented in Transformer, Text, Bus, Line, Load, Capacitor, Inductor, and Machines.

-

Definition at line 234 of file Element.h.

+

Definition at line 240 of file Element.h.

@@ -537,7 +547,7 @@ bool m_online = true -

Definition at line 240 of file Element.h.

+

Definition at line 245 of file Element.h.

@@ -575,7 +585,7 @@ bool m_online = trueReimplemented in Line, and Branch.

-

Definition at line 321 of file Element.h.

+

Definition at line 318 of file Element.h.

@@ -624,7 +634,7 @@ bool m_online = trueReimplemented in Line.

-

Definition at line 243 of file Element.cpp.

+

Definition at line 263 of file Element.cpp.

@@ -660,7 +670,7 @@ bool m_online = true -

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

+

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

@@ -721,7 +731,7 @@ bool m_online = true -

Definition at line 272 of file Element.cpp.

+

Definition at line 292 of file Element.cpp.

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

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

+

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

Definition at line 302 of file Element.h.

@@ -831,7 +841,7 @@ bool m_online = true -

Definition at line 17 of file Element.cpp.

+

Definition at line 33 of file Element.cpp.

@@ -878,7 +888,7 @@ bool m_online = true -

Definition at line 73 of file Element.cpp.

+

Definition at line 89 of file Element.cpp.

@@ -914,7 +924,7 @@ bool m_online = true -

Definition at line 82 of file Element.cpp.

+

Definition at line 98 of file Element.cpp.

@@ -961,7 +971,7 @@ bool m_online = true -

Definition at line 124 of file Element.cpp.

+

Definition at line 139 of file Element.cpp.

@@ -1022,7 +1032,7 @@ bool m_online = true -

Definition at line 53 of file Element.cpp.

+

Definition at line 69 of file Element.cpp.

@@ -1069,7 +1079,7 @@ bool m_online = true -

Definition at line 63 of file Element.cpp.

+

Definition at line 79 of file Element.cpp.

@@ -1116,7 +1126,7 @@ bool m_online = true -

Definition at line 44 of file Element.cpp.

+

Definition at line 60 of file Element.cpp.

@@ -1152,7 +1162,7 @@ bool m_online = true -

Definition at line 228 of file Element.cpp.

+

Definition at line 245 of file Element.cpp.

@@ -1182,7 +1192,7 @@ bool m_online = trueGet the element angle.

Returns
Angle value.
-

Definition at line 201 of file Element.h.

+

Definition at line 212 of file Element.h.

@@ -1214,7 +1224,7 @@ bool m_online = trueReimplemented in Bus, Line, and Branch.

-

Definition at line 401 of file Element.h.

+

Definition at line 389 of file Element.h.

@@ -1244,7 +1254,7 @@ bool m_online = trueGet the Child list.

Returns
Child List.
-

Definition at line 523 of file Element.h.

+

Definition at line 511 of file Element.h.

@@ -1283,7 +1293,7 @@ bool m_online = trueReimplemented in SyncGenerator, SyncMotor, Transformer, Bus, Line, Load, Branch, Capacitor, Inductor, and IndMotor.

-

Definition at line 315 of file Element.h.

+

Definition at line 313 of file Element.h.

@@ -1313,9 +1323,9 @@ bool m_online = trueGet a the element copy.

Returns
Copy of the element.
-

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

+

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

-

Definition at line 258 of file Element.h.

+

Definition at line 262 of file Element.h.

@@ -1345,7 +1355,7 @@ bool m_online = trueGet the element height.

Returns
Element height.
-

Definition at line 183 of file Element.h.

+

Definition at line 197 of file Element.h.

@@ -1375,7 +1385,7 @@ bool m_online = trueGet the element ID.

Returns
Element ID.
-

Definition at line 270 of file Element.h.

+

Definition at line 272 of file Element.h.

@@ -1405,7 +1415,7 @@ bool m_online = trueGet the parent list.

Returns
Parent list.
-

Definition at line 517 of file Element.h.

+

Definition at line 506 of file Element.h.

@@ -1435,7 +1445,7 @@ bool m_online = trueGet the list of points that connect the element to bus.

Returns
List of points.
-

Definition at line 225 of file Element.h.

+

Definition at line 232 of file Element.h.

@@ -1465,7 +1475,7 @@ bool m_online = trueGet the element position.

Returns
Element position.
-

Definition at line 171 of file Element.h.

+

Definition at line 187 of file Element.h.

@@ -1495,7 +1505,7 @@ bool m_online = trueGet the element rectangle.

Returns
Element rectangle.
-

Definition at line 165 of file Element.h.

+

Definition at line 182 of file Element.h.

@@ -1525,7 +1535,7 @@ bool m_online = trueGet the angle of rotation.

Returns
Rotation angle.
-

Definition at line 207 of file Element.h.

+

Definition at line 217 of file Element.h.

@@ -1557,7 +1567,7 @@ bool m_online = trueReimplemented in SyncGenerator, SyncMotor, Transformer, Bus, Line, Load, Capacitor, Inductor, and IndMotor.

-

Definition at line 295 of file Element.h.

+

Definition at line 296 of file Element.h.

@@ -1587,7 +1597,7 @@ bool m_online = trueGet the element width.

Returns
Element width.
-

Definition at line 195 of file Element.h.

+

Definition at line 207 of file Element.h.

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

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

+

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

@@ -1684,7 +1694,7 @@ bool m_online = true -

Definition at line 286 of file Element.cpp.

+

Definition at line 306 of file Element.cpp.

@@ -1714,7 +1724,7 @@ bool m_online = trueChecks if the element is being dragged.

Returns
True if is being dragged, false otherwise.
-

Definition at line 177 of file Element.h.

+

Definition at line 192 of file Element.h.

@@ -1744,7 +1754,7 @@ bool m_online = trueChecks if the element is online or offline.

Returns
True if online, false if offline.
-

Definition at line 219 of file Element.h.

+

Definition at line 227 of file Element.h.

@@ -1774,7 +1784,7 @@ bool m_online = trueChecks if the pickbox is shown.

Returns
True if the pickbox is show, false otherwise.
-

Definition at line 213 of file Element.h.

+

Definition at line 222 of file Element.h.

@@ -1804,7 +1814,7 @@ bool m_online = trueChecks if the element is selected.

Returns
True if selected, false otherwise.
-

Definition at line 189 of file Element.h.

+

Definition at line 202 of file Element.h.

@@ -1840,9 +1850,9 @@ bool m_online = true -

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

+

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

-

Definition at line 107 of file Element.cpp.

+

Definition at line 123 of file Element.cpp.

@@ -1883,7 +1893,7 @@ bool m_online = trueMove a node. StartMove(wxPoint2DDouble position) before start moving.

Parameters
- +
parentNode's parent.
parentNode's parent.
positionNew node position.
@@ -1891,7 +1901,7 @@ bool m_online = trueReimplemented in Transformer, Line, Machines, Branch, and Shunt.

-

Definition at line 341 of file Element.h.

+

Definition at line 337 of file Element.h.

@@ -1929,7 +1939,7 @@ bool m_online = trueReimplemented in Bus, Line, and Branch.

-

Definition at line 395 of file Element.h.

+

Definition at line 384 of file Element.h.

@@ -1968,7 +1978,7 @@ bool m_online = trueReimplemented in Machines, Shunt, and Branch.

-

Definition at line 348 of file Element.h.

+

Definition at line 343 of file Element.h.

@@ -2007,7 +2017,7 @@ bool m_online = trueReimplemented in Bus, Line, and Branch.

-

Definition at line 389 of file Element.h.

+

Definition at line 379 of file Element.h.

@@ -2055,7 +2065,7 @@ bool m_online = true
Returns
The distance between the point and the line.
-

Definition at line 365 of file Element.cpp.

+

Definition at line 383 of file Element.cpp.

@@ -2091,7 +2101,7 @@ bool m_online = true
-

Definition at line 335 of file Element.cpp.

+

Definition at line 354 of file Element.cpp.

@@ -2127,9 +2137,9 @@ bool m_online = true -

Reimplemented in Machines, Branch, Shunt, and ConnectionLine.

+

Reimplemented in Machines, ConnectionLine, Branch, and Shunt.

-

Definition at line 367 of file Element.h.

+

Definition at line 359 of file Element.h.

@@ -2176,7 +2186,7 @@ bool m_online = true -

Definition at line 343 of file Element.cpp.

+

Definition at line 362 of file Element.cpp.

@@ -2223,7 +2233,7 @@ bool m_online = true -

Definition at line 326 of file Element.cpp.

+

Definition at line 346 of file Element.cpp.

@@ -2259,9 +2269,9 @@ bool m_online = true -

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

+

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

-

Definition at line 308 of file Element.h.

+

Definition at line 307 of file Element.h.

@@ -2315,7 +2325,7 @@ bool m_online = true -

Definition at line 91 of file Element.cpp.

+

Definition at line 107 of file Element.cpp.

@@ -2376,7 +2386,7 @@ bool m_online = true -

Definition at line 132 of file Element.cpp.

+

Definition at line 147 of file Element.cpp.

@@ -2417,7 +2427,7 @@ bool m_online = trueRotate a node.

Parameters
- +
parentNode's parent.
parentNode's parent.
clockwiseTrue to rotate clockwise, false to rotate counter-clockwise.
@@ -2425,7 +2435,7 @@ bool m_online = trueReimplemented in Transformer, Line, Branch, Machines, and Shunt.

-

Definition at line 381 of file Element.h.

+

Definition at line 372 of file Element.h.

@@ -2461,7 +2471,7 @@ bool m_online = true
-

Definition at line 135 of file Element.h.

+

Definition at line 156 of file Element.h.

@@ -2497,7 +2507,7 @@ bool m_online = true -

Definition at line 147 of file Element.h.

+

Definition at line 166 of file Element.h.

@@ -2533,7 +2543,7 @@ bool m_online = true -

Definition at line 105 of file Element.h.

+

Definition at line 130 of file Element.h.

@@ -2569,7 +2579,7 @@ bool m_online = true -

Definition at line 111 of file Element.h.

+

Definition at line 135 of file Element.h.

@@ -2605,7 +2615,7 @@ bool m_online = true -

Definition at line 264 of file Element.h.

+

Definition at line 267 of file Element.h.

@@ -2636,7 +2646,7 @@ bool m_online = trueSet a perent to the node. If all conditions are met, a new parent are added to the element and the points related to the nodes will be calculated.

Parameters
- +
parentNode parent.
parentNode parent.
@@ -2644,7 +2654,7 @@ bool m_online = trueReimplemented in Transformer, Line, Machines, Shunt, and Branch.

-

Definition at line 361 of file Element.h.

+

Definition at line 354 of file Element.h.

@@ -2672,7 +2682,7 @@ bool m_online = true -

Definition at line 218 of file Element.cpp.

+

Definition at line 235 of file Element.cpp.

@@ -2710,7 +2720,7 @@ bool m_online = trueReimplemented in Line.

-

Definition at line 159 of file Element.h.

+

Definition at line 177 of file Element.h.

@@ -2738,7 +2748,7 @@ bool m_online = true -

Definition at line 10 of file Element.cpp.

+

Definition at line 25 of file Element.cpp.

@@ -2774,7 +2784,7 @@ bool m_online = true -

Definition at line 123 of file Element.h.

+

Definition at line 146 of file Element.h.

@@ -2810,7 +2820,7 @@ bool m_online = true -

Definition at line 129 of file Element.h.

+

Definition at line 151 of file Element.h.

@@ -2858,9 +2868,9 @@ bool m_online = true
Returns
True if the form is shown, false otherwise.
-

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

+

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

-

Definition at line 547 of file Element.h.

+

Definition at line 534 of file Element.h.

@@ -2896,7 +2906,7 @@ bool m_online = true -

Definition at line 141 of file Element.h.

+

Definition at line 161 of file Element.h.

@@ -2932,9 +2942,9 @@ bool m_online = true -

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

+

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

-

Definition at line 101 of file Element.cpp.

+

Definition at line 117 of file Element.cpp.

@@ -2981,7 +2991,7 @@ bool m_online = true -

Definition at line 300 of file Element.cpp.

+

Definition at line 320 of file Element.cpp.

@@ -3042,7 +3052,7 @@ bool m_online = true -

Definition at line 109 of file Element.cpp.

+

Definition at line 124 of file Element.cpp.

@@ -3110,7 +3120,7 @@ bool m_online = true -

Definition at line 115 of file Element.cpp.

+

Definition at line 130 of file Element.cpp.

-- cgit