diff options
Diffstat (limited to 'docs/doxygen/html/class_machines.html')
| -rw-r--r-- | docs/doxygen/html/class_machines.html | 64 |
1 files changed, 39 insertions, 25 deletions
diff --git a/docs/doxygen/html/class_machines.html b/docs/doxygen/html/class_machines.html index 90e706a..0ca2bf4 100644 --- a/docs/doxygen/html/class_machines.html +++ b/docs/doxygen/html/class_machines.html @@ -21,6 +21,12 @@ <link href="search/search.css" rel="stylesheet" type="text/css"/> <script type="text/javascript" src="search/searchdata.js"></script> <script type="text/javascript" src="search/search.js"></script> +<script type="text/x-mathjax-config"> + MathJax.Hub.Config({ + extensions: ["tex2jax.js"], + jax: ["input/TeX","output/HTML-CSS"], +}); +</script><script type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.2/MathJax.js"></script> <link href="doxygen.css" rel="stylesheet" type="text/css" /> </head> <body> @@ -88,17 +94,22 @@ $(document).ready(function(){initNavTree('class_machines.html','');}); <div class="title">Machines Class Reference</div> </div> </div><!--header--> <div class="contents"> + +<p>Abstract class for rotary machines power elements. + <a href="class_machines.html#details">More...</a></p> + +<p><code>#include <<a class="el" href="_machines_8h_source.html">Machines.h</a>></code></p> <div class="dynheader"> Inheritance diagram for Machines:</div> <div class="dyncontent"> <div class="center"> <img src="class_machines.png" usemap="#Machines_map" alt=""/> <map id="Machines_map" name="Machines_map"> -<area href="class_power_element.html" alt="PowerElement" shape="rect" coords="108,56,206,80"/> -<area href="class_element.html" alt="Element" shape="rect" coords="108,0,206,24"/> -<area href="class_ind_motor.html" alt="IndMotor" shape="rect" coords="0,168,98,192"/> -<area href="class_sync_generator.html" alt="SyncGenerator" shape="rect" coords="108,168,206,192"/> -<area href="class_sync_motor.html" alt="SyncMotor" shape="rect" coords="216,168,314,192"/> +<area href="class_power_element.html" title="Abstract class of power elements. " alt="PowerElement" shape="rect" coords="108,56,206,80"/> +<area href="class_element.html" title="Base class of all elements of the program. This class is responsible for manage graphical and his dat..." alt="Element" shape="rect" coords="108,0,206,24"/> +<area href="class_ind_motor.html" title="Induction motor power element. " alt="IndMotor" shape="rect" coords="0,168,98,192"/> +<area href="class_sync_generator.html" title="Synchronous generator power element. " alt="SyncGenerator" shape="rect" coords="108,168,206,192"/> +<area href="class_sync_motor.html" title="Synchronous motor (synchronous compensator) power element. " alt="SyncMotor" shape="rect" coords="216,168,314,192"/> </map> </div></div> <table class="memberdecls"> @@ -527,8 +538,11 @@ Additional Inherited Members</h2></td></tr> <tr class="separator:abb2e253ec1e86353cd7160209c96553c inherit pub_static_methods_class_element"><td class="memSeparator" colspan="2"> </td></tr> </table> <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> -<div class="textblock"> -<p class="definition">Definition at line <a class="el" href="_machines_8h_source.html#l00009">9</a> of file <a class="el" href="_machines_8h_source.html">Machines.h</a>.</p> +<div class="textblock"><p>Abstract class for rotary machines power elements. </p> +<dl class="section author"><dt>Author</dt><dd>Thales Lima Oliveira <a href="#" onclick="location.href='mai'+'lto:'+'tha'+'le'+'s@u'+'fu'+'.br'; return false;">thale<span style="display: none;">.nosp@m.</span>s@uf<span style="display: none;">.nosp@m.</span>u.br</a> </dd></dl> +<dl class="section date"><dt>Date</dt><dd>06/10/2017 </dd></dl> + +<p class="definition">Definition at line <a class="el" href="_machines_8h_source.html#l00033">33</a> of file <a class="el" href="_machines_8h_source.html">Machines.h</a>.</p> </div><h2 class="groupheader">Member Function Documentation</h2> <a id="aaaf1b86dcbfd8f4a4c082a77d72b1fe3"></a> <h2 class="memtitle"><span class="permalink"><a href="#aaaf1b86dcbfd8f4a4c082a77d72b1fe3">◆ </a></span>AddParent()</h2> @@ -567,15 +581,15 @@ Additional Inherited Members</h2></td></tr> <p>Add 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. </p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> - <tr><td class="paramname">parent</td><td><a class="el" href="class_element.html">Element</a> parent. </td></tr> - <tr><td class="paramname">position</td><td><a class="el" href="class_node.html">Node</a> position in the parent. </td></tr> + <tr><td class="paramname">parent</td><td><a class="el" href="class_element.html" title="Base class of all elements of the program. This class is responsible for manage graphical and his dat...">Element</a> parent. </td></tr> + <tr><td class="paramname">position</td><td><a class="el" href="class_node.html" title="Node of a control element. This class manages the user interaction with the connection and control el...">Node</a> position in the parent. </td></tr> </table> </dd> </dl> <p>Reimplemented from <a class="el" href="class_element.html#a569178e9138490a981511a644536c0f9">Element</a>.</p> -<p class="definition">Definition at line <a class="el" href="_machines_8cpp_source.html#l00008">8</a> of file <a class="el" href="_machines_8cpp_source.html">Machines.cpp</a>.</p> +<p class="definition">Definition at line <a class="el" href="_machines_8cpp_source.html#l00025">25</a> of file <a class="el" href="_machines_8cpp_source.html">Machines.cpp</a>.</p> </div> </div> @@ -613,7 +627,7 @@ Additional Inherited Members</h2></td></tr> <p>Implements <a class="el" href="class_element.html#abf6c4949733debca55b2f56d8e9b7372">Element</a>.</p> -<p class="definition">Definition at line <a class="el" href="_machines_8h_source.html#l00018">18</a> of file <a class="el" href="_machines_8h_source.html">Machines.h</a>.</p> +<p class="definition">Definition at line <a class="el" href="_machines_8h_source.html#l00042">42</a> of file <a class="el" href="_machines_8h_source.html">Machines.h</a>.</p> </div> </div> @@ -662,7 +676,7 @@ Additional Inherited Members</h2></td></tr> <p>Reimplemented from <a class="el" href="class_element.html#a551ed1eeab446b5366d56c2ee9dec187">Element</a>.</p> -<p class="definition">Definition at line <a class="el" href="_machines_8cpp_source.html#l00037">37</a> of file <a class="el" href="_machines_8cpp_source.html">Machines.cpp</a>.</p> +<p class="definition">Definition at line <a class="el" href="_machines_8cpp_source.html#l00054">54</a> of file <a class="el" href="_machines_8cpp_source.html">Machines.cpp</a>.</p> </div> </div> @@ -700,7 +714,7 @@ Additional Inherited Members</h2></td></tr> <p>Implements <a class="el" href="class_element.html#a038dfd8452fe48ab04bc4e47820c148e">Element</a>.</p> -<p class="definition">Definition at line <a class="el" href="_machines_8h_source.html#l00020">20</a> of file <a class="el" href="_machines_8h_source.html">Machines.h</a>.</p> +<p class="definition">Definition at line <a class="el" href="_machines_8h_source.html#l00044">44</a> of file <a class="el" href="_machines_8h_source.html">Machines.h</a>.</p> </div> </div> @@ -738,7 +752,7 @@ Additional Inherited Members</h2></td></tr> <p>Reimplemented from <a class="el" href="class_element.html#abe884d99d12d5252e18956162115b025">Element</a>.</p> -<p class="definition">Definition at line <a class="el" href="_machines_8cpp_source.html#l00094">94</a> of file <a class="el" href="_machines_8cpp_source.html">Machines.cpp</a>.</p> +<p class="definition">Definition at line <a class="el" href="_machines_8cpp_source.html#l00111">111</a> of file <a class="el" href="_machines_8cpp_source.html">Machines.cpp</a>.</p> </div> </div> @@ -779,7 +793,7 @@ Additional Inherited Members</h2></td></tr> <p>Move a node. <a class="el" href="class_machines.html#acbefe76cd5161b5684a27205b155e797" title="Update the element attributes related to the movement. ">StartMove(wxPoint2DDouble position)</a> before start moving. </p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> - <tr><td class="paramname">parent</td><td><a class="el" href="class_node.html">Node</a>'s parent. </td></tr> + <tr><td class="paramname">parent</td><td><a class="el" href="class_node.html" title="Node of a control element. This class manages the user interaction with the connection and control el...">Node</a>'s parent. </td></tr> <tr><td class="paramname">position</td><td>New node position. </td></tr> </table> </dd> @@ -787,7 +801,7 @@ Additional Inherited Members</h2></td></tr> <p>Reimplemented from <a class="el" href="class_element.html#a870e266e0457bacbc3f7ef1fb70c6fdd">Element</a>.</p> -<p class="definition">Definition at line <a class="el" href="_machines_8cpp_source.html#l00107">107</a> of file <a class="el" href="_machines_8cpp_source.html">Machines.cpp</a>.</p> +<p class="definition">Definition at line <a class="el" href="_machines_8cpp_source.html#l00124">124</a> of file <a class="el" href="_machines_8cpp_source.html">Machines.cpp</a>.</p> </div> </div> @@ -826,7 +840,7 @@ Additional Inherited Members</h2></td></tr> <p>Reimplemented from <a class="el" href="class_element.html#a95b4f7e9341883ec39d0201148afffb4">Element</a>.</p> -<p class="definition">Definition at line <a class="el" href="_machines_8cpp_source.html#l00158">158</a> of file <a class="el" href="_machines_8cpp_source.html">Machines.cpp</a>.</p> +<p class="definition">Definition at line <a class="el" href="_machines_8cpp_source.html#l00175">175</a> of file <a class="el" href="_machines_8cpp_source.html">Machines.cpp</a>.</p> </div> </div> @@ -864,7 +878,7 @@ Additional Inherited Members</h2></td></tr> <p>Reimplemented from <a class="el" href="class_element.html#a9504437b60faf2c5a27584de8a24810c">Element</a>.</p> -<p class="definition">Definition at line <a class="el" href="_machines_8cpp_source.html#l00148">148</a> of file <a class="el" href="_machines_8cpp_source.html">Machines.cpp</a>.</p> +<p class="definition">Definition at line <a class="el" href="_machines_8cpp_source.html#l00165">165</a> of file <a class="el" href="_machines_8cpp_source.html">Machines.cpp</a>.</p> </div> </div> @@ -902,7 +916,7 @@ Additional Inherited Members</h2></td></tr> <p>Reimplemented from <a class="el" href="class_element.html#afab568cea0a7074bb9984e94bd2ba52e">Element</a>.</p> -<p class="definition">Definition at line <a class="el" href="_machines_8cpp_source.html#l00215">215</a> of file <a class="el" href="_machines_8cpp_source.html">Machines.cpp</a>.</p> +<p class="definition">Definition at line <a class="el" href="_machines_8cpp_source.html#l00232">232</a> of file <a class="el" href="_machines_8cpp_source.html">Machines.cpp</a>.</p> </div> </div> @@ -943,7 +957,7 @@ Additional Inherited Members</h2></td></tr> <p>Rotate a node. </p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> - <tr><td class="paramname">parent</td><td><a class="el" href="class_node.html">Node</a>'s parent. </td></tr> + <tr><td class="paramname">parent</td><td><a class="el" href="class_node.html" title="Node of a control element. This class manages the user interaction with the connection and control el...">Node</a>'s parent. </td></tr> <tr><td class="paramname">clockwise</td><td>True to rotate clockwise, false to rotate counter-clockwise. </td></tr> </table> </dd> @@ -951,7 +965,7 @@ Additional Inherited Members</h2></td></tr> <p>Reimplemented from <a class="el" href="class_element.html#af26c67b6dd32eb1b3e417fddf54818c3">Element</a>.</p> -<p class="definition">Definition at line <a class="el" href="_machines_8cpp_source.html#l00136">136</a> of file <a class="el" href="_machines_8cpp_source.html">Machines.cpp</a>.</p> +<p class="definition">Definition at line <a class="el" href="_machines_8cpp_source.html#l00153">153</a> of file <a class="el" href="_machines_8cpp_source.html">Machines.cpp</a>.</p> </div> </div> @@ -982,7 +996,7 @@ Additional Inherited Members</h2></td></tr> <p>Set 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. </p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> - <tr><td class="paramname">parent</td><td><a class="el" href="class_node.html">Node</a> parent. </td></tr> + <tr><td class="paramname">parent</td><td><a class="el" href="class_node.html" title="Node of a control element. This class manages the user interaction with the connection and control el...">Node</a> parent. </td></tr> </table> </dd> </dl> @@ -990,7 +1004,7 @@ Additional Inherited Members</h2></td></tr> <p>Reimplemented from <a class="el" href="class_element.html#ac7490a91f3edfff08584567cc84d86b5">Element</a>.</p> -<p class="definition">Definition at line <a class="el" href="_machines_8cpp_source.html#l00172">172</a> of file <a class="el" href="_machines_8cpp_source.html">Machines.cpp</a>.</p> +<p class="definition">Definition at line <a class="el" href="_machines_8cpp_source.html#l00189">189</a> of file <a class="el" href="_machines_8cpp_source.html">Machines.cpp</a>.</p> </div> </div> @@ -1028,7 +1042,7 @@ Additional Inherited Members</h2></td></tr> <p>Reimplemented from <a class="el" href="class_power_element.html#a2ee71f9eb90beadf5439ce9f70469b49">PowerElement</a>.</p> -<p class="definition">Definition at line <a class="el" href="_machines_8cpp_source.html#l00250">250</a> of file <a class="el" href="_machines_8cpp_source.html">Machines.cpp</a>.</p> +<p class="definition">Definition at line <a class="el" href="_machines_8cpp_source.html#l00267">267</a> of file <a class="el" href="_machines_8cpp_source.html">Machines.cpp</a>.</p> </div> </div> @@ -1066,7 +1080,7 @@ Additional Inherited Members</h2></td></tr> <p>Reimplemented from <a class="el" href="class_element.html#a846a2a51780a99363b4d4b1812ca16b4">Element</a>.</p> -<p class="definition">Definition at line <a class="el" href="_machines_8cpp_source.html#l00129">129</a> of file <a class="el" href="_machines_8cpp_source.html">Machines.cpp</a>.</p> +<p class="definition">Definition at line <a class="el" href="_machines_8cpp_source.html#l00146">146</a> of file <a class="el" href="_machines_8cpp_source.html">Machines.cpp</a>.</p> </div> </div> |