-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathMessage_8h.html
225 lines (217 loc) · 15.6 KB
/
Message_8h.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
<!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/Message.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> |
<a href="#typedef-members">Typedefs</a> |
<a href="#func-members">Functions</a> </div>
<div class="headertitle"><div class="title">Message.h File Reference</div></div>
</div><!--header-->
<div class="contents">
<p>Contains definition of Message object interface and various base classes for custom messages.
<a href="#details">More...</a></p>
<div class="textblock"><code>#include <cstdint></code><br />
<code>#include <memory></code><br />
<code>#include <type_traits></code><br />
<code>#include "<a class="el" href="ErrorStatus_8h_source.html">comms/ErrorStatus.h</a>"</code><br />
<code>#include "<a class="el" href="Assert_8h_source.html">comms/Assert.h</a>"</code><br />
<code>#include "<a class="el" href="Field_8h_source.html">comms/Field.h</a>"</code><br />
<code>#include "<a class="el" href="type__traits_8h_source.html">comms/util/type_traits.h</a>"</code><br />
<code>#include "comms/details/MessageInterfaceBuilder.h"</code><br />
<code>#include "comms/details/transport_fields_access.h"</code><br />
<code>#include "comms/details/detect.h"</code><br />
<code>#include "comms/details/MessageIdTypeRetriever.h"</code><br />
<code>#include "comms/details/field_alias.h"</code><br />
</div>
<p><a href="Message_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_1Message.html">comms::Message< TOptions ></a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Main interface class for all the messages. <a href="classcomms_1_1Message.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:ad869d496cd7e59771fb13079970cd102" id="r_ad869d496cd7e59771fb13079970cd102"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="Message_8h.html#ad869d496cd7e59771fb13079970cd102">COMMS_MSG_TRANSPORT_FIELD_ALIAS_ACCESS_NOTEMPLATE</a>(f_, ...)   COMMS_EXPAND(COMMS_DO_ALIAS_NOTEMPLATE(transportField_, f_, __VA_ARGS__))</td></tr>
<tr class="memdesc:ad869d496cd7e59771fb13079970cd102"><td class="mdescLeft"> </td><td class="mdescRight">Generate convinience alias access member functions for extra member transport fields in non template interface classes. <br /></td></tr>
<tr class="separator:ad869d496cd7e59771fb13079970cd102"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a6fe96d7272148945853ce61572b3d4b1" id="r_a6fe96d7272148945853ce61572b3d4b1"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="Message_8h.html#a6fe96d7272148945853ce61572b3d4b1">COMMS_MSG_TRANSPORT_FIELD_ALIAS_NOTEMPLATE</a>(f_, ...)</td></tr>
<tr class="memdesc:a6fe96d7272148945853ce61572b3d4b1"><td class="mdescLeft"> </td><td class="mdescRight">Generate convinience alias access member functions and type for extra member transport fields in non template interface classes. <br /></td></tr>
<tr class="separator:a6fe96d7272148945853ce61572b3d4b1"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="typedef-members" name="typedef-members"></a>
Typedefs</h2></td></tr>
<tr class="memitem:a6e4df982066e6271a25217d483f6034b" id="r_a6e4df982066e6271a25217d483f6034b"><td class="memTemplParams" colspan="2">template<typename TMsg , typename TDefaultType = std::intmax_t> </td></tr>
<tr class="memitem:a6e4df982066e6271a25217d483f6034b"><td class="memTemplItemLeft" align="right" valign="top">using </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="namespacecomms.html#a6e4df982066e6271a25217d483f6034b">comms::MessageIdType</a> = typename comms::util::LazyDeepConditional< TMsg::InterfaceOptions::HasMsgIdType >::template Type< comms::details::MessageIdTypeRetriever, comms::util::AliasType, TDefaultType, TMsg ></td></tr>
<tr class="memdesc:a6e4df982066e6271a25217d483f6034b"><td class="mdescLeft"> </td><td class="mdescRight">Get type of message ID used by interface class. <br /></td></tr>
<tr class="separator:a6e4df982066e6271a25217d483f6034b"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="func-members" name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:a3ed34619c9153ce1e4f5243e63825cb6" id="r_a3ed34619c9153ce1e4f5243e63825cb6"><td class="memTemplParams" colspan="2">template<typename T > </td></tr>
<tr class="memitem:a3ed34619c9153ce1e4f5243e63825cb6"><td class="memTemplItemLeft" align="right" valign="top">constexpr bool </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="namespacecomms.html#a3ed34619c9153ce1e4f5243e63825cb6">comms::isMessage</a> ()</td></tr>
<tr class="memdesc:a3ed34619c9153ce1e4f5243e63825cb6"><td class="mdescLeft"> </td><td class="mdescRight">Compile time check of of whether the type is a message. <br /></td></tr>
<tr class="separator:a3ed34619c9153ce1e4f5243e63825cb6"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aa1570eb8cd769bea17115377fb10f1c8" id="r_aa1570eb8cd769bea17115377fb10f1c8"><td class="memTemplParams" colspan="2"><a id="aa1570eb8cd769bea17115377fb10f1c8" name="aa1570eb8cd769bea17115377fb10f1c8"></a>
template<typename... TOptions> </td></tr>
<tr class="memitem:aa1570eb8cd769bea17115377fb10f1c8"><td class="memTemplItemLeft" align="right" valign="top">const <a class="el" href="classcomms_1_1Message.html">Message</a>< TOptions... > & </td><td class="memTemplItemRight" valign="bottom"><b>comms::toMessage</b> (const <a class="el" href="classcomms_1_1Message.html">Message</a>< TOptions... > &msg)</td></tr>
<tr class="memdesc:aa1570eb8cd769bea17115377fb10f1c8"><td class="mdescLeft"> </td><td class="mdescRight">Upcast type of the message object to <a class="el" href="classcomms_1_1Message.html" title="Main interface class for all the messages.">comms::Message</a> in order to have access to its internal types. <br /></td></tr>
<tr class="separator:aa1570eb8cd769bea17115377fb10f1c8"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ae8e6a06142a4a0684fa58bc780c9fb8a" id="r_ae8e6a06142a4a0684fa58bc780c9fb8a"><td class="memTemplParams" colspan="2"><a id="ae8e6a06142a4a0684fa58bc780c9fb8a" name="ae8e6a06142a4a0684fa58bc780c9fb8a"></a>
template<typename... TOptions> </td></tr>
<tr class="memitem:ae8e6a06142a4a0684fa58bc780c9fb8a"><td class="memTemplItemLeft" align="right" valign="top"><a class="el" href="classcomms_1_1Message.html">Message</a>< TOptions... > & </td><td class="memTemplItemRight" valign="bottom"><b>comms::toMessage</b> (<a class="el" href="classcomms_1_1Message.html">Message</a>< TOptions... > &msg)</td></tr>
<tr class="memdesc:ae8e6a06142a4a0684fa58bc780c9fb8a"><td class="mdescLeft"> </td><td class="mdescRight">Upcast type of the message object to <a class="el" href="classcomms_1_1Message.html" title="Main interface class for all the messages.">comms::Message</a> in order to have access to its internal types. <br /></td></tr>
<tr class="separator:ae8e6a06142a4a0684fa58bc780c9fb8a"><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 Message object interface and various base classes for custom messages. </p>
</div><h2 class="groupheader">Macro Definition Documentation</h2>
<a id="ad869d496cd7e59771fb13079970cd102" name="ad869d496cd7e59771fb13079970cd102"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad869d496cd7e59771fb13079970cd102">◆ </a></span>COMMS_MSG_TRANSPORT_FIELD_ALIAS_ACCESS_NOTEMPLATE</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define COMMS_MSG_TRANSPORT_FIELD_ALIAS_ACCESS_NOTEMPLATE</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_EXPAND(COMMS_DO_ALIAS_NOTEMPLATE(transportField_, f_, __VA_ARGS__))</td>
</tr>
</table>
</div><div class="memdoc">
<p>Generate convinience alias access member functions for extra member transport fields in non template interface classes. </p>
<p>Similar to COMMS_MSG_TRANSPORT_FIELD_ALIAS, but needs to be used in <b>non-template</b> interface class to allow compilation with gcc-4.8 </p><dl class="section see"><dt>See also</dt><dd>COMMS_MSG_TRANSPORT_FIELD_ALIAS_ACCESS() </dd></dl>
<dl class="section note"><dt>Note</dt><dd>Defined in "comms/Message.h" </dd></dl>
</div>
</div>
<a id="a6fe96d7272148945853ce61572b3d4b1" name="a6fe96d7272148945853ce61572b3d4b1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6fe96d7272148945853ce61572b3d4b1">◆ </a></span>COMMS_MSG_TRANSPORT_FIELD_ALIAS_NOTEMPLATE</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define COMMS_MSG_TRANSPORT_FIELD_ALIAS_NOTEMPLATE</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></td>
</tr>
</table>
</div><div class="memdoc">
<b>Value:</b><div class="fragment"><div class="line"> COMMS_EXPAND(<a class="code hl_define" href="Message_8h.html#ad869d496cd7e59771fb13079970cd102">COMMS_MSG_TRANSPORT_FIELD_ALIAS_ACCESS_NOTEMPLATE</a>(f_, __VA_ARGS__)) \</div>
<div class="line"> COMMS_EXPAND(COMMS_DO_ALIAS_TYPEDEF(TransportField_, f_, __VA_ARGS__))</div>
<div class="ttc" id="aMessage_8h_html_ad869d496cd7e59771fb13079970cd102"><div class="ttname"><a href="Message_8h.html#ad869d496cd7e59771fb13079970cd102">COMMS_MSG_TRANSPORT_FIELD_ALIAS_ACCESS_NOTEMPLATE</a></div><div class="ttdeci">#define COMMS_MSG_TRANSPORT_FIELD_ALIAS_ACCESS_NOTEMPLATE(f_,...)</div><div class="ttdoc">Generate convinience alias access member functions for extra member transport fields in non template ...</div><div class="ttdef"><b>Definition</b> Message.h:742</div></div>
</div><!-- fragment -->
<p>Generate convinience alias access member functions and type for extra member transport fields in non template interface classes. </p>
<p>Similar to COMMS_MSG_TRANSPORT_FIELD_ALIAS(), but needs to be used in <b>non-template</b> interface class to allow compilation with gcc-4.8 </p><dl class="section see"><dt>See also</dt><dd>COMMS_MSG_TRANSPORT_FIELD_ALIAS() </dd></dl>
<dl class="section note"><dt>Note</dt><dd>Defined in "comms/Message.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>