-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathField_8h.html
More file actions
371 lines (359 loc) · 31.3 KB
/
Field_8h.html
File metadata and controls
371 lines (359 loc) · 31.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
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
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
<!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.9.8"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>COMMS: include/comms/Field.h File 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>
<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 id="projectrow">
<td id="projectalign">
<div id="projectname">COMMS
</div>
<div id="projectbrief">Template library intended to help with implementation of communication protocols.</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.8 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search/",'.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */
</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">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_d44c64559bbebec7f509842c48db8b23.html">include</a></li><li class="navelem"><a class="el" href="dir_b3b90260015bf389bbf56758f180cfb9.html">comms</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#nested-classes">Classes</a> |
<a href="#namespaces">Namespaces</a> |
<a href="#define-members">Macros</a> </div>
<div class="headertitle"><div class="title">Field.h File Reference</div></div>
</div><!--header-->
<div class="contents">
<p>Contains definition of <a class="el" href="classcomms_1_1Field.html">comms::Field</a> class.
<a href="#details">More...</a></p>
<div class="textblock"><code>#include "comms/details/FieldBase.h"</code><br />
<code>#include "comms/details/field_alias.h"</code><br />
<code>#include "comms/details/fields_access.h"</code><br />
<code>#include "comms/details/macro_common.h"</code><br />
<code>#include "<a class="el" href="access_8h_source.html">comms/util/access.h</a>"</code><br />
<code>#include <cstddef></code><br />
<code>#include <type_traits></code><br />
</div>
<p><a href="Field_8h_source.html">Go to the source code of this file.</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="nested-classes" name="nested-classes"></a>
Classes</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classcomms_1_1Field.html">comms::Field< TOptions ></a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Base class to all the field classes. <a href="classcomms_1_1Field.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="namespaces" name="namespaces"></a>
Namespaces</h2></td></tr>
<tr class="memitem:namespacecomms" id="r_namespacecomms"><td class="memItemLeft" align="right" valign="top">namespace  </td><td class="memItemRight" valign="bottom"><a class="el" href="namespacecomms.html">comms</a></td></tr>
<tr class="memdesc:namespacecomms"><td class="mdescLeft"> </td><td class="mdescRight">Main namespace for all classes / functions of COMMS library. <br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="define-members" name="define-members"></a>
Macros</h2></td></tr>
<tr class="memitem:a7adc16bdcc59b3f0a646c106816c9cab" id="r_a7adc16bdcc59b3f0a646c106816c9cab"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="Field_8h.html#a7adc16bdcc59b3f0a646c106816c9cab">COMMS_FIELD_ALIAS</a>(f_, ...)   COMMS_DO_ALIAS(field_, f_, __VA_ARGS__)</td></tr>
<tr class="memdesc:a7adc16bdcc59b3f0a646c106816c9cab"><td class="mdescLeft"> </td><td class="mdescRight">Generate convinience alias access member functions for other member fields. <br /></td></tr>
<tr class="separator:a7adc16bdcc59b3f0a646c106816c9cab"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a96226a2c000a3145a48ce074b6a7f847" id="r_a96226a2c000a3145a48ce074b6a7f847"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="Field_8h.html#a96226a2c000a3145a48ce074b6a7f847">COMMS_FIELD_MEMBERS_ACCESS</a>(...)</td></tr>
<tr class="memdesc:a96226a2c000a3145a48ce074b6a7f847"><td class="mdescLeft"> </td><td class="mdescRight">Add convenience access enum and functions to the members of composite fields, such as <a class="el" href="classcomms_1_1field_1_1Bundle.html">comms::field::Bundle</a> or <a class="el" href="classcomms_1_1field_1_1Bitfield.html">comms::field::Bitfield</a>. <br /></td></tr>
<tr class="separator:a96226a2c000a3145a48ce074b6a7f847"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a83dcd24efc7be6d3a95eadfb259a6b33" id="r_a83dcd24efc7be6d3a95eadfb259a6b33"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="Field_8h.html#a83dcd24efc7be6d3a95eadfb259a6b33">COMMS_FIELD_MEMBERS_ACCESS_NOTEMPLATE</a>(...)</td></tr>
<tr class="memdesc:a83dcd24efc7be6d3a95eadfb259a6b33"><td class="mdescLeft"> </td><td class="mdescRight">Similar to <a class="el" href="Field_8h.html#a96226a2c000a3145a48ce074b6a7f847">COMMS_FIELD_MEMBERS_ACCESS()</a>, but dedicated for non-template classes. <br /></td></tr>
<tr class="separator:a83dcd24efc7be6d3a95eadfb259a6b33"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:af74198f06b52d3f58c92e795b2ff7129" id="r_af74198f06b52d3f58c92e795b2ff7129"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="Field_8h.html#af74198f06b52d3f58c92e795b2ff7129">COMMS_FIELD_MEMBERS_NAMES</a>(...)</td></tr>
<tr class="memdesc:af74198f06b52d3f58c92e795b2ff7129"><td class="mdescLeft"> </td><td class="mdescRight">Provide names for member fields of composite fields, such as <a class="el" href="classcomms_1_1field_1_1Bundle.html">comms::field::Bundle</a> or <a class="el" href="classcomms_1_1field_1_1Bitfield.html">comms::field::Bitfield</a>. <br /></td></tr>
<tr class="separator:af74198f06b52d3f58c92e795b2ff7129"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Contains definition of <a class="el" href="classcomms_1_1Field.html">comms::Field</a> class. </p>
</div><h2 class="groupheader">Macro Definition Documentation</h2>
<a id="a7adc16bdcc59b3f0a646c106816c9cab" name="a7adc16bdcc59b3f0a646c106816c9cab"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7adc16bdcc59b3f0a646c106816c9cab">◆ </a></span>COMMS_FIELD_ALIAS</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define COMMS_FIELD_ALIAS</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname">f_, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"> </td>
<td class="paramname"><em>...</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td>   COMMS_DO_ALIAS(field_, f_, __VA_ARGS__)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Generate convinience alias access member functions for other member fields. </p>
<p>Same as COMMS_MSG_FIELD_ALIAS() but applicable to <a class="el" href="classcomms_1_1field_1_1Bundle.html">comms::field::Bundle</a> field. </p><dl class="section pre"><dt>Precondition</dt><dd>The macro <a class="el" href="Field_8h.html#a96226a2c000a3145a48ce074b6a7f847" title="Add convenience access enum and functions to the members of composite fields, such as comms::field::B...">COMMS_FIELD_MEMBERS_ACCESS()</a> needs to be used before <a class="el" href="Field_8h.html#a7adc16bdcc59b3f0a646c106816c9cab">COMMS_FIELD_ALIAS()</a> to define convenience access functions. </dd></dl>
</div>
</div>
<a id="a96226a2c000a3145a48ce074b6a7f847" name="a96226a2c000a3145a48ce074b6a7f847"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a96226a2c000a3145a48ce074b6a7f847">◆ </a></span>COMMS_FIELD_MEMBERS_ACCESS</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define COMMS_FIELD_MEMBERS_ACCESS</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname"><em>...</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<b>Value:</b><div class="fragment"><div class="line"> COMMS_EXPAND(COMMS_DEFINE_FIELD_ENUM(__VA_ARGS__)) \</div>
<div class="line"> COMMS_FIELD_VALUE_ACCESS_FUNC { \</div>
<div class="line"> <span class="keyword">auto</span>& val = <a class="code hl_function" href="namespacecomms_1_1field.html#ad6236b8f47bc5940ad8417869468a9ab">comms::field::toFieldBase</a>(*this).value(); \</div>
<div class="line"> <span class="keyword">using </span>AllFieldsTuple = <span class="keyword">typename</span> std::decay<<span class="keyword">decltype</span>(val)>::type; \</div>
<div class="line"> static_assert(std::tuple_size<AllFieldsTuple>::value == FieldIdx_numOfValues, \</div>
<div class="line"> <span class="stringliteral">"Invalid number of names for fields tuple"</span>); \</div>
<div class="line"> <span class="keywordflow">return</span> val; \</div>
<div class="line"> } \</div>
<div class="line"> COMMS_FIELD_VALUE_ACCESS_CONST_FUNC { \</div>
<div class="line"> <span class="keyword">auto</span>& val = <a class="code hl_function" href="namespacecomms_1_1field.html#ad6236b8f47bc5940ad8417869468a9ab">comms::field::toFieldBase</a>(*this).value(); \</div>
<div class="line"> <span class="keyword">using </span>AllFieldsTuple = <span class="keyword">typename</span> std::decay<<span class="keyword">decltype</span>(val)>::type; \</div>
<div class="line"> static_assert(std::tuple_size<AllFieldsTuple>::value == FieldIdx_numOfValues, \</div>
<div class="line"> <span class="stringliteral">"Invalid number of names for fields tuple"</span>); \</div>
<div class="line"> <span class="keywordflow">return</span> val; \</div>
<div class="line"> } \</div>
<div class="line"> COMMS_EXPAND(COMMS_DO_FIELD_ACC_FUNC(ValueType, value(), __VA_ARGS__))</div>
<div class="ttc" id="anamespacecomms_1_1field_html_ad6236b8f47bc5940ad8417869468a9ab"><div class="ttname"><a href="namespacecomms_1_1field.html#ad6236b8f47bc5940ad8417869468a9ab">comms::field::toFieldBase</a></div><div class="ttdeci">Bundle< TFieldBase, TMembers, TOptions... > & toFieldBase(Bundle< TFieldBase, TMembers, TOptions... > &field)</div><div class="ttdoc">Upcast type of the field definition to its parent comms::field::Bundle type in order to have access t...</div><div class="ttdef"><b>Definition</b> Bundle.h:828</div></div>
</div><!-- fragment -->
<p>Add convenience access enum and functions to the members of composite fields, such as <a class="el" href="classcomms_1_1field_1_1Bundle.html">comms::field::Bundle</a> or <a class="el" href="classcomms_1_1field_1_1Bitfield.html">comms::field::Bitfield</a>. </p>
<p>Very similar to <a class="el" href="Field_8h.html#af74198f06b52d3f58c92e795b2ff7129">COMMS_FIELD_MEMBERS_NAMES()</a>, but does <b>NOT</b> require definition of <b>Base</b> inner member type (for some compilers) and does <b>NOT</b> define inner <b>Field_*</b> types for used member fields. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">...</td><td>List of fields' names. </td></tr>
</table>
</dd>
</dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="Field_8h.html#af74198f06b52d3f58c92e795b2ff7129">COMMS_FIELD_MEMBERS_NAMES()</a> </dd></dl>
<dl class="section note"><dt>Note</dt><dd>Relevant to <a class="el" href="classcomms_1_1field_1_1Bundle.html">comms::field::Bundle</a> and <a class="el" href="classcomms_1_1field_1_1Bitfield.html">comms::field::Bitfield</a> </dd>
<dd>
Defined in "comms/Field.h" </dd></dl>
<dl class="section warning"><dt>Warning</dt><dd>Some compilers, such as <b>clang</b> or early versions of <b>g++</b> may have problems compiling code generated by this macro even though it uses valid C++11 constructs in attempt to automatically identify the type of the base class. If the compilation fails, and this macro resides inside a <b>NON-template</b> class, please use <a class="el" href="Field_8h.html#a83dcd24efc7be6d3a95eadfb259a6b33">COMMS_FIELD_MEMBERS_ACCESS_NOTEMPLATE()</a> macro instead. In case this macro needs to reside inside a <b>template</b> class, then there is still a need to define inner <b>Base</b> type, which specifies exact type of the <a class="el" href="classcomms_1_1field_1_1Bitfield.html">comms::field::Bitfield</a> or <a class="el" href="classcomms_1_1field_1_1Bundle.html">comms::field::Bundle</a> class. <div class="fragment"><div class="line"><span class="keyword">template</span> <<span class="keyword">typename</span>... TExtraOptions></div>
<div class="line"><span class="keyword">class </span>MyField : <span class="keyword">public</span></div>
<div class="line"> <a class="code hl_class" href="classcomms_1_1field_1_1Bitfield.html">comms::field::Bitfield</a><</div>
<div class="line"> MyFieldBase,</div>
<div class="line"> std::tuple<Field1, Field2, Field3>,</div>
<div class="line"> TExtraOptions...</div>
<div class="line"> ></div>
<div class="line">{</div>
<div class="line"> <span class="comment">// Define type of the base class</span></div>
<div class="line"> <span class="keyword">using </span>Base =</div>
<div class="line"> <a class="code hl_class" href="classcomms_1_1field_1_1Bitfield.html">comms::field::Bitfield</a><</div>
<div class="line"> MyFieldBase,</div>
<div class="line"> std::tuple<Field1, Field2, Field3>,</div>
<div class="line"> TExtraOptions...</div>
<div class="line"> >;</div>
<div class="line"><span class="keyword">public</span>:</div>
<div class="line"> <a class="code hl_define" href="Field_8h.html#a96226a2c000a3145a48ce074b6a7f847">COMMS_FIELD_MEMBERS_ACCESS</a>(member1, member2, member3);</div>
<div class="line">};</div>
<div class="ttc" id="aField_8h_html_a96226a2c000a3145a48ce074b6a7f847"><div class="ttname"><a href="Field_8h.html#a96226a2c000a3145a48ce074b6a7f847">COMMS_FIELD_MEMBERS_ACCESS</a></div><div class="ttdeci">#define COMMS_FIELD_MEMBERS_ACCESS(...)</div><div class="ttdoc">Add convenience access enum and functions to the members of composite fields, such as comms::field::B...</div><div class="ttdef"><b>Definition</b> Field.h:246</div></div>
<div class="ttc" id="aclasscomms_1_1field_1_1Bitfield_html"><div class="ttname"><a href="classcomms_1_1field_1_1Bitfield.html">comms::field::Bitfield</a></div><div class="ttdoc">Bitfield field.</div><div class="ttdef"><b>Definition</b> Bitfield.h:107</div></div>
</div><!-- fragment --> </dd></dl>
</div>
</div>
<a id="a83dcd24efc7be6d3a95eadfb259a6b33" name="a83dcd24efc7be6d3a95eadfb259a6b33"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a83dcd24efc7be6d3a95eadfb259a6b33">◆ </a></span>COMMS_FIELD_MEMBERS_ACCESS_NOTEMPLATE</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define COMMS_FIELD_MEMBERS_ACCESS_NOTEMPLATE</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname"><em>...</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<b>Value:</b><div class="fragment"><div class="line"> COMMS_EXPAND(COMMS_DEFINE_FIELD_ENUM(__VA_ARGS__)) \</div>
<div class="line"> COMMS_EXPAND(COMMS_DO_FIELD_ACC_FUNC_NOTEMPLATE(__VA_ARGS__))</div>
</div><!-- fragment -->
<p>Similar to <a class="el" href="Field_8h.html#a96226a2c000a3145a48ce074b6a7f847">COMMS_FIELD_MEMBERS_ACCESS()</a>, but dedicated for non-template classes. </p>
<p>The <a class="el" href="Field_8h.html#a96226a2c000a3145a48ce074b6a7f847">COMMS_FIELD_MEMBERS_ACCESS()</a> macro is a generic one, which can be used in any class (template, or non-template). However, some compilers (such as <b>g++-4.9</b> and below, <b>clang-4.0</b> and below) may fail to compile it even though it uses valid C++11 constructs. If the compilation fails and the class it is being used in is <b>NOT</b> a template one, please use <a class="el" href="Field_8h.html#a83dcd24efc7be6d3a95eadfb259a6b33">COMMS_FIELD_MEMBERS_ACCESS_NOTEMPLATE()</a> instead. </p><dl class="section see"><dt>See also</dt><dd><a class="el" href="Field_8h.html#af74198f06b52d3f58c92e795b2ff7129">COMMS_FIELD_MEMBERS_NAMES()</a> </dd>
<dd>
<a class="el" href="Field_8h.html#a96226a2c000a3145a48ce074b6a7f847">COMMS_FIELD_MEMBERS_ACCESS()</a> </dd></dl>
<dl class="section note"><dt>Note</dt><dd>Defined in "comms/Field.h" </dd></dl>
</div>
</div>
<a id="af74198f06b52d3f58c92e795b2ff7129" name="af74198f06b52d3f58c92e795b2ff7129"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af74198f06b52d3f58c92e795b2ff7129">◆ </a></span>COMMS_FIELD_MEMBERS_NAMES</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define COMMS_FIELD_MEMBERS_NAMES</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname"><em>...</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<b>Value:</b><div class="fragment"><div class="line"> COMMS_EXPAND(<a class="code hl_define" href="Field_8h.html#a96226a2c000a3145a48ce074b6a7f847">COMMS_FIELD_MEMBERS_ACCESS</a>(__VA_ARGS__)) \</div>
<div class="line"> COMMS_EXPAND(COMMS_DO_FIELD_TYPEDEF(<span class="keyword">typename</span> Base::ValueType, Field_, FieldIdx_, __VA_ARGS__))</div>
</div><!-- fragment -->
<p>Provide names for member fields of composite fields, such as <a class="el" href="classcomms_1_1field_1_1Bundle.html">comms::field::Bundle</a> or <a class="el" href="classcomms_1_1field_1_1Bitfield.html">comms::field::Bitfield</a>. </p>
<p>The fields of "composite" types, such as <a class="el" href="classcomms_1_1field_1_1Bundle.html">comms::field::Bundle</a> or <a class="el" href="classcomms_1_1field_1_1Bitfield.html">comms::field::Bitfield</a> keep their members bundled in <a href="http://en.cppreference.com/w/cpp/utility/tuple">std::tuple</a> and provide access to them via <b>value()</b> member functions. The access to the specific member field can be obtained using <a href="http://en.cppreference.com/w/cpp/utility/tuple/get">std::get</a> later on: </p><div class="fragment"><div class="line"><span class="keyword">using </span>MyFieldBase = <a class="code hl_class" href="classcomms_1_1Field.html">comms::Field<comms::option::def::BigEndian></a>;</div>
<div class="line"><span class="keyword">using </span>Field1 = ... <span class="comment">/* some field definition */</span>;</div>
<div class="line"><span class="keyword">using </span>Field2 = ... <span class="comment">/* some field definition */</span>;</div>
<div class="line"><span class="keyword">using </span>Field3 = ... <span class="comment">/* some field definition */</span>;</div>
<div class="line"><span class="keyword">using </span>MyField =</div>
<div class="line"> <a class="code hl_class" href="classcomms_1_1field_1_1Bitfield.html">comms::field::Bitfield</a><</div>
<div class="line"> MyFieldBase,</div>
<div class="line"> std::tuple<Field1, Field2, Field3></div>
<div class="line"> >;</div>
<div class="line"> </div>
<div class="line">MyField field;</div>
<div class="line"><span class="keyword">auto</span>& members = field.<a class="code hl_function" href="classcomms_1_1field_1_1Bitfield.html#a082e9e589b1bdd2a0bba8e86e828466d">value</a>();</div>
<div class="line"><span class="keyword">auto</span>& firstMember = std::get<0>(members);</div>
<div class="line"><span class="keyword">auto</span>& secondMember = std::get<1>(members);</div>
<div class="line"><span class="keyword">auto</span>& thirdMember = std::get<2>(members);</div>
<div class="ttc" id="aclasscomms_1_1Field_html"><div class="ttname"><a href="classcomms_1_1Field.html">comms::Field</a></div><div class="ttdoc">Base class to all the field classes.</div><div class="ttdef"><b>Definition</b> Field.h:36</div></div>
<div class="ttc" id="aclasscomms_1_1field_1_1Bitfield_html_a082e9e589b1bdd2a0bba8e86e828466d"><div class="ttname"><a href="classcomms_1_1field_1_1Bitfield.html#a082e9e589b1bdd2a0bba8e86e828466d">comms::field::Bitfield::value</a></div><div class="ttdeci">const ValueType & value() const</div><div class="ttdoc">Get access to the stored tuple of fields.</div><div class="ttdef"><b>Definition</b> Bitfield.h:216</div></div>
</div><!-- fragment --><p> However, it would be convenient to provide names and easier access to the member fields. The <a class="el" href="Field_8h.html#af74198f06b52d3f58c92e795b2ff7129" title="Provide names for member fields of composite fields, such as comms::field::Bundle or comms::field::Bi...">COMMS_FIELD_MEMBERS_NAMES()</a> macro does exactly that when used inside the field class definition. Just inherit from the "composite" field and use the macro inside with the names for the member fields: </p><div class="fragment"><div class="line"><span class="keyword">class </span>MyField : <span class="keyword">public</span> <a class="code hl_class" href="classcomms_1_1field_1_1Bitfield.html">comms::field::Bitfield</a><...></div>
<div class="line">{</div>
<div class="line"> <span class="comment">// (Re)define base class as inner Base type, required by COMMS_FIELD_MEMBERS_NAMES()</span></div>
<div class="line"> <span class="keyword">using </span>Base = <a class="code hl_class" href="classcomms_1_1field_1_1Bitfield.html">comms::field::Bitfield</a><...>;</div>
<div class="line"><span class="keyword">public</span>:</div>
<div class="line"> <a class="code hl_define" href="Field_8h.html#af74198f06b52d3f58c92e795b2ff7129">COMMS_FIELD_MEMBERS_NAMES</a>(member1, member2, member3);</div>
<div class="line">}</div>
<div class="ttc" id="aField_8h_html_af74198f06b52d3f58c92e795b2ff7129"><div class="ttname"><a href="Field_8h.html#af74198f06b52d3f58c92e795b2ff7129">COMMS_FIELD_MEMBERS_NAMES</a></div><div class="ttdeci">#define COMMS_FIELD_MEMBERS_NAMES(...)</div><div class="ttdoc">Provide names for member fields of composite fields, such as comms::field::Bundle or comms::field::Bi...</div><div class="ttdef"><b>Definition</b> Field.h:390</div></div>
</div><!-- fragment --><p> <b>NOTE</b> that there is a required to have <b>Base</b> member type that specifies base class used.</p>
<p>Usage of the <a class="el" href="Field_8h.html#af74198f06b52d3f58c92e795b2ff7129" title="Provide names for member fields of composite fields, such as comms::field::Bundle or comms::field::Bi...">COMMS_FIELD_MEMBERS_NAMES()</a> is equivalent to having the following types and functions definitions: </p><div class="fragment"><div class="line"><span class="keyword">class </span>MyField : <span class="keyword">public</span> <a class="code hl_class" href="classcomms_1_1field_1_1Bitfield.html">comms::field::Bitfield</a><...></div>
<div class="line">{</div>
<div class="line"><span class="keyword">public</span>:</div>
<div class="line"> <span class="comment">// Access indices for member fields</span></div>
<div class="line"> <span class="keyword">enum</span> FieldIdx {</div>
<div class="line"> FieldIdx_member1,</div>
<div class="line"> FieldIdx_member2,</div>
<div class="line"> FieldIdx_member3,</div>
<div class="line"> FieldIdx_numOfValues</div>
<div class="line"> };</div>
<div class="line"> </div>
<div class="line"> <span class="comment">// Accessor to "member1" member field.</span></div>
<div class="line"> <span class="keyword">auto</span> field_member1() -> <span class="keyword">decltype</span>(std::get<FieldIdx_member1>(<a class="code hl_function" href="classcomms_1_1field_1_1Bitfield.html#a082e9e589b1bdd2a0bba8e86e828466d">value</a>()))</div>
<div class="line"> {</div>
<div class="line"> <span class="keywordflow">return</span> std::get<FieldIdx_member1>(<a class="code hl_function" href="classcomms_1_1field_1_1Bitfield.html#a082e9e589b1bdd2a0bba8e86e828466d">value</a>());</div>
<div class="line"> }</div>
<div class="line"> </div>
<div class="line"> <span class="comment">// Accessor to const "member1" member field.</span></div>
<div class="line"> <span class="keyword">auto</span> field_member1() const -> decltype(<a class="code hl_namespace" href="namespacestd.html">std</a>::get<FieldIdx_member1>(value()))</div>
<div class="line"> {</div>
<div class="line"> <span class="keywordflow">return</span> std::get<FieldIdx_member1>(<a class="code hl_function" href="classcomms_1_1field_1_1Bitfield.html#a082e9e589b1bdd2a0bba8e86e828466d">value</a>());</div>
<div class="line"> }</div>
<div class="line"> </div>
<div class="line"> <span class="comment">// Accessor to "member2" member field.</span></div>
<div class="line"> <span class="keyword">auto</span> field_member2() -> <span class="keyword">decltype</span>(std::get<FieldIdx_member2>(<a class="code hl_function" href="classcomms_1_1field_1_1Bitfield.html#a082e9e589b1bdd2a0bba8e86e828466d">value</a>()))</div>
<div class="line"> {</div>
<div class="line"> <span class="keywordflow">return</span> std::get<FieldIdx_member2>(<a class="code hl_function" href="classcomms_1_1field_1_1Bitfield.html#a082e9e589b1bdd2a0bba8e86e828466d">value</a>());</div>
<div class="line"> }</div>
<div class="line"> </div>
<div class="line"> <span class="comment">// Accessor to const "member2" member field.</span></div>
<div class="line"> <span class="keyword">auto</span> field_member2() const -> decltype(<a class="code hl_namespace" href="namespacestd.html">std</a>::get<FieldIdx_member2>(value()))</div>
<div class="line"> {</div>
<div class="line"> <span class="keywordflow">return</span> std::get<FieldIdx_member2>(<a class="code hl_function" href="classcomms_1_1field_1_1Bitfield.html#a082e9e589b1bdd2a0bba8e86e828466d">value</a>());</div>
<div class="line"> }</div>
<div class="line"> </div>
<div class="line"> <span class="comment">// Accessor to "member3" member field.</span></div>
<div class="line"> <span class="keyword">auto</span> field_member3() -> <span class="keyword">decltype</span>(std::get<FieldIdx_member2>(<a class="code hl_function" href="classcomms_1_1field_1_1Bitfield.html#a082e9e589b1bdd2a0bba8e86e828466d">value</a>()))</div>
<div class="line"> {</div>
<div class="line"> <span class="keywordflow">return</span> std::get<FieldIdx_member3>(<a class="code hl_function" href="classcomms_1_1field_1_1Bitfield.html#a082e9e589b1bdd2a0bba8e86e828466d">value</a>());</div>
<div class="line"> }</div>
<div class="line"> </div>
<div class="line"> <span class="comment">// Accessor to const "member3" member field.</span></div>
<div class="line"> <span class="keyword">auto</span> field_member2() const -> decltype(<a class="code hl_namespace" href="namespacestd.html">std</a>::get<FieldIdx_member3>(value()))</div>
<div class="line"> {</div>
<div class="line"> <span class="keywordflow">return</span> std::get<FieldIdx_member3>(<a class="code hl_function" href="classcomms_1_1field_1_1Bitfield.html#a082e9e589b1bdd2a0bba8e86e828466d">value</a>());</div>
<div class="line"> }</div>
<div class="line"> </div>
<div class="line"> <span class="comment">// Redefinition of the field types:</span></div>
<div class="line"> <span class="keyword">using </span>Field_member1 = Field1;</div>
<div class="line"> <span class="keyword">using </span>Field_member2 = Field2;</div>
<div class="line"> <span class="keyword">using </span>Field_member3 = Field3;</div>
<div class="line">};</div>
<div class="ttc" id="anamespacestd_html"><div class="ttname"><a href="namespacestd.html">std</a></div><div class="ttdoc">STL namespace.</div></div>
</div><!-- fragment --><p> <b>NOTE</b>, that provided names <b>member1</b>, <b>member2</b>, and <b>member3</b>, have found their way to the following definitions: </p><ul>
<li><b>FieldIdx</b> enum. The names are prefixed with <b>FieldIdx_</b>. The <b>FieldIdx_nameOfValues</b> value is automatically added at the end. </li>
<li>Accessor functions prefixed with <b>field_*</b> </li>
<li>Types of fields prefixed with <b>Field_*</b> </li>
</ul>
<p>See <a class="el" href="page_field_tutorial.html#sec_field_tutorial_bitfield">Bitfield Fields</a> and <a class="el" href="page_field_tutorial.html#sec_field_tutorial_bundle">Bundle Fields</a> for more examples and details </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">...</td><td>List of member fields' names. </td></tr>
</table>
</dd>
</dl>
<dl class="section note"><dt>Note</dt><dd>Defined in "comms/Field.h" </dd></dl>
</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.8
</small></address>
</body>
</html>