-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathMessageBase_8h.html
More file actions
134 lines (131 loc) · 8.88 KB
/
MessageBase_8h.html
File metadata and controls
134 lines (131 loc) · 8.88 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
<!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/MessageBase.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="#func-members">Functions</a> </div>
<div class="headertitle"><div class="title">MessageBase.h File Reference</div></div>
</div><!--header-->
<div class="contents">
<p>Provides common base class for the custom messages with default implementation.
<a href="#details">More...</a></p>
<div class="textblock"><code>#include "comms/details/detect.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 "comms/details/MessageImplBuilder.h"</code><br />
<code>#include <cstddef></code><br />
<code>#include <type_traits></code><br />
</div>
<p><a href="MessageBase_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_1MessageBase.html">comms::MessageBase< TMessage, TOptions ></a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Base class for all the custom protocol messages. <a href="classcomms_1_1MessageBase.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="func-members" name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:ade869d4b71e53aca05174f25be60257d" id="r_ade869d4b71e53aca05174f25be60257d"><td class="memTemplParams" colspan="2">template<typename T > </td></tr>
<tr class="memitem:ade869d4b71e53aca05174f25be60257d"><td class="memTemplItemLeft" align="right" valign="top">constexpr bool </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="namespacecomms.html#ade869d4b71e53aca05174f25be60257d">comms::isMessageBase</a> ()</td></tr>
<tr class="memdesc:ade869d4b71e53aca05174f25be60257d"><td class="mdescLeft"> </td><td class="mdescRight">Compile time check of of whether the type is a message extending <a class="el" href="classcomms_1_1MessageBase.html">comms::MessageBase</a>. <br /></td></tr>
<tr class="separator:ade869d4b71e53aca05174f25be60257d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a8336a21f88cf2545a13bd805ceb22576" id="r_a8336a21f88cf2545a13bd805ceb22576"><td class="memTemplParams" colspan="2"><a id="a8336a21f88cf2545a13bd805ceb22576" name="a8336a21f88cf2545a13bd805ceb22576"></a>
template<typename TMessage , typename... TOptions> </td></tr>
<tr class="memitem:a8336a21f88cf2545a13bd805ceb22576"><td class="memTemplItemLeft" align="right" valign="top">const <a class="el" href="classcomms_1_1MessageBase.html">MessageBase</a>< TMessage, TOptions... > & </td><td class="memTemplItemRight" valign="bottom"><b>comms::toMessageBase</b> (const <a class="el" href="classcomms_1_1MessageBase.html">MessageBase</a>< TMessage, TOptions... > &msg)</td></tr>
<tr class="memdesc:a8336a21f88cf2545a13bd805ceb22576"><td class="mdescLeft"> </td><td class="mdescRight">Upcast type of the message object to <a class="el" href="classcomms_1_1MessageBase.html" title="Base class for all the custom protocol messages.">comms::MessageBase</a> in order to have access to its internal types. <br /></td></tr>
<tr class="separator:a8336a21f88cf2545a13bd805ceb22576"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a338ec4710b2857c6405b293abd4a6b73" id="r_a338ec4710b2857c6405b293abd4a6b73"><td class="memTemplParams" colspan="2"><a id="a338ec4710b2857c6405b293abd4a6b73" name="a338ec4710b2857c6405b293abd4a6b73"></a>
template<typename TMessage , typename... TOptions> </td></tr>
<tr class="memitem:a338ec4710b2857c6405b293abd4a6b73"><td class="memTemplItemLeft" align="right" valign="top"><a class="el" href="classcomms_1_1MessageBase.html">MessageBase</a>< TMessage, TOptions... > & </td><td class="memTemplItemRight" valign="bottom"><b>comms::toMessageBase</b> (<a class="el" href="classcomms_1_1MessageBase.html">MessageBase</a>< TMessage, TOptions... > &msg)</td></tr>
<tr class="memdesc:a338ec4710b2857c6405b293abd4a6b73"><td class="mdescLeft"> </td><td class="mdescRight">Upcast type of the message object to <a class="el" href="classcomms_1_1MessageBase.html" title="Base class for all the custom protocol messages.">comms::MessageBase</a> in order to have access to its internal types. <br /></td></tr>
<tr class="separator:a338ec4710b2857c6405b293abd4a6b73"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Provides common base class for the custom messages with default implementation. </p>
</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>