Newer
Older
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.13"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>ETSI STF525 / Internal Testing test suite: /home/vagrant/TriesAndDelete/etsi_its/framework/include/layer.hh Source File</title>
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
<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 style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">ETSI STF525 / Internal Testing test suite
</div>
<div id="projectbrief">This project provides an internal testing test suite and its associated Test Adapter/Codec</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.13 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
</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">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_644e041c3a6521da7b27eba0e4eb2b95.html">framework</a></li><li class="navelem"><a class="el" href="dir_dd40116cd1cfebdc77a7c7114b29912e.html">include</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">layer.hh</div> </div>
<a href="layer_8hh.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> </div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="preprocessor">#pragma once</span></div><div class="line"><a name="l00012"></a><span class="lineno"> 12</span> </div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="preprocessor">#include <string></span></div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="preprocessor">#include <map></span></div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="preprocessor">#include <vector></span></div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="preprocessor">#include <algorithm></span></div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span> </div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="preprocessor">#include "<a class="code" href="Params_8hh.html">Params.hh</a>"</span></div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span> </div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="keyword">class </span>OCTETSTRING; </div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="keyword">class </span>BITSTRING; </div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="keyword">class </span>CHARSTRING; </div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="keyword">class </span>INTEGER; </div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span> </div><div class="line"><a name="l00029"></a><span class="lineno"><a class="line" href="classlayer.html"> 29</a></span> <span class="keyword">class </span><a class="code" href="classlayer.html">layer</a> {</div><div class="line"><a name="l00030"></a><span class="lineno"><a class="line" href="classlayer.html#a206c1a0a8f7582d5dcc2f9b7cbe08179"> 30</a></span>  std::vector<layer*> <a class="code" href="classlayer.html#a206c1a0a8f7582d5dcc2f9b7cbe08179">upperLayers</a>; </div><div class="line"><a name="l00031"></a><span class="lineno"><a class="line" href="classlayer.html#a2f265abd9961451149783ca03398f7a0"> 31</a></span>  std::vector<layer*> <a class="code" href="classlayer.html#a2f265abd9961451149783ca03398f7a0">lowerLayers</a>; </div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span> </div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span> <span class="keyword">protected</span>:</div><div class="line"><a name="l00034"></a><span class="lineno"><a class="line" href="classlayer.html#a01eb181953398803f772ad83dac8a192"> 34</a></span>  std::string <a class="code" href="classlayer.html#a01eb181953398803f772ad83dac8a192">type</a>; </div><div class="line"><a name="l00035"></a><span class="lineno"> 35</span> </div><div class="line"><a name="l00036"></a><span class="lineno"> 36</span> <span class="keyword">public</span>: </div><div class="line"><a name="l00037"></a><span class="lineno"> 37</span> </div><div class="line"><a name="l00041"></a><span class="lineno"><a class="line" href="classlayer.html#a95796de3b5f8aa07f49effa03a03f6f8"> 41</a></span>  <span class="keyword">explicit</span> <a class="code" href="classlayer.html#a95796de3b5f8aa07f49effa03a03f6f8">layer</a>() : upperLayers(), lowerLayers(), type(<a class="code" href="namespacestd.html">std</a>::string(<span class="stringliteral">""</span>)) { };</div><div class="line"><a name="l00042"></a><span class="lineno"> 42</span> </div><div class="line"><a name="l00050"></a><span class="lineno"><a class="line" href="classlayer.html#a03021f01512262d935148efc28d27d08"> 50</a></span>  <span class="keyword">explicit</span> <a class="code" href="classlayer.html#a03021f01512262d935148efc28d27d08">layer</a>(<span class="keyword">const</span> std::string& p_type) : upperLayers(), lowerLayers(), type(<a class="code" href="namespacestd.html">std</a>::string(p_type.begin(), p_type.end())) { };</div><div class="line"><a name="l00051"></a><span class="lineno"> 51</span> </div><div class="line"><a name="l00056"></a><span class="lineno"><a class="line" href="classlayer.html#ae0781f14cd91478477526183951eb052"> 56</a></span>  <span class="keyword">virtual</span> <a class="code" href="classlayer.html#ae0781f14cd91478477526183951eb052">~layer</a>() {</div><div class="line"><a name="l00057"></a><span class="lineno"> 57</span>  <span class="comment">// Double linked list, only remove layers in lowerLayers from the lowest one</span></div><div class="line"><a name="l00058"></a><span class="lineno"> 58</span>  std::for_each(lowerLayers.rbegin(), lowerLayers.rend(), [](<a class="code" href="classlayer.html">layer</a>* it) { <span class="keyword">delete</span> it; } );</div><div class="line"><a name="l00059"></a><span class="lineno"> 59</span>  lowerLayers.clear();</div><div class="line"><a name="l00060"></a><span class="lineno"> 60</span>  upperLayers.clear();</div><div class="line"><a name="l00061"></a><span class="lineno"> 61</span>  };</div><div class="line"><a name="l00062"></a><span class="lineno"> 62</span> </div><div class="line"><a name="l00068"></a><span class="lineno"><a class="line" href="classlayer.html#a5fa935a11ee64b2ffac3379ac5cfa43e"> 68</a></span>  <span class="keywordtype">void</span> <a class="code" href="classlayer.html#a5fa935a11ee64b2ffac3379ac5cfa43e">delete_layer</a>() { };</div><div class="line"><a name="l00069"></a><span class="lineno"> 69</span> </div><div class="line"><a name="l00070"></a><span class="lineno"> 70</span> <span class="keyword">public</span>: </div><div class="line"><a name="l00071"></a><span class="lineno"> 71</span> </div><div class="line"><a name="l00077"></a><span class="lineno"><a class="line" href="classlayer.html#a9967a212fe9e4a914e1e574738e31080"> 77</a></span>  <span class="keyword">inline</span> <span class="keywordtype">void</span> <a class="code" href="classlayer.html#a9967a212fe9e4a914e1e574738e31080">add_upper_layer</a>(<a class="code" href="classlayer.html">layer</a>* p_layer) {</div><div class="line"><a name="l00078"></a><span class="lineno"> 78</span>  <span class="keywordflow">if</span> (p_layer != NULL) {</div><div class="line"><a name="l00079"></a><span class="lineno"> 79</span>  upperLayers.push_back(p_layer);</div><div class="line"><a name="l00080"></a><span class="lineno"> 80</span>  p_layer-><a class="code" href="classlayer.html#a2f265abd9961451149783ca03398f7a0">lowerLayers</a>.push_back(<span class="keyword">this</span>);</div><div class="line"><a name="l00081"></a><span class="lineno"> 81</span>  };</div><div class="line"><a name="l00082"></a><span class="lineno"> 82</span>  };</div><div class="line"><a name="l00083"></a><span class="lineno"> 83</span> </div><div class="line"><a name="l00090"></a><span class="lineno"><a class="line" href="classlayer.html#a903b94ac2545e75f015e5678599877f9"> 90</a></span>  <span class="keywordtype">void</span> <a class="code" href="classlayer.html#a903b94ac2545e75f015e5678599877f9">remove_upper_layer</a>(<a class="code" href="classlayer.html">layer</a>* p_layer) { };</div><div class="line"><a name="l00091"></a><span class="lineno"> 91</span> </div><div class="line"><a name="l00101"></a><span class="lineno"><a class="line" href="classlayer.html#a25475e171c9801e38592b5e3d10722e6"> 101</a></span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classlayer.html#a25475e171c9801e38592b5e3d10722e6">send_data</a>(OCTETSTRING& p_data, <a class="code" href="classParams.html">Params</a>& p_params) { };</div><div class="line"><a name="l00102"></a><span class="lineno"> 102</span> </div><div class="line"><a name="l00112"></a><span class="lineno"><a class="line" href="classlayer.html#aa5fc5886a7b4e0593969bb0b641ccf49"> 112</a></span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classlayer.html#aa5fc5886a7b4e0593969bb0b641ccf49">receive_data</a>(OCTETSTRING& p_data, <a class="code" href="classParams.html">Params</a>& p_params) { }</div><div class="line"><a name="l00113"></a><span class="lineno"> 113</span> </div><div class="line"><a name="l00120"></a><span class="lineno"><a class="line" href="classlayer.html#a0e602d58e496b890e0c986088bd66551"> 120</a></span>  <span class="keyword">inline</span> <span class="keyword">const</span> std::string& <a class="code" href="classlayer.html#a0e602d58e496b890e0c986088bd66551">to_string</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> <a class="code" href="classlayer.html#a01eb181953398803f772ad83dac8a192">type</a>; };</div><div class="line"><a name="l00121"></a><span class="lineno"> 121</span> </div><div class="line"><a name="l00122"></a><span class="lineno"> 122</span> <span class="keyword">protected</span>: </div><div class="line"><a name="l00123"></a><span class="lineno"><a class="line" href="classlayer.html#aaa40f56e6628ead0e29f6e0dd08314fa"> 123</a></span>  <span class="keyword">inline</span> <span class="keywordtype">void</span> <a class="code" href="classlayer.html#aaa40f56e6628ead0e29f6e0dd08314fa">to_all_layers</a>(std::vector<layer*>&layers, OCTETSTRING& data, <a class="code" href="classParams.html">Params</a>& params) {</div><div class="line"><a name="l00124"></a><span class="lineno"> 124</span>  <span class="keywordflow">for</span> (std::vector<layer*>::const_iterator it = layers.cbegin(); it != layers.cend(); ++it) {</div><div class="line"><a name="l00125"></a><span class="lineno"> 125</span>  <a class="code" href="classlayer.html">layer</a>* p = *it;</div><div class="line"><a name="l00126"></a><span class="lineno"> 126</span>  p-><a class="code" href="classlayer.html#aa5fc5886a7b4e0593969bb0b641ccf49">receive_data</a>(data, params); <span class="comment">// FIXME BUG I </span></div><div class="line"><a name="l00127"></a><span class="lineno"> 127</span>  } <span class="comment">// End of 'for' statement</span></div><div class="line"><a name="l00128"></a><span class="lineno"> 128</span>  };</div><div class="line"><a name="l00129"></a><span class="lineno"> 129</span> </div><div class="line"><a name="l00130"></a><span class="lineno"><a class="line" href="classlayer.html#aafda59c8804287d1e08519892d5858a1"> 130</a></span>  <span class="keyword">inline</span> <span class="keywordtype">void</span> <a class="code" href="classlayer.html#aafda59c8804287d1e08519892d5858a1">receive_to_all_layers</a>(OCTETSTRING& data, <a class="code" href="classParams.html">Params</a>& params) {</div><div class="line"><a name="l00131"></a><span class="lineno"> 131</span>  <span class="keywordflow">for</span> (std::vector<layer*>::const_iterator it = upperLayers.cbegin(); it != upperLayers.cend(); ++it) {</div><div class="line"><a name="l00132"></a><span class="lineno"> 132</span>  <a class="code" href="classlayer.html">layer</a>* p = *it;</div><div class="line"><a name="l00133"></a><span class="lineno"> 133</span>  p-><a class="code" href="classlayer.html#aa5fc5886a7b4e0593969bb0b641ccf49">receive_data</a>(data, params);</div><div class="line"><a name="l00134"></a><span class="lineno"> 134</span>  } <span class="comment">// End of 'for' statement</span></div><div class="line"><a name="l00135"></a><span class="lineno"> 135</span>  };</div><div class="line"><a name="l00136"></a><span class="lineno"> 136</span> </div><div class="line"><a name="l00137"></a><span class="lineno"><a class="line" href="classlayer.html#ad7f025f66ff13f65f4d641edd3d45e7a"> 137</a></span>  <span class="keyword">inline</span> <span class="keywordtype">void</span> <a class="code" href="classlayer.html#ad7f025f66ff13f65f4d641edd3d45e7a">send_to_all_layers</a>(OCTETSTRING& data, <a class="code" href="classParams.html">Params</a>& params) {</div><div class="line"><a name="l00138"></a><span class="lineno"> 138</span>  <span class="keywordflow">for</span> (std::vector<layer*>::const_iterator it = lowerLayers.cbegin(); it != lowerLayers.cend(); ++it) {</div><div class="line"><a name="l00139"></a><span class="lineno"> 139</span>  <a class="code" href="classlayer.html">layer</a>* p = *it;</div><div class="line"><a name="l00140"></a><span class="lineno"> 140</span>  p-><a class="code" href="classlayer.html#a25475e171c9801e38592b5e3d10722e6">send_data</a>(data, params);</div><div class="line"><a name="l00141"></a><span class="lineno"> 141</span>  } <span class="comment">// End of 'for' statement</span></div><div class="line"><a name="l00142"></a><span class="lineno"> 142</span>  };</div><div class="line"><a name="l00143"></a><span class="lineno"> 143</span> }; <span class="comment">// End of class layer</span></div><div class="line"><a name="l00144"></a><span class="lineno"> 144</span> </div><div class="ttc" id="classlayer_html_a25475e171c9801e38592b5e3d10722e6"><div class="ttname"><a href="classlayer.html#a25475e171c9801e38592b5e3d10722e6">layer::send_data</a></div><div class="ttdeci">virtual void send_data(OCTETSTRING &p_data, Params &p_params)</div><div class="ttdoc">Send bytes formated data to the lower layers. </div><div class="ttdef"><b>Definition:</b> layer.hh:101</div></div>
<div class="ttc" id="classlayer_html_a2f265abd9961451149783ca03398f7a0"><div class="ttname"><a href="classlayer.html#a2f265abd9961451149783ca03398f7a0">layer::lowerLayers</a></div><div class="ttdeci">std::vector< layer * > lowerLayers</div><div class="ttdoc">List of the upper protocol layers. </div><div class="ttdef"><b>Definition:</b> layer.hh:31</div></div>
<div class="ttc" id="classlayer_html_a03021f01512262d935148efc28d27d08"><div class="ttname"><a href="classlayer.html#a03021f01512262d935148efc28d27d08">layer::layer</a></div><div class="ttdeci">layer(const std::string &p_type)</div><div class="ttdoc">Specialized constructor Create a new instance of the layer class with its type description. </div><div class="ttdef"><b>Definition:</b> layer.hh:50</div></div>
<div class="ttc" id="classlayer_html"><div class="ttname"><a href="classlayer.html">layer</a></div><div class="ttdoc">Forward declaration of TITAN class. </div><div class="ttdef"><b>Definition:</b> layer.hh:29</div></div>
<div class="ttc" id="namespacestd_html"><div class="ttname"><a href="namespacestd.html">std</a></div></div>
<div class="ttc" id="classlayer_html_aa5fc5886a7b4e0593969bb0b641ccf49"><div class="ttname"><a href="classlayer.html#aa5fc5886a7b4e0593969bb0b641ccf49">layer::receive_data</a></div><div class="ttdeci">virtual void receive_data(OCTETSTRING &p_data, Params &p_params)</div><div class="ttdoc">Receive bytes formated data from the lower layers. </div><div class="ttdef"><b>Definition:</b> layer.hh:112</div></div>
<div class="ttc" id="classlayer_html_aafda59c8804287d1e08519892d5858a1"><div class="ttname"><a href="classlayer.html#aafda59c8804287d1e08519892d5858a1">layer::receive_to_all_layers</a></div><div class="ttdeci">void receive_to_all_layers(OCTETSTRING &data, Params &params)</div><div class="ttdef"><b>Definition:</b> layer.hh:130</div></div>
<div class="ttc" id="classlayer_html_a95796de3b5f8aa07f49effa03a03f6f8"><div class="ttname"><a href="classlayer.html#a95796de3b5f8aa07f49effa03a03f6f8">layer::layer</a></div><div class="ttdeci">layer()</div><div class="ttdoc">Type description, it indicates the protocol type (e.g. CAM, DENM, GN, ETH, PCAP...) </div><div class="ttdef"><b>Definition:</b> layer.hh:41</div></div>
<div class="ttc" id="classlayer_html_aaa40f56e6628ead0e29f6e0dd08314fa"><div class="ttname"><a href="classlayer.html#aaa40f56e6628ead0e29f6e0dd08314fa">layer::to_all_layers</a></div><div class="ttdeci">void to_all_layers(std::vector< layer *> &layers, OCTETSTRING &data, Params &params)</div><div class="ttdef"><b>Definition:</b> layer.hh:123</div></div>
<div class="ttc" id="Params_8hh_html"><div class="ttname"><a href="Params_8hh.html">Params.hh</a></div><div class="ttdoc">Header file for the parameter dictionary. </div></div>
<div class="ttc" id="classlayer_html_a01eb181953398803f772ad83dac8a192"><div class="ttname"><a href="classlayer.html#a01eb181953398803f772ad83dac8a192">layer::type</a></div><div class="ttdeci">std::string type</div><div class="ttdoc">List of the lower protocol layers. </div><div class="ttdef"><b>Definition:</b> layer.hh:34</div></div>
<div class="ttc" id="classParams_html"><div class="ttname"><a href="classParams.html">Params</a></div><div class="ttdoc">This class provides basic functionalities for an ITS dictionary. </div><div class="ttdef"><b>Definition:</b> Params.hh:21</div></div>
<div class="ttc" id="classlayer_html_a206c1a0a8f7582d5dcc2f9b7cbe08179"><div class="ttname"><a href="classlayer.html#a206c1a0a8f7582d5dcc2f9b7cbe08179">layer::upperLayers</a></div><div class="ttdeci">std::vector< layer * > upperLayers</div><div class="ttdef"><b>Definition:</b> layer.hh:30</div></div>
<div class="ttc" id="classlayer_html_a0e602d58e496b890e0c986088bd66551"><div class="ttname"><a href="classlayer.html#a0e602d58e496b890e0c986088bd66551">layer::to_string</a></div><div class="ttdeci">const std::string & to_string() const</div><div class="ttdoc">Remove the specified upper layer protocol from the list of the upper layer. </div><div class="ttdef"><b>Definition:</b> layer.hh:120</div></div>
<div class="ttc" id="classlayer_html_ad7f025f66ff13f65f4d641edd3d45e7a"><div class="ttname"><a href="classlayer.html#ad7f025f66ff13f65f4d641edd3d45e7a">layer::send_to_all_layers</a></div><div class="ttdeci">void send_to_all_layers(OCTETSTRING &data, Params &params)</div><div class="ttdef"><b>Definition:</b> layer.hh:137</div></div>
<div class="ttc" id="classlayer_html_a5fa935a11ee64b2ffac3379ac5cfa43e"><div class="ttname"><a href="classlayer.html#a5fa935a11ee64b2ffac3379ac5cfa43e">layer::delete_layer</a></div><div class="ttdeci">void delete_layer()</div><div class="ttdoc">Delete this layer. </div><div class="ttdef"><b>Definition:</b> layer.hh:68</div></div>
<div class="ttc" id="classlayer_html_a9967a212fe9e4a914e1e574738e31080"><div class="ttname"><a href="classlayer.html#a9967a212fe9e4a914e1e574738e31080">layer::add_upper_layer</a></div><div class="ttdeci">void add_upper_layer(layer *p_layer)</div><div class="ttdoc">Add a new layer in the list of the upper layer. </div><div class="ttdef"><b>Definition:</b> layer.hh:77</div></div>
<div class="ttc" id="classlayer_html_ae0781f14cd91478477526183951eb052"><div class="ttname"><a href="classlayer.html#ae0781f14cd91478477526183951eb052">layer::~layer</a></div><div class="ttdeci">virtual ~layer()</div><div class="ttdoc">Default destructor. </div><div class="ttdef"><b>Definition:</b> layer.hh:56</div></div>
<div class="ttc" id="classlayer_html_a903b94ac2545e75f015e5678599877f9"><div class="ttname"><a href="classlayer.html#a903b94ac2545e75f015e5678599877f9">layer::remove_upper_layer</a></div><div class="ttdeci">void remove_upper_layer(layer *p_layer)</div><div class="ttdoc">Remove the specified upper layer protocol from the list of the upper layer. </div><div class="ttdef"><b>Definition:</b> layer.hh:90</div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Wed Apr 4 2018 14:16:23 for ETSI STF525 / Internal Testing test suite by  <a href="http://www.doxygen.org/index.html">