-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathclasserpc_1_1_manually_constructed.html
332 lines (319 loc) · 19.9 KB
/
classerpc_1_1_manually_constructed.html
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
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
<!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>
<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.11"/>
<title>eRPC API Reference: erpc::ManuallyConstructed< T > Class Template 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="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
$(document).ready(initResizable);
$(window).load(resizeHeight);
</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/javascript">
$(document).ready(function() { init_search(); });
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="customdoxygen.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="nxp_logo_small.png"/></td>
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">eRPC API Reference
 <span id="projectnumber">Rev. 1.13.0</span>
</div>
<div id="projectbrief">NXP Semiconductors</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.11 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="modules.html"><span>API Reference</span></a></li>
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
<li>
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</span>
</div>
</li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Class List</span></a></li>
<li><a href="classes.html"><span>Class Index</span></a></li>
<li><a href="inherits.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class Members</span></a></li>
</ul>
</div>
</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">
$(document).ready(function(){initNavTree('classerpc_1_1_manually_constructed.html','');});
</script>
<div id="doc-content">
<!-- 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 class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="#pro-attribs">Protected Attributes</a> |
<a href="classerpc_1_1_manually_constructed-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">erpc::ManuallyConstructed< T > Class Template Reference<div class="ingroups"><a class="el" href="group__infra.html">Infrastructure</a> » <a class="el" href="group__infra__utility.html">Utilities</a></div></div> </div>
</div><!--header-->
<div class="contents">
<p>Allocates static storage for an object.
<a href="classerpc_1_1_manually_constructed.html#details">More...</a></p>
<p><code>#include <<a class="el" href="erpc__manually__constructed_8hpp_source.html">erpc_manually_constructed.hpp</a>></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:ac898468f9a960e8be8054821d73cbc34"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classerpc_1_1_manually_constructed.html#ac898468f9a960e8be8054821d73cbc34">destroy</a> (void)</td></tr>
<tr class="memdesc:ac898468f9a960e8be8054821d73cbc34"><td class="mdescLeft"> </td><td class="mdescRight">Invoke the object's destructor. <a href="#ac898468f9a960e8be8054821d73cbc34">More...</a><br /></td></tr>
<tr class="separator:ac898468f9a960e8be8054821d73cbc34"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:abb706cd5a0d5f35f6f8fc2366b4a2fa0"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classerpc_1_1_manually_constructed.html#abb706cd5a0d5f35f6f8fc2366b4a2fa0">isUsed</a> (void)</td></tr>
<tr class="memdesc:abb706cd5a0d5f35f6f8fc2366b4a2fa0"><td class="mdescLeft"> </td><td class="mdescRight">Returns information if object is free or is used. <a href="#abb706cd5a0d5f35f6f8fc2366b4a2fa0">More...</a><br /></td></tr>
<tr class="separator:abb706cd5a0d5f35f6f8fc2366b4a2fa0"><td class="memSeparator" colspan="2"> </td></tr>
<tr><td colspan="2"><div class="groupHeader">Object access</div></td></tr>
<tr class="memitem:acd1ee01fd0d61971e59616b02d7b38d2"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="acd1ee01fd0d61971e59616b02d7b38d2"></a>
T * </td><td class="memItemRight" valign="bottom"><b>get</b> (void)</td></tr>
<tr class="separator:acd1ee01fd0d61971e59616b02d7b38d2"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ace67bfe44de98e5b0152a5b71452033c"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ace67bfe44de98e5b0152a5b71452033c"></a>
const T * </td><td class="memItemRight" valign="bottom"><b>get</b> (void) const </td></tr>
<tr class="separator:ace67bfe44de98e5b0152a5b71452033c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ae59aad9eab4152cfd2b91cabf2934724"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ae59aad9eab4152cfd2b91cabf2934724"></a>
T * </td><td class="memItemRight" valign="bottom"><b>operator-></b> (void)</td></tr>
<tr class="separator:ae59aad9eab4152cfd2b91cabf2934724"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a8b3bef0c3c41257ee640080c49f0b826"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a8b3bef0c3c41257ee640080c49f0b826"></a>
const T * </td><td class="memItemRight" valign="bottom"><b>operator-></b> (void) const </td></tr>
<tr class="separator:a8b3bef0c3c41257ee640080c49f0b826"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ad80d229ffb4bf7eeb1b934bf71c61ea8"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ad80d229ffb4bf7eeb1b934bf71c61ea8"></a>
T & </td><td class="memItemRight" valign="bottom"><b>operator*</b> (void)</td></tr>
<tr class="separator:ad80d229ffb4bf7eeb1b934bf71c61ea8"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a6adf04318ea7b127d10ad1b721eda417"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a6adf04318ea7b127d10ad1b721eda417"></a>
const T & </td><td class="memItemRight" valign="bottom"><b>operator*</b> (void) const </td></tr>
<tr class="separator:a6adf04318ea7b127d10ad1b721eda417"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:af16ed09c6be4dea3a3a4179a930b100d"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="af16ed09c6be4dea3a3a4179a930b100d"></a>
 </td><td class="memItemRight" valign="bottom"><b>operator T *</b> (void)</td></tr>
<tr class="separator:af16ed09c6be4dea3a3a4179a930b100d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a4c52d1026914ed53f361ef72bde22f6a"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a4c52d1026914ed53f361ef72bde22f6a"></a>
 </td><td class="memItemRight" valign="bottom"><b>operator const T *</b> (void) const </td></tr>
<tr class="separator:a4c52d1026914ed53f361ef72bde22f6a"><td class="memSeparator" colspan="2"> </td></tr>
<tr><td colspan="2"><div class="groupHeader">Explicit construction methods</div></td></tr>
<tr class="memitem:a9c0d88b75247c3f989df85c6a41c976a"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a9c0d88b75247c3f989df85c6a41c976a"></a>
void </td><td class="memItemRight" valign="bottom"><b>construct</b> (void)</td></tr>
<tr class="separator:a9c0d88b75247c3f989df85c6a41c976a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a088f76ae970f1c5d4d392d364612f955"><td class="memTemplParams" colspan="2"><a class="anchor" id="a088f76ae970f1c5d4d392d364612f955"></a>
template<typename A1 > </td></tr>
<tr class="memitem:a088f76ae970f1c5d4d392d364612f955"><td class="memTemplItemLeft" align="right" valign="top">void </td><td class="memTemplItemRight" valign="bottom"><b>construct</b> (const A1 &a1)</td></tr>
<tr class="separator:a088f76ae970f1c5d4d392d364612f955"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a63b46c89577795f6ee3d3bc1303e010f"><td class="memTemplParams" colspan="2"><a class="anchor" id="a63b46c89577795f6ee3d3bc1303e010f"></a>
template<typename A1 , typename A2 > </td></tr>
<tr class="memitem:a63b46c89577795f6ee3d3bc1303e010f"><td class="memTemplItemLeft" align="right" valign="top">void </td><td class="memTemplItemRight" valign="bottom"><b>construct</b> (const A1 &a1, const A2 &a2)</td></tr>
<tr class="separator:a63b46c89577795f6ee3d3bc1303e010f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a2647883ac3a74186e3c24a199cae09c9"><td class="memTemplParams" colspan="2"><a class="anchor" id="a2647883ac3a74186e3c24a199cae09c9"></a>
template<typename A1 , typename A2 , typename A3 > </td></tr>
<tr class="memitem:a2647883ac3a74186e3c24a199cae09c9"><td class="memTemplItemLeft" align="right" valign="top">void </td><td class="memTemplItemRight" valign="bottom"><b>construct</b> (const A1 &a1, const A2 &a2, const A3 &a3)</td></tr>
<tr class="separator:a2647883ac3a74186e3c24a199cae09c9"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a8b2a90add53fb6d3eb87a45740ddb6b4"><td class="memTemplParams" colspan="2"><a class="anchor" id="a8b2a90add53fb6d3eb87a45740ddb6b4"></a>
template<typename A1 , typename A2 , typename A3 , typename A4 > </td></tr>
<tr class="memitem:a8b2a90add53fb6d3eb87a45740ddb6b4"><td class="memTemplItemLeft" align="right" valign="top">void </td><td class="memTemplItemRight" valign="bottom"><b>construct</b> (const A1 &a1, const A2 &a2, const A3 &a3, const A4 &a4)</td></tr>
<tr class="separator:a8b2a90add53fb6d3eb87a45740ddb6b4"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aab05586fce056b9fa87510fe9553beb4"><td class="memTemplParams" colspan="2"><a class="anchor" id="aab05586fce056b9fa87510fe9553beb4"></a>
template<typename A1 , typename A2 , typename A3 , typename A4 , typename A5 > </td></tr>
<tr class="memitem:aab05586fce056b9fa87510fe9553beb4"><td class="memTemplItemLeft" align="right" valign="top">void </td><td class="memTemplItemRight" valign="bottom"><b>construct</b> (const A1 &a1, const A2 &a2, const A3 &a3, const A4 &a4, const A5 &a5)</td></tr>
<tr class="separator:aab05586fce056b9fa87510fe9553beb4"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a7a93a5f83f4188c2c832963ff3ea7c8d"><td class="memTemplParams" colspan="2"><a class="anchor" id="a7a93a5f83f4188c2c832963ff3ea7c8d"></a>
template<typename A1 , typename A2 , typename A3 , typename A4 , typename A5 , typename A6 > </td></tr>
<tr class="memitem:a7a93a5f83f4188c2c832963ff3ea7c8d"><td class="memTemplItemLeft" align="right" valign="top">void </td><td class="memTemplItemRight" valign="bottom"><b>construct</b> (const A1 &a1, const A2 &a2, const A3 &a3, const A4 &a4, const A5 &a5, const A6 &a6)</td></tr>
<tr class="separator:a7a93a5f83f4188c2c832963ff3ea7c8d"><td class="memSeparator" colspan="2"> </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:a6d220c46013cfd6f7713013c3a77e592"><td class="memItemLeft" align="right" valign="top">uint64_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classerpc_1_1_manually_constructed.html#a6d220c46013cfd6f7713013c3a77e592">m_storage</a> [(sizeof(T)+sizeof(uint64_t)-1)/sizeof(uint64_t)]</td></tr>
<tr class="memdesc:a6d220c46013cfd6f7713013c3a77e592"><td class="mdescLeft"> </td><td class="mdescRight">Storage for the object. <a href="#a6d220c46013cfd6f7713013c3a77e592">More...</a><br /></td></tr>
<tr class="separator:a6d220c46013cfd6f7713013c3a77e592"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a1411b92ba272e36fb98f9b53dce4f35e"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classerpc_1_1_manually_constructed.html#a1411b92ba272e36fb98f9b53dce4f35e">m_isConstructed</a></td></tr>
<tr class="memdesc:a1411b92ba272e36fb98f9b53dce4f35e"><td class="mdescLeft"> </td><td class="mdescRight">Track construct/destruct calls. <a href="#a1411b92ba272e36fb98f9b53dce4f35e">More...</a><br /></td></tr>
<tr class="separator:a1411b92ba272e36fb98f9b53dce4f35e"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><h3>template<class T><br />
class erpc::ManuallyConstructed< T ></h3>
<p>Allocates static storage for an object. </p>
<p>This template class defines storage of the template class' size. Then it gives the user explicit control over construction and destruction of the object residing in that storage. This is useful for placing objects in unions, or other situations where you need static storage but want to delay the actual construction of the object.</p>
<p>Objects of this class will act as a pointer to the template argument class type. Of course, if the object has not yet been constructed then the behavior is undefined if the pointer to it is used.</p>
<p>Note that there is not a constructor or deconstructor. This is because members of unions cannot have constructors or deconstructors.</p>
<p>Instances of this template class are aligned to 8 bytes. </p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="ac898468f9a960e8be8054821d73cbc34"></a>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<class T > </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="classerpc_1_1_manually_constructed.html">erpc::ManuallyConstructed</a>< T >::destroy </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Invoke the object's destructor. </p>
<p>Behavior is undefined if the objected was not previously initialized. </p>
</div>
</div>
<a class="anchor" id="abb706cd5a0d5f35f6f8fc2366b4a2fa0"></a>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<class T > </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool <a class="el" href="classerpc_1_1_manually_constructed.html">erpc::ManuallyConstructed</a>< T >::isUsed </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns information if object is free or is used. </p>
<dl class="section return"><dt>Returns</dt><dd>true Object is constructed and used. </dd>
<dd>
false Object wasn't constructed or it was destructed already. </dd></dl>
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a class="anchor" id="a6d220c46013cfd6f7713013c3a77e592"></a>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<class T > </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">uint64_t <a class="el" href="classerpc_1_1_manually_constructed.html">erpc::ManuallyConstructed</a>< T >::m_storage[(sizeof(T)+sizeof(uint64_t)-1)/sizeof(uint64_t)]</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Storage for the object. </p>
<p>An array of uint64 is used to get 8-byte alignment. </p>
</div>
</div>
<a class="anchor" id="a1411b92ba272e36fb98f9b53dce4f35e"></a>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<class T > </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool <a class="el" href="classerpc_1_1_manually_constructed.html">erpc::ManuallyConstructed</a>< T >::m_isConstructed</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Track construct/destruct calls. </p>
<p>Based on this variable we can allow or forbid construct/destruct calls. </p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="erpc__manually__constructed_8hpp_source.html">erpc_manually_constructed.hpp</a></li>
</ul>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- HTML footer for doxygen 1.8.5-->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul class="foot">
<li class="footer">Copyright 2016-2020 NXP Semiconductors. All rights reserved.
</li>
</ul>
</div>
</body>
</html>