-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathclasshopsan_1_1ConnectionAssistant.html
More file actions
286 lines (270 loc) · 18.3 KB
/
classhopsan_1_1ConnectionAssistant.html
File metadata and controls
286 lines (270 loc) · 18.3 KB
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
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.12.0"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Hopsan: ConnectionAssistant 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>
<script type="text/javascript" src="clipboard.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="cookie.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="hopsan.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 id="projectrow">
<td id="projectalign">
<div id="projectname">Hopsan
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.12.0 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
$(function() { codefold.init(0); });
/* @license-end */
</script>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
$(function(){initNavTree('classhopsan_1_1ConnectionAssistant.html',''); initResizable(true); });
/* @license-end */
</script>
<div id="doc-content">
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="classhopsan_1_1ConnectionAssistant-members.html">List of all members</a> </div>
<div class="headertitle"><div class="title">ConnectionAssistant Class Reference</div></div>
</div><!--header-->
<div class="contents">
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-methods" name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a3c9fe3f128c85c9c003e2d947c2e8c75" id="r_a3c9fe3f128c85c9c003e2d947c2e8c75"><td class="memItemLeft" align="right" valign="top"><a id="a3c9fe3f128c85c9c003e2d947c2e8c75" name="a3c9fe3f128c85c9c003e2d947c2e8c75"></a>
 </td><td class="memItemRight" valign="bottom"><b>ConnectionAssistant</b> (<a class="el" href="classhopsan_1_1ComponentSystem.html">ComponentSystem</a> *pComponentSystem)</td></tr>
<tr class="separator:a3c9fe3f128c85c9c003e2d947c2e8c75"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a7b46d89e2c1fbba746eebd3b7c29f513" id="r_a7b46d89e2c1fbba746eebd3b7c29f513"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="#a7b46d89e2c1fbba746eebd3b7c29f513">mergeNodeConnection</a> (<a class="el" href="classhopsan_1_1Port.html">Port</a> *pPort1, <a class="el" href="classhopsan_1_1Port.html">Port</a> *pPort2)</td></tr>
<tr class="separator:a7b46d89e2c1fbba746eebd3b7c29f513"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:af51ceb8ea704aa89a064d2249dc137ae" id="r_af51ceb8ea704aa89a064d2249dc137ae"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="#af51ceb8ea704aa89a064d2249dc137ae">splitNodeConnection</a> (<a class="el" href="classhopsan_1_1Port.html">Port</a> *pPort1, <a class="el" href="classhopsan_1_1Port.html">Port</a> *pPort2)</td></tr>
<tr class="separator:af51ceb8ea704aa89a064d2249dc137ae"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a3616047c819e8c76a37d0a75ee99824d" id="r_a3616047c819e8c76a37d0a75ee99824d"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="#a3616047c819e8c76a37d0a75ee99824d">determineWhereToStoreNodeAndStoreIt</a> (<a class="el" href="classhopsan_1_1Node.html">Node</a> *pNode)</td></tr>
<tr class="memdesc:a3616047c819e8c76a37d0a75ee99824d"><td class="mdescLeft"> </td><td class="mdescRight">Find the system highest up in the model hierarchy for the ports connected to this node and store the node there. <br /></td></tr>
<tr class="separator:a3616047c819e8c76a37d0a75ee99824d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a06714e46aafbbf51c83c7cdae1498573" id="r_a06714e46aafbbf51c83c7cdae1498573"><td class="memItemLeft" align="right" valign="top"><a id="a06714e46aafbbf51c83c7cdae1498573" name="a06714e46aafbbf51c83c7cdae1498573"></a>
void </td><td class="memItemRight" valign="bottom"><b>clearSysPortNodeTypeIfEmpty</b> (<a class="el" href="classhopsan_1_1Port.html">Port</a> *pPort)</td></tr>
<tr class="memdesc:a06714e46aafbbf51c83c7cdae1498573"><td class="mdescLeft"> </td><td class="mdescRight">Helpfunction that clears the nodetype in empty systemports, It will not clear the type if the port is not empty or if the port is not a systemport. <br /></td></tr>
<tr class="separator:a06714e46aafbbf51c83c7cdae1498573"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a31f731d600d0e73cbefbdf3da33ef5b0" id="r_a31f731d600d0e73cbefbdf3da33ef5b0"><td class="memItemLeft" align="right" valign="top"><a id="a31f731d600d0e73cbefbdf3da33ef5b0" name="a31f731d600d0e73cbefbdf3da33ef5b0"></a>
bool </td><td class="memItemRight" valign="bottom"><b>ensureNotCrossConnecting</b> (<a class="el" href="classhopsan_1_1Port.html">Port</a> *pPort1, <a class="el" href="classhopsan_1_1Port.html">Port</a> *pPort2)</td></tr>
<tr class="separator:a31f731d600d0e73cbefbdf3da33ef5b0"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:af32399369792a5271da654830c2cff2a" id="r_af32399369792a5271da654830c2cff2a"><td class="memItemLeft" align="right" valign="top"><a id="af32399369792a5271da654830c2cff2a" name="af32399369792a5271da654830c2cff2a"></a>
bool </td><td class="memItemRight" valign="bottom"><b>ensureSameNodeType</b> (<a class="el" href="classhopsan_1_1Port.html">Port</a> *pPort1, <a class="el" href="classhopsan_1_1Port.html">Port</a> *pPort2)</td></tr>
<tr class="separator:af32399369792a5271da654830c2cff2a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a69382a0436ee982d5431d74a04d2f900" id="r_a69382a0436ee982d5431d74a04d2f900"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="#a69382a0436ee982d5431d74a04d2f900">ensureConnectionOK</a> (<a class="el" href="classhopsan_1_1Node.html">Node</a> *pNode, <a class="el" href="classhopsan_1_1Port.html">Port</a> *pPort1, <a class="el" href="classhopsan_1_1Port.html">Port</a> *pPort2)</td></tr>
<tr class="separator:a69382a0436ee982d5431d74a04d2f900"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a655339cf0d39a8cd8c5e37e3bdcb8b53" id="r_a655339cf0d39a8cd8c5e37e3bdcb8b53"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classhopsan_1_1Port.html">Port</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="#a655339cf0d39a8cd8c5e37e3bdcb8b53">ifMultiportAddSubport</a> (<a class="el" href="classhopsan_1_1Port.html">Port</a> *pMaybeMultiport)</td></tr>
<tr class="memdesc:a655339cf0d39a8cd8c5e37e3bdcb8b53"><td class="mdescLeft"> </td><td class="mdescRight">Detects if a port is a multiport and then adds and returns a subport. <br /></td></tr>
<tr class="separator:a655339cf0d39a8cd8c5e37e3bdcb8b53"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a094f917bf5e5436fd6da02f015c5c898" id="r_a094f917bf5e5436fd6da02f015c5c898"><td class="memItemLeft" align="right" valign="top"><a id="a094f917bf5e5436fd6da02f015c5c898" name="a094f917bf5e5436fd6da02f015c5c898"></a>
void </td><td class="memItemRight" valign="bottom"><b>ifMultiportPrepareDissconnect</b> (<a class="el" href="classhopsan_1_1Port.html">Port</a> *pMaybeMultiport1, <a class="el" href="classhopsan_1_1Port.html">Port</a> *pMaybeMultiport2, <a class="el" href="classhopsan_1_1Port.html">Port</a> *&rpActualPort1, <a class="el" href="classhopsan_1_1Port.html">Port</a> *&rpActualPort2)</td></tr>
<tr class="separator:a094f917bf5e5436fd6da02f015c5c898"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a51a544e700706da3f25a717bd3aff97e" id="r_a51a544e700706da3f25a717bd3aff97e"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="#a51a544e700706da3f25a717bd3aff97e">ifMultiportCleanupAfterConnect</a> (<a class="el" href="classhopsan_1_1Port.html">Port</a> *pMaybeMultiport, <a class="el" href="classhopsan_1_1Port.html">Port</a> **ppActualPort, const bool wasSucess)</td></tr>
<tr class="separator:a51a544e700706da3f25a717bd3aff97e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a85d2f1d563fbe82cbf9d9ea8fc8bc7ae" id="r_a85d2f1d563fbe82cbf9d9ea8fc8bc7ae"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="#a85d2f1d563fbe82cbf9d9ea8fc8bc7ae">ifMultiportCleanupAfterDissconnect</a> (<a class="el" href="classhopsan_1_1Port.html">Port</a> *pMaybeMultiport, <a class="el" href="classhopsan_1_1Port.html">Port</a> **ppActualPort, const bool wasSucess)</td></tr>
<tr class="separator:a85d2f1d563fbe82cbf9d9ea8fc8bc7ae"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a3616047c819e8c76a37d0a75ee99824d" name="a3616047c819e8c76a37d0a75ee99824d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3616047c819e8c76a37d0a75ee99824d">◆ </a></span>determineWhereToStoreNodeAndStoreIt()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void determineWhereToStoreNodeAndStoreIt </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classhopsan_1_1Node.html">Node</a> *</td> <td class="paramname"><span class="paramname"><em>pNode</em></span></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Find the system highest up in the model hierarchy for the ports connected to this node and store the node there. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">pNode</td><td>The node to store </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a69382a0436ee982d5431d74a04d2f900" name="a69382a0436ee982d5431d74a04d2f900"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a69382a0436ee982d5431d74a04d2f900">◆ </a></span>ensureConnectionOK()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool ensureConnectionOK </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classhopsan_1_1Node.html">Node</a> *</td> <td class="paramname"><span class="paramname"><em>pNode</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classhopsan_1_1Port.html">Port</a> *</td> <td class="paramname"><span class="paramname"><em>pPort1</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classhopsan_1_1Port.html">Port</a> *</td> <td class="paramname"><span class="paramname"><em>pPort2</em></span> )</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="a655339cf0d39a8cd8c5e37e3bdcb8b53" name="a655339cf0d39a8cd8c5e37e3bdcb8b53"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a655339cf0d39a8cd8c5e37e3bdcb8b53">◆ </a></span>ifMultiportAddSubport()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classhopsan_1_1Port.html">Port</a> * ifMultiportAddSubport </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classhopsan_1_1Port.html">Port</a> *</td> <td class="paramname"><span class="paramname"><em>pMaybeMultiport</em></span></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Detects if a port is a multiport and then adds and returns a subport. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">pMaybeMultiport</td><td>A pointer to the port that may be a multiport </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>A pointer to a new subport in the multiport, or the pMaybeMultiport itself if it was not a multiport </dd></dl>
</div>
</div>
<a id="a51a544e700706da3f25a717bd3aff97e" name="a51a544e700706da3f25a717bd3aff97e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a51a544e700706da3f25a717bd3aff97e">◆ </a></span>ifMultiportCleanupAfterConnect()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ifMultiportCleanupAfterConnect </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classhopsan_1_1Port.html">Port</a> *</td> <td class="paramname"><span class="paramname"><em>pMaybeMultiport</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classhopsan_1_1Port.html">Port</a> **</td> <td class="paramname"><span class="paramname"><em>ppActualPort</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const bool</td> <td class="paramname"><span class="paramname"><em>wasSucess</em></span> )</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="a85d2f1d563fbe82cbf9d9ea8fc8bc7ae" name="a85d2f1d563fbe82cbf9d9ea8fc8bc7ae"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a85d2f1d563fbe82cbf9d9ea8fc8bc7ae">◆ </a></span>ifMultiportCleanupAfterDissconnect()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ifMultiportCleanupAfterDissconnect </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classhopsan_1_1Port.html">Port</a> *</td> <td class="paramname"><span class="paramname"><em>pMaybeMultiport</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classhopsan_1_1Port.html">Port</a> **</td> <td class="paramname"><span class="paramname"><em>ppActualPort</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const bool</td> <td class="paramname"><span class="paramname"><em>wasSucess</em></span> )</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="a7b46d89e2c1fbba746eebd3b7c29f513" name="a7b46d89e2c1fbba746eebd3b7c29f513"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7b46d89e2c1fbba746eebd3b7c29f513">◆ </a></span>mergeNodeConnection()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool mergeNodeConnection </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classhopsan_1_1Port.html">Port</a> *</td> <td class="paramname"><span class="paramname"><em>pPort1</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classhopsan_1_1Port.html">Port</a> *</td> <td class="paramname"><span class="paramname"><em>pPort2</em></span> )</td>
</tr>
</table>
</div><div class="memdoc">
<dl class="section note"><dt>Note</dt><dd>requires that input ports are not multiports (they can be subports in multiports) </dd></dl>
</div>
</div>
<a id="af51ceb8ea704aa89a064d2249dc137ae" name="af51ceb8ea704aa89a064d2249dc137ae"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af51ceb8ea704aa89a064d2249dc137ae">◆ </a></span>splitNodeConnection()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool splitNodeConnection </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classhopsan_1_1Port.html">Port</a> *</td> <td class="paramname"><span class="paramname"><em>pPort1</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classhopsan_1_1Port.html">Port</a> *</td> <td class="paramname"><span class="paramname"><em>pPort2</em></span> )</td>
</tr>
</table>
</div><div class="memdoc">
<dl class="section note"><dt>Note</dt><dd>Requires that the input ports are not multiports </dd></dl>
</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><b>hopsan</b></li><li class="navelem"><a class="el" href="classhopsan_1_1ConnectionAssistant.html">ConnectionAssistant</a></li>
<li class="footer">Generated on Fri Nov 29 2024 14:29:31 for Hopsan by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.12.0 </li>
</ul>
</div>
</body>
</html>