summaryrefslogtreecommitdiffstats
path: root/docs/doxygen/html/class_control_element_container.html
blob: 54ab3bc5e33f685be3eeb4ffa5ea56f03a3c427a (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
<!-- HTML header for doxygen 1.8.13-->
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<link rel="shortcut icon" href="favicon.ico" type="image/x-icon" />
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.13"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Power System Platform: ControlElementContainer Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<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>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectlogo"><img alt="Logo" src="logoHeader.png"/></td>
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">Power System Platform
   &#160;<span id="projectnumber">2018w15a</span>
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.13 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pro-attribs">Protected Attributes</a> &#124;
<a href="class_control_element_container-members.html">List of all members</a>  </div>
  <div class="headertitle">
<div class="title">ControlElementContainer Class Reference</div>  </div>
</div><!--header-->
<div class="contents">

<p>Class that can contain all control elements. Can identify (using RTTI) the elements from a generic list and store them separately.  
 <a href="class_control_element_container.html#details">More...</a></p>

<p><code>#include &lt;ControlElementContainer.h&gt;</code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:ac8db67b03eeb7de00e243849b02a4415"><td class="memItemLeft" align="right" valign="top"><a id="ac8db67b03eeb7de00e243849b02a4415"></a>
virtual void&#160;</td><td class="memItemRight" valign="bottom"><b>FillContainer</b> (<a class="el" href="class_control_editor.html">ControlEditor</a> *editor)</td></tr>
<tr class="separator:ac8db67b03eeb7de00e243849b02a4415"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0471ac31855189485313268d0b3a53db"><td class="memItemLeft" align="right" valign="top"><a id="a0471ac31855189485313268d0b3a53db"></a>
virtual void&#160;</td><td class="memItemRight" valign="bottom"><b>FillContainer</b> (std::vector&lt; <a class="el" href="class_control_element.html">ControlElement</a> *&gt; controlElementList, std::vector&lt; <a class="el" href="class_connection_line.html">ConnectionLine</a> *&gt; connectionLineList)</td></tr>
<tr class="separator:a0471ac31855189485313268d0b3a53db"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad1aaaff7d6dbc66698a6bffa37bb8485"><td class="memItemLeft" align="right" valign="top"><a id="ad1aaaff7d6dbc66698a6bffa37bb8485"></a>
virtual void&#160;</td><td class="memItemRight" valign="bottom"><b>GetContainerCopy</b> (std::vector&lt; <a class="el" href="class_control_element.html">ControlElement</a> *&gt; &amp;controlElementList, std::vector&lt; <a class="el" href="class_connection_line.html">ConnectionLine</a> *&gt; &amp;connectionLineList)</td></tr>
<tr class="separator:ad1aaaff7d6dbc66698a6bffa37bb8485"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a98d4686a08e9bb5e39c691f975c032b5"><td class="memItemLeft" align="right" valign="top"><a id="a98d4686a08e9bb5e39c691f975c032b5"></a>
virtual void&#160;</td><td class="memItemRight" valign="bottom"><b>ClearContainer</b> ()</td></tr>
<tr class="separator:a98d4686a08e9bb5e39c691f975c032b5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a57e2ab883b9b2c8d78109230617e6641"><td class="memItemLeft" align="right" valign="top"><a id="a57e2ab883b9b2c8d78109230617e6641"></a>
std::vector&lt; <a class="el" href="class_control_element.html">ControlElement</a> * &gt;&#160;</td><td class="memItemRight" valign="bottom"><b>GetControlElementsList</b> () const</td></tr>
<tr class="separator:a57e2ab883b9b2c8d78109230617e6641"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8bab1b359cd97adf9891a5f3356135a4"><td class="memItemLeft" align="right" valign="top"><a id="a8bab1b359cd97adf9891a5f3356135a4"></a>
std::vector&lt; <a class="el" href="class_connection_line.html">ConnectionLine</a> * &gt;&#160;</td><td class="memItemRight" valign="bottom"><b>GetConnectionLineList</b> () const</td></tr>
<tr class="separator:a8bab1b359cd97adf9891a5f3356135a4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8f049a372e032db4d8d8d2196234c8c5"><td class="memItemLeft" align="right" valign="top"><a id="a8f049a372e032db4d8d8d2196234c8c5"></a>
std::vector&lt; <a class="el" href="class_constant.html">Constant</a> * &gt;&#160;</td><td class="memItemRight" valign="bottom"><b>GetConstantList</b> () const</td></tr>
<tr class="separator:a8f049a372e032db4d8d8d2196234c8c5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9aaa1853009127385f2f37595a7901d8"><td class="memItemLeft" align="right" valign="top"><a id="a9aaa1853009127385f2f37595a7901d8"></a>
std::vector&lt; <a class="el" href="class_exponential.html">Exponential</a> * &gt;&#160;</td><td class="memItemRight" valign="bottom"><b>GetExponentialList</b> () const</td></tr>
<tr class="separator:a9aaa1853009127385f2f37595a7901d8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6a8d5ba14765607edca3f31d8f39308e"><td class="memItemLeft" align="right" valign="top"><a id="a6a8d5ba14765607edca3f31d8f39308e"></a>
std::vector&lt; <a class="el" href="class_gain.html">Gain</a> * &gt;&#160;</td><td class="memItemRight" valign="bottom"><b>GetGainList</b> () const</td></tr>
<tr class="separator:a6a8d5ba14765607edca3f31d8f39308e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3e5cb4d983fe93c3179e995172dac531"><td class="memItemLeft" align="right" valign="top"><a id="a3e5cb4d983fe93c3179e995172dac531"></a>
std::vector&lt; <a class="el" href="class_i_o_control.html">IOControl</a> * &gt;&#160;</td><td class="memItemRight" valign="bottom"><b>GetIOControlList</b> () const</td></tr>
<tr class="separator:a3e5cb4d983fe93c3179e995172dac531"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:abc2b559a174da81354c45c9b7fbafb30"><td class="memItemLeft" align="right" valign="top"><a id="abc2b559a174da81354c45c9b7fbafb30"></a>
std::vector&lt; <a class="el" href="class_limiter.html">Limiter</a> * &gt;&#160;</td><td class="memItemRight" valign="bottom"><b>GetLimiterList</b> () const</td></tr>
<tr class="separator:abc2b559a174da81354c45c9b7fbafb30"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0bb9367530c05a868d51ca8ad73ad023"><td class="memItemLeft" align="right" valign="top"><a id="a0bb9367530c05a868d51ca8ad73ad023"></a>
std::vector&lt; <a class="el" href="class_multiplier.html">Multiplier</a> * &gt;&#160;</td><td class="memItemRight" valign="bottom"><b>GetMultiplierList</b> () const</td></tr>
<tr class="separator:a0bb9367530c05a868d51ca8ad73ad023"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad6675aa9a0a0b78365d4726342e1d629"><td class="memItemLeft" align="right" valign="top"><a id="ad6675aa9a0a0b78365d4726342e1d629"></a>
std::vector&lt; <a class="el" href="class_rate_limiter.html">RateLimiter</a> * &gt;&#160;</td><td class="memItemRight" valign="bottom"><b>GetRateLimiterList</b> () const</td></tr>
<tr class="separator:ad6675aa9a0a0b78365d4726342e1d629"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:acbcca330e6f6b92d29273c5af95faefa"><td class="memItemLeft" align="right" valign="top"><a id="acbcca330e6f6b92d29273c5af95faefa"></a>
std::vector&lt; <a class="el" href="class_sum.html">Sum</a> * &gt;&#160;</td><td class="memItemRight" valign="bottom"><b>GetSumList</b> () const</td></tr>
<tr class="separator:acbcca330e6f6b92d29273c5af95faefa"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:acff46c06fa264fe0fe8b2408c490ff21"><td class="memItemLeft" align="right" valign="top"><a id="acff46c06fa264fe0fe8b2408c490ff21"></a>
std::vector&lt; <a class="el" href="class_transfer_function.html">TransferFunction</a> * &gt;&#160;</td><td class="memItemRight" valign="bottom"><b>GetTFList</b> () const</td></tr>
<tr class="separator:acff46c06fa264fe0fe8b2408c490ff21"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a66d057ef8272ed148d1eb102fee312ec"><td class="memItemLeft" align="right" valign="top"><a id="a66d057ef8272ed148d1eb102fee312ec"></a>
std::vector&lt; <a class="el" href="class_divider.html">Divider</a> * &gt;&#160;</td><td class="memItemRight" valign="bottom"><b>GetDividerList</b> () const</td></tr>
<tr class="separator:a66d057ef8272ed148d1eb102fee312ec"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a185b5dede0bf0613d3327dccb49cb925"><td class="memItemLeft" align="right" valign="top"><a id="a185b5dede0bf0613d3327dccb49cb925"></a>
std::vector&lt; <a class="el" href="class_math_expression.html">MathExpression</a> * &gt;&#160;</td><td class="memItemRight" valign="bottom"><b>GetMathExprList</b> () const</td></tr>
<tr class="separator:a185b5dede0bf0613d3327dccb49cb925"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-attribs"></a>
Protected Attributes</h2></td></tr>
<tr class="memitem:acd90e78160f526f5da29525af2bcbfab"><td class="memItemLeft" align="right" valign="top"><a id="acd90e78160f526f5da29525af2bcbfab"></a>
std::vector&lt; <a class="el" href="class_control_element.html">ControlElement</a> * &gt;&#160;</td><td class="memItemRight" valign="bottom"><b>m_ctrlElementsList</b></td></tr>
<tr class="separator:acd90e78160f526f5da29525af2bcbfab"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a94328dc8d8202522d3adf22ac53a2d19"><td class="memItemLeft" align="right" valign="top"><a id="a94328dc8d8202522d3adf22ac53a2d19"></a>
std::vector&lt; <a class="el" href="class_constant.html">Constant</a> * &gt;&#160;</td><td class="memItemRight" valign="bottom"><b>m_constantList</b></td></tr>
<tr class="separator:a94328dc8d8202522d3adf22ac53a2d19"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab09ab89629f66856cae22bc2fd9bb466"><td class="memItemLeft" align="right" valign="top"><a id="ab09ab89629f66856cae22bc2fd9bb466"></a>
std::vector&lt; <a class="el" href="class_connection_line.html">ConnectionLine</a> * &gt;&#160;</td><td class="memItemRight" valign="bottom"><b>m_cLineList</b></td></tr>
<tr class="separator:ab09ab89629f66856cae22bc2fd9bb466"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2d3264387b52901bcf79cbd502341787"><td class="memItemLeft" align="right" valign="top"><a id="a2d3264387b52901bcf79cbd502341787"></a>
std::vector&lt; <a class="el" href="class_exponential.html">Exponential</a> * &gt;&#160;</td><td class="memItemRight" valign="bottom"><b>m_exponentialList</b></td></tr>
<tr class="separator:a2d3264387b52901bcf79cbd502341787"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7e81693cb14f8531493b52067c14b5c2"><td class="memItemLeft" align="right" valign="top"><a id="a7e81693cb14f8531493b52067c14b5c2"></a>
std::vector&lt; <a class="el" href="class_gain.html">Gain</a> * &gt;&#160;</td><td class="memItemRight" valign="bottom"><b>m_gainList</b></td></tr>
<tr class="separator:a7e81693cb14f8531493b52067c14b5c2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a609362c029306d69a6a696ae0ef96d05"><td class="memItemLeft" align="right" valign="top"><a id="a609362c029306d69a6a696ae0ef96d05"></a>
std::vector&lt; <a class="el" href="class_i_o_control.html">IOControl</a> * &gt;&#160;</td><td class="memItemRight" valign="bottom"><b>m_ioControlList</b></td></tr>
<tr class="separator:a609362c029306d69a6a696ae0ef96d05"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9b7c030f3701fdd3818017671d8ee3c8"><td class="memItemLeft" align="right" valign="top"><a id="a9b7c030f3701fdd3818017671d8ee3c8"></a>
std::vector&lt; <a class="el" href="class_limiter.html">Limiter</a> * &gt;&#160;</td><td class="memItemRight" valign="bottom"><b>m_limiterList</b></td></tr>
<tr class="separator:a9b7c030f3701fdd3818017671d8ee3c8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7fb7feffe045fa9b7f03b403a3006698"><td class="memItemLeft" align="right" valign="top"><a id="a7fb7feffe045fa9b7f03b403a3006698"></a>
std::vector&lt; <a class="el" href="class_multiplier.html">Multiplier</a> * &gt;&#160;</td><td class="memItemRight" valign="bottom"><b>m_multiplierList</b></td></tr>
<tr class="separator:a7fb7feffe045fa9b7f03b403a3006698"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a826654db7241433454e6b05671cff795"><td class="memItemLeft" align="right" valign="top"><a id="a826654db7241433454e6b05671cff795"></a>
std::vector&lt; <a class="el" href="class_rate_limiter.html">RateLimiter</a> * &gt;&#160;</td><td class="memItemRight" valign="bottom"><b>m_rateLimiterList</b></td></tr>
<tr class="separator:a826654db7241433454e6b05671cff795"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a208a79da23c8349ea7460d1a38c8e458"><td class="memItemLeft" align="right" valign="top"><a id="a208a79da23c8349ea7460d1a38c8e458"></a>
std::vector&lt; <a class="el" href="class_sum.html">Sum</a> * &gt;&#160;</td><td class="memItemRight" valign="bottom"><b>m_sumList</b></td></tr>
<tr class="separator:a208a79da23c8349ea7460d1a38c8e458"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a32afcd17e0f337c5ef4a6af55b5de358"><td class="memItemLeft" align="right" valign="top"><a id="a32afcd17e0f337c5ef4a6af55b5de358"></a>
std::vector&lt; <a class="el" href="class_transfer_function.html">TransferFunction</a> * &gt;&#160;</td><td class="memItemRight" valign="bottom"><b>m_tfList</b></td></tr>
<tr class="separator:a32afcd17e0f337c5ef4a6af55b5de358"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0cd7b602e74491d950e7483b2979f5ad"><td class="memItemLeft" align="right" valign="top"><a id="a0cd7b602e74491d950e7483b2979f5ad"></a>
std::vector&lt; <a class="el" href="class_divider.html">Divider</a> * &gt;&#160;</td><td class="memItemRight" valign="bottom"><b>m_dividerList</b></td></tr>
<tr class="separator:a0cd7b602e74491d950e7483b2979f5ad"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3babc0a519bdb6269bbf7b180a8c53c4"><td class="memItemLeft" align="right" valign="top"><a id="a3babc0a519bdb6269bbf7b180a8c53c4"></a>
std::vector&lt; <a class="el" href="class_math_expression.html">MathExpression</a> * &gt;&#160;</td><td class="memItemRight" valign="bottom"><b>m_mathExprList</b></td></tr>
<tr class="separator:a3babc0a519bdb6269bbf7b180a8c53c4"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Class that can contain all control elements. Can identify (using RTTI) the elements from a generic list and store them separately. </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>05/10/2017 </dd></dl>
</div><hr/>The documentation for this class was generated from the following files:<ul>
<li>Project/<a class="el" href="_control_element_container_8h.html">ControlElementContainer.h</a></li>
<li>Project/ControlElementContainer.cpp</li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.13
</small></address>
</body>
</html>