-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathMsgFactory_8h_source.html
247 lines (245 loc) · 33.7 KB
/
MsgFactory_8h_source.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
<!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/MsgFactory.h Source File</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>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
$(document).ready(function() { init_codefold(0); });
/* @license-end */
</script>
<!-- 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="headertitle"><div class="title">MsgFactory.h</div></div>
</div><!--header-->
<div class="contents">
<a href="MsgFactory_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a id="l00001" name="l00001"></a><span class="lineno"> 1</span><span class="comment">//</span></div>
<div class="line"><a id="l00002" name="l00002"></a><span class="lineno"> 2</span><span class="comment">// Copyright 2015 - 2025 (C). Alex Robenko. All rights reserved.</span></div>
<div class="line"><a id="l00003" name="l00003"></a><span class="lineno"> 3</span><span class="comment">//</span></div>
<div class="line"><a id="l00004" name="l00004"></a><span class="lineno"> 4</span><span class="comment">// This Source Code Form is subject to the terms of the Mozilla Public</span></div>
<div class="line"><a id="l00005" name="l00005"></a><span class="lineno"> 5</span><span class="comment">// License, v. 2.0. If a copy of the MPL was not distributed with this</span></div>
<div class="line"><a id="l00006" name="l00006"></a><span class="lineno"> 6</span><span class="comment">// file, You can obtain one at http://mozilla.org/MPL/2.0/.</span></div>
<div class="line"><a id="l00007" name="l00007"></a><span class="lineno"> 7</span> </div>
<div class="line"><a id="l00010" name="l00010"></a><span class="lineno"> 10</span> </div>
<div class="line"><a id="l00011" name="l00011"></a><span class="lineno"> 11</span><span class="preprocessor">#pragma once</span></div>
<div class="line"><a id="l00012" name="l00012"></a><span class="lineno"> 12</span> </div>
<div class="line"><a id="l00013" name="l00013"></a><span class="lineno"> 13</span><span class="preprocessor">#include <type_traits></span></div>
<div class="line"><a id="l00014" name="l00014"></a><span class="lineno"> 14</span><span class="preprocessor">#include <algorithm></span></div>
<div class="line"><a id="l00015" name="l00015"></a><span class="lineno"> 15</span> </div>
<div class="line"><a id="l00016" name="l00016"></a><span class="lineno"> 16</span><span class="preprocessor">#include "<a class="code" href="Assert_8h.html">comms/Assert.h</a>"</span></div>
<div class="line"><a id="l00017" name="l00017"></a><span class="lineno"> 17</span><span class="preprocessor">#include "<a class="code" href="MsgFactoryCreateFailureReason_8h.html">comms/MsgFactoryCreateFailureReason.h</a>"</span></div>
<div class="line"><a id="l00018" name="l00018"></a><span class="lineno"> 18</span><span class="preprocessor">#include "<a class="code" href="Tuple_8h.html">comms/util/Tuple.h</a>"</span></div>
<div class="line"><a id="l00019" name="l00019"></a><span class="lineno"> 19</span><span class="preprocessor">#include "<a class="code" href="alloc_8h.html">comms/util/alloc.h</a>"</span></div>
<div class="line"><a id="l00020" name="l00020"></a><span class="lineno"> 20</span><span class="preprocessor">#include "details/MsgFactoryOptionsParser.h"</span></div>
<div class="line"><a id="l00021" name="l00021"></a><span class="lineno"> 21</span><span class="preprocessor">#include "details/MsgFactoryBase.h"</span></div>
<div class="line"><a id="l00022" name="l00022"></a><span class="lineno"> 22</span> </div>
<div class="line"><a id="l00023" name="l00023"></a><span class="lineno"> 23</span><span class="keyword">namespace </span><a class="code hl_namespace" href="namespacecomms.html">comms</a></div>
<div class="line"><a id="l00024" name="l00024"></a><span class="lineno"> 24</span>{</div>
<div class="line"><a id="l00025" name="l00025"></a><span class="lineno"> 25</span> </div>
<div class="line"><a id="l00085" name="l00085"></a><span class="lineno"> 85</span><span class="keyword">template</span> <<span class="keyword">typename</span> TMsgBase, <span class="keyword">typename</span> TAllMessages, <span class="keyword">typename</span>... TOptions></div>
<div class="foldopen" id="foldopen00086" data-start="{" data-end="};">
<div class="line"><a id="l00086" name="l00086"></a><span class="lineno"><a class="line" href="classcomms_1_1MsgFactory.html"> 86</a></span><span class="keyword">class </span><a class="code hl_class" href="classcomms_1_1MsgFactory.html">MsgFactory</a> : <span class="keyword">private</span> details::MsgFactoryBase<TMsgBase, TAllMessages, TOptions...></div>
<div class="line"><a id="l00087" name="l00087"></a><span class="lineno"> 87</span>{</div>
<div class="line"><a id="l00088" name="l00088"></a><span class="lineno"> 88</span> <span class="keyword">using </span>Base = details::MsgFactoryBase<TMsgBase, TAllMessages, TOptions...>;</div>
<div class="line"><a id="l00089" name="l00089"></a><span class="lineno"> 89</span> <span class="keyword">static_assert</span>(TMsgBase::hasMsgIdType(),</div>
<div class="line"><a id="l00090" name="l00090"></a><span class="lineno"> 90</span> <span class="stringliteral">"Usage of MsgFactory requires Message interface to provide ID type. "</span></div>
<div class="line"><a id="l00091" name="l00091"></a><span class="lineno"> 91</span> <span class="stringliteral">"Use comms::option::def::MsgIdType option in message interface type definition."</span>);</div>
<div class="line"><a id="l00092" name="l00092"></a><span class="lineno"> 92</span> </div>
<div class="line"><a id="l00093" name="l00093"></a><span class="lineno"> 93</span><span class="keyword">public</span>:</div>
<div class="line"><a id="l00095" name="l00095"></a><span class="lineno"><a class="line" href="classcomms_1_1MsgFactory.html#a610d36f974687e689c1bf3e3a0339eea"> 95</a></span> <span class="keyword">using </span><a class="code hl_typedef" href="classcomms_1_1MsgFactory.html#a610d36f974687e689c1bf3e3a0339eea">ParsedOptions</a> = <span class="keyword">typename</span> Base::ParsedOptions;</div>
<div class="line"><a id="l00096" name="l00096"></a><span class="lineno"> 96</span> </div>
<div class="line"><a id="l00098" name="l00098"></a><span class="lineno"><a class="line" href="classcomms_1_1MsgFactory.html#a9752974bea52f5c1d0da9baccca19c08"> 98</a></span> <span class="keyword">using </span><a class="code hl_typedef" href="classcomms_1_1MsgFactory.html#a9752974bea52f5c1d0da9baccca19c08">Message</a> = <span class="keyword">typename</span> Base::Message;</div>
<div class="line"><a id="l00099" name="l00099"></a><span class="lineno"> 99</span> </div>
<div class="line"><a id="l00101" name="l00101"></a><span class="lineno"><a class="line" href="classcomms_1_1MsgFactory.html#aabfb76e2cf3661edb7741d0a926d2da0"> 101</a></span> <span class="keyword">using </span><a class="code hl_typedef" href="classcomms_1_1MsgFactory.html#aabfb76e2cf3661edb7741d0a926d2da0">MsgIdParamType</a> = <span class="keyword">typename</span> Base::MsgIdParamType;</div>
<div class="line"><a id="l00102" name="l00102"></a><span class="lineno"> 102</span> </div>
<div class="line"><a id="l00104" name="l00104"></a><span class="lineno"><a class="line" href="classcomms_1_1MsgFactory.html#a1005da310eff2117edb16b92fd2dbb88"> 104</a></span> <span class="keyword">using </span><a class="code hl_typedef" href="classcomms_1_1MsgFactory.html#a1005da310eff2117edb16b92fd2dbb88">MsgIdType</a> = <span class="keyword">typename</span> Base::MsgIdType;</div>
<div class="line"><a id="l00105" name="l00105"></a><span class="lineno"> 105</span> </div>
<div class="line"><a id="l00109" name="l00109"></a><span class="lineno"><a class="line" href="classcomms_1_1MsgFactory.html#adfa8fb1cd206c2fd25a97bd0a4e57cd7"> 109</a></span> <span class="keyword">using </span><a class="code hl_typedef" href="classcomms_1_1MsgFactory.html#adfa8fb1cd206c2fd25a97bd0a4e57cd7">MsgPtr</a> = <span class="keyword">typename</span> Base::MsgPtr;</div>
<div class="line"><a id="l00110" name="l00110"></a><span class="lineno"> 110</span> </div>
<div class="line"><a id="l00112" name="l00112"></a><span class="lineno"><a class="line" href="classcomms_1_1MsgFactory.html#a9bfccfddae66f917b11dc8ca05128402"> 112</a></span> <span class="keyword">using </span><a class="code hl_typedef" href="classcomms_1_1MsgFactory.html#a9bfccfddae66f917b11dc8ca05128402">AllMessages</a> = <span class="keyword">typename</span> Base::AllMessages;</div>
<div class="line"><a id="l00113" name="l00113"></a><span class="lineno"> 113</span> </div>
<div class="line"><a id="l00115" name="l00115"></a><span class="lineno"><a class="line" href="classcomms_1_1MsgFactory.html#a47061c6e65f4aeba36b2b3d833700f5f"> 115</a></span> <span class="keyword">using </span><a class="code hl_enumeration" href="namespacecomms.html#af61c1bae7a9edbfb7928fc2aed04c55c">CreateFailureReason</a> = <a class="code hl_enumeration" href="namespacecomms.html#af61c1bae7a9edbfb7928fc2aed04c55c">MsgFactoryCreateFailureReason</a>;</div>
<div class="line"><a id="l00116" name="l00116"></a><span class="lineno"> 116</span> </div>
<div class="line"><a id="l00119" name="l00119"></a><span class="lineno"><a class="line" href="classcomms_1_1MsgFactory.html#a908101d7ea919a5b491ffdcc1d5c8ddb"> 119</a></span> <span class="keyword">using </span><a class="code hl_typedef" href="classcomms_1_1MsgFactory.html#a908101d7ea919a5b491ffdcc1d5c8ddb">GenericMessage</a> = <span class="keyword">typename</span> ParsedOptions::GenericMessage;</div>
<div class="line"><a id="l00120" name="l00120"></a><span class="lineno"> 120</span> </div>
<div class="foldopen" id="foldopen00138" data-start="{" data-end="}">
<div class="line"><a id="l00138" name="l00138"></a><span class="lineno"><a class="line" href="classcomms_1_1MsgFactory.html#a5b1ad877b2b4c26ed0e64675e0b245d3"> 138</a></span> <a class="code hl_typedef" href="classcomms_1_1MsgFactory.html#adfa8fb1cd206c2fd25a97bd0a4e57cd7">MsgPtr</a> <a class="code hl_function" href="classcomms_1_1MsgFactory.html#a5b1ad877b2b4c26ed0e64675e0b245d3">createMsg</a>(<a class="code hl_typedef" href="classcomms_1_1MsgFactory.html#aabfb76e2cf3661edb7741d0a926d2da0">MsgIdParamType</a> <span class="keywordtype">id</span>, <span class="keywordtype">unsigned</span> idx = 0U, <a class="code hl_enumeration" href="namespacecomms.html#af61c1bae7a9edbfb7928fc2aed04c55c">CreateFailureReason</a>* reason = <span class="keyword">nullptr</span>)<span class="keyword"> const</span></div>
<div class="line"><a id="l00139" name="l00139"></a><span class="lineno"> 139</span><span class="keyword"> </span>{</div>
<div class="line"><a id="l00140" name="l00140"></a><span class="lineno"> 140</span> <span class="keywordflow">return</span> Base::createMsg(<span class="keywordtype">id</span>, idx, reason);</div>
<div class="line"><a id="l00141" name="l00141"></a><span class="lineno"> 141</span> }</div>
</div>
<div class="line"><a id="l00142" name="l00142"></a><span class="lineno"> 142</span> </div>
<div class="foldopen" id="foldopen00155" data-start="{" data-end="}">
<div class="line"><a id="l00155" name="l00155"></a><span class="lineno"><a class="line" href="classcomms_1_1MsgFactory.html#a8c818022da2e8efbf3fd715951cc5c1b"> 155</a></span> <a class="code hl_typedef" href="classcomms_1_1MsgFactory.html#adfa8fb1cd206c2fd25a97bd0a4e57cd7">MsgPtr</a> <a class="code hl_function" href="classcomms_1_1MsgFactory.html#a8c818022da2e8efbf3fd715951cc5c1b">createGenericMsg</a>(<a class="code hl_typedef" href="classcomms_1_1MsgFactory.html#aabfb76e2cf3661edb7741d0a926d2da0">MsgIdParamType</a> <span class="keywordtype">id</span>, <span class="keywordtype">unsigned</span> idx = 0U)<span class="keyword"> const</span></div>
<div class="line"><a id="l00156" name="l00156"></a><span class="lineno"> 156</span><span class="keyword"> </span>{</div>
<div class="line"><a id="l00157" name="l00157"></a><span class="lineno"> 157</span> <span class="keywordflow">return</span> Base::createGenericMsg(<span class="keywordtype">id</span>, idx);</div>
<div class="line"><a id="l00158" name="l00158"></a><span class="lineno"> 158</span> }</div>
</div>
<div class="line"><a id="l00159" name="l00159"></a><span class="lineno"> 159</span> </div>
<div class="foldopen" id="foldopen00161" data-start="{" data-end="}">
<div class="line"><a id="l00161" name="l00161"></a><span class="lineno"><a class="line" href="classcomms_1_1MsgFactory.html#a131a0770e85ceafb405fcf5cbfcb06be"> 161</a></span> <span class="keywordtype">bool</span> <a class="code hl_function" href="classcomms_1_1MsgFactory.html#a131a0770e85ceafb405fcf5cbfcb06be">canAllocate</a>()<span class="keyword"> const</span></div>
<div class="line"><a id="l00162" name="l00162"></a><span class="lineno"> 162</span><span class="keyword"> </span>{</div>
<div class="line"><a id="l00163" name="l00163"></a><span class="lineno"> 163</span> <span class="keywordflow">return</span> Base::canAllocate();</div>
<div class="line"><a id="l00164" name="l00164"></a><span class="lineno"> 164</span> }</div>
</div>
<div class="line"><a id="l00165" name="l00165"></a><span class="lineno"> 165</span> </div>
<div class="foldopen" id="foldopen00169" data-start="{" data-end="}">
<div class="line"><a id="l00169" name="l00169"></a><span class="lineno"><a class="line" href="classcomms_1_1MsgFactory.html#a4b48fb5d596981572ccbaff84cc7d1af"> 169</a></span> std::size_t <a class="code hl_function" href="classcomms_1_1MsgFactory.html#a4b48fb5d596981572ccbaff84cc7d1af">msgCount</a>(<a class="code hl_typedef" href="classcomms_1_1MsgFactory.html#aabfb76e2cf3661edb7741d0a926d2da0">MsgIdParamType</a> <span class="keywordtype">id</span>)<span class="keyword"> const</span></div>
<div class="line"><a id="l00170" name="l00170"></a><span class="lineno"> 170</span><span class="keyword"> </span>{</div>
<div class="line"><a id="l00171" name="l00171"></a><span class="lineno"> 171</span> <span class="keywordflow">return</span> Base::msgCount(<span class="keywordtype">id</span>);</div>
<div class="line"><a id="l00172" name="l00172"></a><span class="lineno"> 172</span> }</div>
</div>
<div class="line"><a id="l00173" name="l00173"></a><span class="lineno"> 173</span> </div>
<div class="foldopen" id="foldopen00176" data-start="{" data-end="}">
<div class="line"><a id="l00176" name="l00176"></a><span class="lineno"><a class="line" href="classcomms_1_1MsgFactory.html#a845efd38ef0e7ecf3069c7912f44032f"> 176</a></span> <span class="keyword">static</span> <span class="keyword">constexpr</span> <span class="keywordtype">bool</span> <a class="code hl_function" href="classcomms_1_1MsgFactory.html#a845efd38ef0e7ecf3069c7912f44032f">hasUniqueIds</a>()</div>
<div class="line"><a id="l00177" name="l00177"></a><span class="lineno"> 177</span> {</div>
<div class="line"><a id="l00178" name="l00178"></a><span class="lineno"> 178</span> <span class="keywordflow">return</span> Base::hasUniqueIds();</div>
<div class="line"><a id="l00179" name="l00179"></a><span class="lineno"> 179</span> }</div>
</div>
<div class="line"><a id="l00180" name="l00180"></a><span class="lineno"> 180</span> </div>
<div class="foldopen" id="foldopen00186" data-start="{" data-end="}">
<div class="line"><a id="l00186" name="l00186"></a><span class="lineno"><a class="line" href="classcomms_1_1MsgFactory.html#ac18168c1dad7c06c2cee17e04e6bd611"> 186</a></span> <span class="keyword">static</span> <span class="keyword">constexpr</span> <span class="keywordtype">bool</span> <a class="code hl_function" href="classcomms_1_1MsgFactory.html#ac18168c1dad7c06c2cee17e04e6bd611">isDispatchPolymorphic</a>()</div>
<div class="line"><a id="l00187" name="l00187"></a><span class="lineno"> 187</span> {</div>
<div class="line"><a id="l00188" name="l00188"></a><span class="lineno"> 188</span> <span class="keywordflow">return</span> Base::isDispatchPolymorphic();</div>
<div class="line"><a id="l00189" name="l00189"></a><span class="lineno"> 189</span> }</div>
</div>
<div class="line"><a id="l00190" name="l00190"></a><span class="lineno"> 190</span> </div>
<div class="foldopen" id="foldopen00196" data-start="{" data-end="}">
<div class="line"><a id="l00196" name="l00196"></a><span class="lineno"><a class="line" href="classcomms_1_1MsgFactory.html#a44b9375c3b500011e2a4045b1e84ba16"> 196</a></span> <span class="keyword">static</span> <span class="keyword">constexpr</span> <span class="keywordtype">bool</span> <a class="code hl_function" href="classcomms_1_1MsgFactory.html#a44b9375c3b500011e2a4045b1e84ba16">isDispatchStaticBinSearch</a>()</div>
<div class="line"><a id="l00197" name="l00197"></a><span class="lineno"> 197</span> {</div>
<div class="line"><a id="l00198" name="l00198"></a><span class="lineno"> 198</span> <span class="keywordflow">return</span> Base::isDispatchStaticBinSearch();</div>
<div class="line"><a id="l00199" name="l00199"></a><span class="lineno"> 199</span> }</div>
</div>
<div class="line"><a id="l00200" name="l00200"></a><span class="lineno"> 200</span> </div>
<div class="foldopen" id="foldopen00206" data-start="{" data-end="}">
<div class="line"><a id="l00206" name="l00206"></a><span class="lineno"><a class="line" href="classcomms_1_1MsgFactory.html#a583aa46c2595202c6e281bb4960e6664"> 206</a></span> <span class="keyword">static</span> <span class="keyword">constexpr</span> <span class="keywordtype">bool</span> <a class="code hl_function" href="classcomms_1_1MsgFactory.html#a583aa46c2595202c6e281bb4960e6664">isDispatchLinearSwitch</a>()</div>
<div class="line"><a id="l00207" name="l00207"></a><span class="lineno"> 207</span> {</div>
<div class="line"><a id="l00208" name="l00208"></a><span class="lineno"> 208</span> <span class="keywordflow">return</span> Base::isDispatchLinearSwitch();</div>
<div class="line"><a id="l00209" name="l00209"></a><span class="lineno"> 209</span> }</div>
</div>
<div class="line"><a id="l00210" name="l00210"></a><span class="lineno"> 210</span> </div>
<div class="foldopen" id="foldopen00213" data-start="{" data-end="}">
<div class="line"><a id="l00213" name="l00213"></a><span class="lineno"><a class="line" href="classcomms_1_1MsgFactory.html#a89a3821a454a302aee62b1495e659190"> 213</a></span> <span class="keyword">static</span> <span class="keyword">constexpr</span> <span class="keywordtype">bool</span> <a class="code hl_function" href="classcomms_1_1MsgFactory.html#a89a3821a454a302aee62b1495e659190">hasInPlaceAllocation</a>()</div>
<div class="line"><a id="l00214" name="l00214"></a><span class="lineno"> 214</span> {</div>
<div class="line"><a id="l00215" name="l00215"></a><span class="lineno"> 215</span> <span class="keywordflow">return</span> ParsedOptions::HasInPlaceAllocation;</div>
<div class="line"><a id="l00216" name="l00216"></a><span class="lineno"> 216</span> }</div>
</div>
<div class="line"><a id="l00217" name="l00217"></a><span class="lineno"> 217</span> </div>
<div class="foldopen" id="foldopen00219" data-start="{" data-end="}">
<div class="line"><a id="l00219" name="l00219"></a><span class="lineno"><a class="line" href="classcomms_1_1MsgFactory.html#a31d6213bd0c8308f204f8b9979a54d4d"> 219</a></span> <span class="keyword">static</span> <span class="keyword">constexpr</span> <span class="keywordtype">bool</span> <a class="code hl_function" href="classcomms_1_1MsgFactory.html#a31d6213bd0c8308f204f8b9979a54d4d">hasGenericMessageSupport</a>()</div>
<div class="line"><a id="l00220" name="l00220"></a><span class="lineno"> 220</span> {</div>
<div class="line"><a id="l00221" name="l00221"></a><span class="lineno"> 221</span> <span class="keywordflow">return</span> ParsedOptions::HasSupportGenericMessage;</div>
<div class="line"><a id="l00222" name="l00222"></a><span class="lineno"> 222</span> }</div>
</div>
<div class="line"><a id="l00223" name="l00223"></a><span class="lineno"> 223</span> </div>
<div class="foldopen" id="foldopen00225" data-start="{" data-end="}">
<div class="line"><a id="l00225" name="l00225"></a><span class="lineno"><a class="line" href="classcomms_1_1MsgFactory.html#a9676173201c4c845c8be1dba6711eb94"> 225</a></span> <span class="keyword">static</span> <span class="keyword">constexpr</span> <span class="keywordtype">bool</span> <a class="code hl_function" href="classcomms_1_1MsgFactory.html#a9676173201c4c845c8be1dba6711eb94">hasForcedDispatch</a>()</div>
<div class="line"><a id="l00226" name="l00226"></a><span class="lineno"> 226</span> {</div>
<div class="line"><a id="l00227" name="l00227"></a><span class="lineno"> 227</span> <span class="keywordflow">return</span> ParsedOptions::HasForcedDispatch;</div>
<div class="line"><a id="l00228" name="l00228"></a><span class="lineno"> 228</span> } </div>
</div>
<div class="line"><a id="l00229" name="l00229"></a><span class="lineno"> 229</span>};</div>
</div>
<div class="line"><a id="l00230" name="l00230"></a><span class="lineno"> 230</span> </div>
<div class="line"><a id="l00231" name="l00231"></a><span class="lineno"> 231</span> </div>
<div class="line"><a id="l00232" name="l00232"></a><span class="lineno"> 232</span>} <span class="comment">// namespace comms</span></div>
<div class="line"><a id="l00233" name="l00233"></a><span class="lineno"> 233</span> </div>
<div class="ttc" id="aAssert_8h_html"><div class="ttname"><a href="Assert_8h.html">Assert.h</a></div><div class="ttdoc">This file contains classes required for generic custom assertion functionality.</div></div>
<div class="ttc" id="aMsgFactoryCreateFailureReason_8h_html"><div class="ttname"><a href="MsgFactoryCreateFailureReason_8h.html">MsgFactoryCreateFailureReason.h</a></div><div class="ttdoc">Contains definition of comms::MsgFactoryCreateFailureReason enum.</div></div>
<div class="ttc" id="aTuple_8h_html"><div class="ttname"><a href="Tuple_8h.html">Tuple.h</a></div><div class="ttdoc">Contains various tuple type manipulation classes and functions.</div></div>
<div class="ttc" id="aalloc_8h_html"><div class="ttname"><a href="alloc_8h.html">alloc.h</a></div><div class="ttdoc">This file contains various generic allocator classes that may be used to allocate objects using dynam...</div></div>
<div class="ttc" id="aclasscomms_1_1MsgFactory_html"><div class="ttname"><a href="classcomms_1_1MsgFactory.html">comms::MsgFactory</a></div><div class="ttdoc">Message factory class.</div><div class="ttdef"><b>Definition</b> MsgFactory.h:87</div></div>
<div class="ttc" id="aclasscomms_1_1MsgFactory_html_a1005da310eff2117edb16b92fd2dbb88"><div class="ttname"><a href="classcomms_1_1MsgFactory.html#a1005da310eff2117edb16b92fd2dbb88">comms::MsgFactory::MsgIdType</a></div><div class="ttdeci">typename Base::MsgIdType MsgIdType</div><div class="ttdoc">Type of the message ID.</div><div class="ttdef"><b>Definition</b> MsgFactory.h:104</div></div>
<div class="ttc" id="aclasscomms_1_1MsgFactory_html_a131a0770e85ceafb405fcf5cbfcb06be"><div class="ttname"><a href="classcomms_1_1MsgFactory.html#a131a0770e85ceafb405fcf5cbfcb06be">comms::MsgFactory::canAllocate</a></div><div class="ttdeci">bool canAllocate() const</div><div class="ttdoc">Inquiry whether allocation is possible.</div><div class="ttdef"><b>Definition</b> MsgFactory.h:161</div></div>
<div class="ttc" id="aclasscomms_1_1MsgFactory_html_a31d6213bd0c8308f204f8b9979a54d4d"><div class="ttname"><a href="classcomms_1_1MsgFactory.html#a31d6213bd0c8308f204f8b9979a54d4d">comms::MsgFactory::hasGenericMessageSupport</a></div><div class="ttdeci">static constexpr bool hasGenericMessageSupport()</div><div class="ttdoc">Compile time inquiry whether factory supports comms::GenericMessage allocation.</div><div class="ttdef"><b>Definition</b> MsgFactory.h:219</div></div>
<div class="ttc" id="aclasscomms_1_1MsgFactory_html_a44b9375c3b500011e2a4045b1e84ba16"><div class="ttname"><a href="classcomms_1_1MsgFactory.html#a44b9375c3b500011e2a4045b1e84ba16">comms::MsgFactory::isDispatchStaticBinSearch</a></div><div class="ttdeci">static constexpr bool isDispatchStaticBinSearch()</div><div class="ttdoc">Compile time inquiry whether static binary search dispatch is generated internally to map message ID ...</div><div class="ttdef"><b>Definition</b> MsgFactory.h:196</div></div>
<div class="ttc" id="aclasscomms_1_1MsgFactory_html_a4b48fb5d596981572ccbaff84cc7d1af"><div class="ttname"><a href="classcomms_1_1MsgFactory.html#a4b48fb5d596981572ccbaff84cc7d1af">comms::MsgFactory::msgCount</a></div><div class="ttdeci">std::size_t msgCount(MsgIdParamType id) const</div><div class="ttdoc">Get number of message types from AllMessages, that have the specified ID.</div><div class="ttdef"><b>Definition</b> MsgFactory.h:169</div></div>
<div class="ttc" id="aclasscomms_1_1MsgFactory_html_a583aa46c2595202c6e281bb4960e6664"><div class="ttname"><a href="classcomms_1_1MsgFactory.html#a583aa46c2595202c6e281bb4960e6664">comms::MsgFactory::isDispatchLinearSwitch</a></div><div class="ttdeci">static constexpr bool isDispatchLinearSwitch()</div><div class="ttdoc">Compile time inquiry whether linear switch dispatch is generated internally to map message ID to actu...</div><div class="ttdef"><b>Definition</b> MsgFactory.h:206</div></div>
<div class="ttc" id="aclasscomms_1_1MsgFactory_html_a5b1ad877b2b4c26ed0e64675e0b245d3"><div class="ttname"><a href="classcomms_1_1MsgFactory.html#a5b1ad877b2b4c26ed0e64675e0b245d3">comms::MsgFactory::createMsg</a></div><div class="ttdeci">MsgPtr createMsg(MsgIdParamType id, unsigned idx=0U, CreateFailureReason *reason=nullptr) const</div><div class="ttdoc">Create message object given the ID of the message.</div><div class="ttdef"><b>Definition</b> MsgFactory.h:138</div></div>
<div class="ttc" id="aclasscomms_1_1MsgFactory_html_a610d36f974687e689c1bf3e3a0339eea"><div class="ttname"><a href="classcomms_1_1MsgFactory.html#a610d36f974687e689c1bf3e3a0339eea">comms::MsgFactory::ParsedOptions</a></div><div class="ttdeci">typename Base::ParsedOptions ParsedOptions</div><div class="ttdoc">Parsed options.</div><div class="ttdef"><b>Definition</b> MsgFactory.h:95</div></div>
<div class="ttc" id="aclasscomms_1_1MsgFactory_html_a845efd38ef0e7ecf3069c7912f44032f"><div class="ttname"><a href="classcomms_1_1MsgFactory.html#a845efd38ef0e7ecf3069c7912f44032f">comms::MsgFactory::hasUniqueIds</a></div><div class="ttdeci">static constexpr bool hasUniqueIds()</div><div class="ttdoc">Compile time inquiry whether all the message classes in the TAllMessages bundle have unique IDs.</div><div class="ttdef"><b>Definition</b> MsgFactory.h:176</div></div>
<div class="ttc" id="aclasscomms_1_1MsgFactory_html_a89a3821a454a302aee62b1495e659190"><div class="ttname"><a href="classcomms_1_1MsgFactory.html#a89a3821a454a302aee62b1495e659190">comms::MsgFactory::hasInPlaceAllocation</a></div><div class="ttdeci">static constexpr bool hasInPlaceAllocation()</div><div class="ttdoc">Compile time inquiry whether factory supports in-place allocation.</div><div class="ttdef"><b>Definition</b> MsgFactory.h:213</div></div>
<div class="ttc" id="aclasscomms_1_1MsgFactory_html_a8c818022da2e8efbf3fd715951cc5c1b"><div class="ttname"><a href="classcomms_1_1MsgFactory.html#a8c818022da2e8efbf3fd715951cc5c1b">comms::MsgFactory::createGenericMsg</a></div><div class="ttdeci">MsgPtr createGenericMsg(MsgIdParamType id, unsigned idx=0U) const</div><div class="ttdoc">Allocate and initialise comms::GenericMessage object.</div><div class="ttdef"><b>Definition</b> MsgFactory.h:155</div></div>
<div class="ttc" id="aclasscomms_1_1MsgFactory_html_a908101d7ea919a5b491ffdcc1d5c8ddb"><div class="ttname"><a href="classcomms_1_1MsgFactory.html#a908101d7ea919a5b491ffdcc1d5c8ddb">comms::MsgFactory::GenericMessage</a></div><div class="ttdeci">typename ParsedOptions::GenericMessage GenericMessage</div><div class="ttdoc">type of generic message.</div><div class="ttdef"><b>Definition</b> MsgFactory.h:119</div></div>
<div class="ttc" id="aclasscomms_1_1MsgFactory_html_a9676173201c4c845c8be1dba6711eb94"><div class="ttname"><a href="classcomms_1_1MsgFactory.html#a9676173201c4c845c8be1dba6711eb94">comms::MsgFactory::hasForcedDispatch</a></div><div class="ttdeci">static constexpr bool hasForcedDispatch()</div><div class="ttdoc">Compile time inquiry whether factory has forced dispatch method.</div><div class="ttdef"><b>Definition</b> MsgFactory.h:225</div></div>
<div class="ttc" id="aclasscomms_1_1MsgFactory_html_a9752974bea52f5c1d0da9baccca19c08"><div class="ttname"><a href="classcomms_1_1MsgFactory.html#a9752974bea52f5c1d0da9baccca19c08">comms::MsgFactory::Message</a></div><div class="ttdeci">typename Base::Message Message</div><div class="ttdoc">Type of the common base class of all the messages.</div><div class="ttdef"><b>Definition</b> MsgFactory.h:98</div></div>
<div class="ttc" id="aclasscomms_1_1MsgFactory_html_a9bfccfddae66f917b11dc8ca05128402"><div class="ttname"><a href="classcomms_1_1MsgFactory.html#a9bfccfddae66f917b11dc8ca05128402">comms::MsgFactory::AllMessages</a></div><div class="ttdeci">typename Base::AllMessages AllMessages</div><div class="ttdoc">All messages provided as template parameter to this class.</div><div class="ttdef"><b>Definition</b> MsgFactory.h:112</div></div>
<div class="ttc" id="aclasscomms_1_1MsgFactory_html_aabfb76e2cf3661edb7741d0a926d2da0"><div class="ttname"><a href="classcomms_1_1MsgFactory.html#aabfb76e2cf3661edb7741d0a926d2da0">comms::MsgFactory::MsgIdParamType</a></div><div class="ttdeci">typename Base::MsgIdParamType MsgIdParamType</div><div class="ttdoc">Type of the message ID when passed as a parameter.</div><div class="ttdef"><b>Definition</b> MsgFactory.h:101</div></div>
<div class="ttc" id="aclasscomms_1_1MsgFactory_html_ac18168c1dad7c06c2cee17e04e6bd611"><div class="ttname"><a href="classcomms_1_1MsgFactory.html#ac18168c1dad7c06c2cee17e04e6bd611">comms::MsgFactory::isDispatchPolymorphic</a></div><div class="ttdeci">static constexpr bool isDispatchPolymorphic()</div><div class="ttdoc">Compile time inquiry whether polymorphic dispatch tables are generated internally to map message ID t...</div><div class="ttdef"><b>Definition</b> MsgFactory.h:186</div></div>
<div class="ttc" id="aclasscomms_1_1MsgFactory_html_adfa8fb1cd206c2fd25a97bd0a4e57cd7"><div class="ttname"><a href="classcomms_1_1MsgFactory.html#adfa8fb1cd206c2fd25a97bd0a4e57cd7">comms::MsgFactory::MsgPtr</a></div><div class="ttdeci">typename Base::MsgPtr MsgPtr</div><div class="ttdoc">Smart pointer to Message which holds allocated message object.</div><div class="ttdef"><b>Definition</b> MsgFactory.h:109</div></div>
<div class="ttc" id="anamespacecomms_html"><div class="ttname"><a href="namespacecomms.html">comms</a></div><div class="ttdoc">Main namespace for all classes / functions of COMMS library.</div></div>
<div class="ttc" id="anamespacecomms_html_af61c1bae7a9edbfb7928fc2aed04c55c"><div class="ttname"><a href="namespacecomms.html#af61c1bae7a9edbfb7928fc2aed04c55c">comms::MsgFactoryCreateFailureReason</a></div><div class="ttdeci">MsgFactoryCreateFailureReason</div><div class="ttdef"><b>Definition</b> MsgFactoryCreateFailureReason.h:18</div></div>
</div><!-- fragment --></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>